Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation to configuration files #51

Open
3 tasks
daniel-rdt opened this issue Jan 17, 2025 · 2 comments
Open
3 tasks

Add documentation to configuration files #51

daniel-rdt opened this issue Jan 17, 2025 · 2 comments
Assignees

Comments

@daniel-rdt
Copy link
Collaborator

Comprehensive documentation is needed for the essential configuration files in order to ease the use of the automated workflow.

  • config.form.yaml
  • scenario.form.yaml
  • config.kpi.yaml
@virio-andreyana
Copy link

@daniel-rdt How do you want the documentation to be written like? Should it be a pdf, updating pypsa-eur website, or simply a hash # note?

@daniel-rdt
Copy link
Collaborator Author

daniel-rdt commented Jan 17, 2025

@daniel-rdt How do you want the documentation to be written like? Should it be a pdf, updating pypsa-eur website, or simply a hash # note?

I was thinking of a very descriptive hash note in the configuration files themselves and then we also add comprehensive documentation or like manual in the Readme of the form-energy-storage repo.

This way, they should know very well what they need to change and what they need to do when they want to execute and adapt running the model.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants