rl-institut / oemof-B3

An open-source energy system model for Brandenburg/Berlin.
https://oemof-b3.readthedocs.io/
GNU Affero General Public License v3.0
9 stars 5 forks source link

Include description of results in description of model pipeline #270

Closed jnnr closed 1 year ago

jnnr commented 2 years ago

Model pipeline (explaining the rules) and model structure follow the same logic. This is a proposal to integrate them. The different sections structure the snakemake rules by different categories (prepare_resources, build_datapackage etc.). Each of the categories have similar output (resources format, preprocessed datapackages, plots). The general structure of that output is explained in the text copied from model_structure. More detailled info on the rules can be obtained by clicking on a specific rule.

readthedocs-build

Please let me know what you think!

TODOs:

MaGering commented 2 years ago

Thank you @jnnr for the restructuring. I think your changes simplify the orientation in the docs.

This means that "Model pipeline" and "Model structure" will be merged into one chapter which is not yet implemented in this draft, right?

jnnr commented 2 years ago

Thank you @jnnr for the restructuring. I think your changes simplify the orientation in the docs. This means that "Model pipeline" and "Model structure" will be merged into one chapter which is not yet implemented in this draft, right?

Thanks for your feedback! Yes, they will be merged. I will delete "Model structure"

jnnr commented 2 years ago

Raw data does not fit the logic of the sections, which are ordered by rule type. Proposal: Change the sections like this

MaGering commented 2 years ago

Raw data does not fit the logic of the sections, which are ordered by rule type. Proposal: Change the sections like this

* Raw data

* Resources

  * rules `prepare_`

* Preprocessed Datapackages

  * rule `build_datapackage`

* Optimized Energysystems

  * rule `optimize`

* Postprocessed Datapackages

  * rule `postprocessed`

* Plots

  * ruled `plot_`

I think that's good. (With only one addition: Instead of "Plots" to write "Visualization", because there also the table scripts are included - this will come automatically with the merge of dev).