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

Parameter documentation hard to find #446

Open
jnnr opened this issue Apr 17, 2023 · 0 comments
Open

Parameter documentation hard to find #446

jnnr opened this issue Apr 17, 2023 · 0 comments
Labels
v0.6 Version 0.6

Comments

@jnnr
Copy link
Contributor

jnnr commented Apr 17, 2023

Other than variables, which will be documented in the math yaml-files (and can then be rendered in the docs), parameters are nowhere defined or described.

What can be done about it? The most consistent approach that comes to mind is to define parameters in the math yaml-files, too. Doing this would complete the mathematical representation of the problem, all in one place: parameters, variables, constraints and objective.

This might be a lot of work. On the other hand, defining all parameters could have other benefits, e.g. protect against typos.

Update: Actually, parameters are documented in defaults (https://calliope.readthedocs.io/en/stable/user/config_defaults.html#per-tech-constraints and https://calliope.readthedocs.io/en/stable/user/config_defaults.html#per-tech-costs). Can make it easier to find by linking it more prominently in the docs chapter on mathematical formulation (https://calliope.readthedocs.io/en/stable/user/ref_formulation.html#)

@jnnr jnnr changed the title Parameters are not documented Parameter documentation hard to find Apr 18, 2023
@jnnr jnnr linked a pull request Apr 21, 2023 that will close this issue
4 tasks
@jnnr jnnr removed a link to a pull request Apr 21, 2023
4 tasks
@brynpickering brynpickering added the v0.6 Version 0.6 label Jan 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
v0.6 Version 0.6
Projects
None yet
Development

No branches or pull requests

2 participants