OpenEnergyPlatform / OpenEnergyPlatform/omi
Document and reuse existing methods to (auto-)generate OEMetadata
Open
Nobody has claimed this yet.
other: help wanted :raising_hand:
priority: low :sloth:
status: blocked :stop_sign:
type: enhancement :gear:
type: question :question:
- Dominant language
- Python
- Stars
- 8
- Forks
- 8
- PR merge metrics
- No merged PRs in 30d
Description
Other projects already developed functions to generate parts of the OEMetadata string.
eGoN-data:
https://github.com/openego/eGon-data/blob/dev/src/egon/data/metadata.py
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 reading eGon-data's src/egon/data/metadata.py, which the issue identifies as an existing source of OEMetadata-generation functions. Then locate the corresponding metadata code and entry point in OMI; done should include documenting the reusable methods and agreeing on how OEMetadata generation is invoked, since no OMI file or test is named.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation, tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100