Feedback course 03: Download - Find and download / interact with data

[han-f]

Please review course 03: https://openenergyplatform.github.io/academy/courses/03_download/
and provide your feedback below as comments. Feedback can include pointing out errors (such as broken links, things that do not work as described) any suggestions for improvements, things that you are expecting from such a course but find they are missing etc.

Please make sure to reference the link to the material that you refer to in your comment (the courses link to various materials)

[TilmanKie]

1. I think I can understand what I have to do, to use the REST-full-HTTP API in Python. But it's complicated and much and unfortunately I can't install python. I do not have the necessary rights on my laptop, so I can't try it by myself.
2. Perhaps it would be help to give one or two more information in the "course 03" at "How can I download data" about what you need to do if you want to use the REST-full-HTTP API in Python. For example that it is necessary to install Python and the Jupyther Notebook. When I read the "course 03" the first time I thought it would be easy and then I had to follow more then three links. That was unexpected and complicated for me. The information could help you to know what to expect. The detailed information can be linked of course.
3. Also at "How can I interact with data" I would appreciate some more information what information the tutorial provides. There is the same description as in "How can I download data".
4. I think the courses are very clear and well structured!

[TilmanKie]

@wingechr

[TilmanKie]

I had no previous knowledge of python, so I had some problems to understand where I can use the code. I tryed "cmd.exe", "spider" and "Jupyte Notebook", only then I understood. I think it took a lot of time.
Some errors:

1. "Process query result data and save to file (tutorial)":
   Code at setup token did not work
   And the last code at "Create a .xlsx file with...." did not work (ModuleNotFoundError: No module named 'xlsxwriter')
2. "Data queries via API (tutorial)":
   "Select data from a table" -> response 404

At "how can I download data" and "How can I interact with data" there is two times the same link. Is this right?

But in general I understood python and the OEP well :D

[han-f]

Thanks @TilmanKie for the feedback and going through figuring out how to use python - I have created two separate issues for the tutorials: #175 and #176, so the authors can take it from there.

The tutorial that is linked twice not only shows how to download data, but also some interaction. So for now I think it is ok that it is linked twice.

[flohrreija-oeko]

With the new update (16.07) of the linked tutorials this course is much clearer! @han-f

Overall, it was difficult for me as well to get started with Python to be able to follow the tutorials where programming knowledge is needed. I think the course would benefit from

1. a link to a new tutorial for e.g. "Getting started with Python/Jupyter Notebooks" with short introduction or link to Python usage (e.g. https://wiki.python.org/moin/BeginnersGuide) and short info on how to install the needed packages
2. alternatively link to the tutorial "GUIDEBOOK - How to publish your Data on the OEP" (https://openenergyplatform.github.io/academy/tutorials/99_other/OEP_Research_Data_Publishing_Guidebook/) that has a some introduction links for this in the first part of the tutorial

In general, the course is well split between material for which no programming skills are needed and material based on code, but sometimes the gap between both levels is a bit big - a bit of help to set up Python would be great for people with little to no programming skills (and no installed python software) who want to give a try to the programming material.

[flohrreija-oeko]

This is Feedback for API Tutorial 01 (as i didn't find a separate issue for feedback on it):

In general the code worked following the steps, sometimes a bit more clarity (e.g. information on what the used functions do in the) using more detailed (#)comments in the code or additional links would be helpfull.

1. At first the code did not work due to internal firewall restriction of our network (it worked well when connected through WLAN) - a hint on this possibility would have saved me quite some time of error finding.
2. In general I suggest adding a few more links for completeness & easier understanding for non experienced programmers, e.g.:

• e.g. link the same link as before for json serializable data
• e.g. overall introduction to the request package (where one can find further information e.g. the main function req.get() explained to understand the code)
• e.g. where filters and introduction to HTTP query string parameters

[han-f]

Many thanks @flohrreija-oeko. @wingechr could you please check on the latest comment on API Tutorial 01? For feedback targeted at that specific tutorial, I created a new issue and copied @flohrreija-oeko comment over: #233