Our tutorial documentation is too bulky: https://pypsa-earth.readthedocs.io/en/latest/tutorial.html
Snakemake offers e.g. two tutorials. One that can be run in 10-20min another one that is extended and can take hours.
In ours are too many explanations... making it difficult for new users to "taste" the model. Let's redesign our tutorial.
PyPSA-Eur does it great here with only three little sections:
Execute the tutorial config
Modify the workflow
Analyse the results
Suggestions
Let's create a 1:1 equivalent to PyPSA-Eur. (our current tutorial e.g. includes the cp config.default.yaml config.yaml --- This will lead bad user experience, use config.tutorial instead in all tutorials!)
Our tutorial documentation is too bulky: https://pypsa-earth.readthedocs.io/en/latest/tutorial.html Snakemake offers e.g. two tutorials. One that can be run in 10-20min another one that is extended and can take hours. In ours are too many explanations... making it difficult for new users to "taste" the model. Let's redesign our tutorial.
PyPSA-Eur does it great here with only three little sections:
Suggestions
cp config.default.yaml config.yaml
--- This will lead bad user experience, use config.tutorial instead in all tutorials!)tutorial.rst
tolearning_material.rst
. There should be also the Developer videos https://pypsa-earth.readthedocs.io/en/latest/tutorial.html#youtube-devtutorials