[meta] Improve documentation

calliope-project / calliope

A multi-scale energy systems modelling framework

https://www.callio.pe

Apache License 2.0

286 stars 93 forks source link

[meta] Improve documentation #358

Closed brynpickering closed 4 months ago

brynpickering commented 3 years ago

This meta issue is linked to a number of sub-issues that need to be solved to improve users' understanding of how to build, run, and analyse a Calliope model. This includes more examples of its use as well as better descriptions of inputs and outputs.

[x] Examples of technology definitions (#94)
[ ] Better document example models (#325)
[x] Document automatic internal magic (distance derivations, depreciation cost calculations, LCOE and capacity factor postprocessing results) (#209)
[ ] Tutorials for advanced functionality (#95)
[x] Add spell checking (#88)
[ ] Limits of operational mode (#350)

brynpickering commented 2 years ago

Main aim of documentation should be to showcase how we provide the basic building blocks to define an energy system model (nodes; techs inc. supply, conversion, ...; links) and how one can easily put those blocks together into a model. Doing more (custom constraints, plotting, timeseries aggregation, ...) is then another section about how users can take their modelling further when they understand the building blocks.

brynpickering commented 4 months ago

Closing as a stale meta issue. Opening a new issue to focus on better documenting operate mode (a new notebook tutorial)