OpenEnergyPlatform / OpenEnergyPlatform/academy
Unclear waht to do if download fails with OEP Client
Nobody has claimed this yet.
- Dominant language
- Jupyter Notebook
- Stars
- 20
- Forks
- 9
- PR merge metrics
- No merged PRs in 30d
Description
Description of the issue
In the Tutorial for the download with the OEP Client https://openenergyplatform.github.io/academy/tutorials/02_oep_client/01_client_python_download/ it is assumed that the download will work without specifying the schema where the table is saved under in the OEP. But there is no comment for if that doesn't work and a schema needs to be given to the cli.select_from_table() function.
Ideas of solution
Add a trouble shooting comment in the tutorial
Workflow checklist
- I am aware of the workflow in CONTRIBUTING.md
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the download tutorial at tutorials/02_oep_client/01_client_python_download/ and inspect the cli.select_from_table() example. Confirm how the download behaves when a schema is required, then add a troubleshooting note showing when to provide the schema. Done means the tutorial explains this failure case clearly without changing the main example.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 58/100