Allowing default values for missing required parameters - Githubissues

rl-institut / multi-vector-simulator

Multi-vector Simulation Tool assessing and optimizing Local Energy Systems (LES) for the E-LAND project

GNU General Public License v2.0

21 stars 10 forks source link

Allowing default values for missing required parameters #956

Closed Bachibouzouk closed 1 year ago

Bachibouzouk commented 1 year ago

Related to https://github.com/open-plan-tool/gui/issues/38

Changes proposed in this pull request:

PARAMETER_DOC in utils can be used to get information about a parameter directly from the csv file docs/MVS_parameters_list.csv
When a required parameter is missing its default value, defined in docs/MVS_parameters_list.csv, is used instead of raising an error

The following steps were realized, as well (if applies):

[x] Use in-line comments to explain your code
[x] Write docstrings to your code (example docstring)
[ ] For new functionalities: Explain in readthedocs
[ ] Write test(s) for your new patch of code (pytests, assertion debug messages)
[x] Update the CHANGELOG.md
[x] Apply black (black . --exclude docs/)
[x] Check if benchmark tests pass locally (EXECUTE_TESTS_ON=master pytest)