search

OpenEnergyPlatform / academy

The Open Energy Academy is a collection of courses, tutorials, and questions for the Open Energy Family
https://openenergyplatform.github.io/academy/
GNU Affero General Public License v3.0
17 stars 7 forks source link

Feedback on: OEP Client Tutorial 03 - Download data from the Open Energy Platform using the OEP Client in the command line #237

Open han-f opened 1 month ago

han-f commented 1 month ago

Please provide feedback on the tutorial https://openenergyplatform.github.io/academy/tutorials/02_oep_client/03_client_cli_download/ in comments below. Feedback can include pointing out errors (such as broken links, things that do not work as described) any suggestions for improvements, things that you expected but missed, etc.

flohrreija-oeko commented 1 month ago

I would include some little additional information in the course for making it accessible to people who have little to no experience with the cmd-line. I suggest:

  1. for clarity, include an introductory sentence pointing at that this tutorial is needed only as an alternative to using python script and API
  2. link a basic introduction to using the cmd-line
  3. I would specify in the requirements that to install the oepclient package one has to
    • i) have python installed separately
    • ii) type in pip install oep-client>=0.17 in the cmd (I ran into error codes because I was using anaconda navigator before)
  4. there is no feedback link to this issue in the about section or first line
han-f commented 1 month ago

I will add the links to the feedback issues to all API an client tutorials today.