OpenEnergyPlatform / OpenEnergyPlatform/academy
Tutorials explaining the use of oedialect are not visible on the academy page
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
The oedialect repository links to outdated tutorials (dead links). There is no oedialect tutorial available on the Academy's website.
In general, there are many complaints about the non-transparent upload process with programmatic solutions such as oedialect or the oeplatform http-api.
Ideas of solution
-
ShortTerm: Show the oedialect tutorial on the academy website
-
LongTerm: Bundle all upload functions in a single tool (like oep-client). Provide a clean interface to create a table manually or from metadata definition. The same should be available for a csv/json based data upload that also explains how the data can be chunked for a more efficient upload and also explains the limitations in terms of upload speed and data size.
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 by reviewing the outdated tutorial links in the oedialect repository, the Academy website, and CONTRIBUTING.md. Determine which current oedialect tutorial should be published and how Academy content is exposed. Done means the tutorial is visible on the Academy website and the dead links are replaced or removed.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- jupyter-notebook
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100