diff --git a/docs/About/images/bloat-growth-problem.png b/docs/Background/images/bloat-growth-problem.png similarity index 100% rename from docs/About/images/bloat-growth-problem.png rename to docs/Background/images/bloat-growth-problem.png diff --git a/docs/About/images/toolset_simple.drawio.png b/docs/Background/images/toolset_simple.drawio.png similarity index 100% rename from docs/About/images/toolset_simple.drawio.png rename to docs/Background/images/toolset_simple.drawio.png diff --git a/docs/About/motivation.md b/docs/Background/motivation.md similarity index 100% rename from docs/About/motivation.md rename to docs/Background/motivation.md diff --git a/docs/About/our_framework.md b/docs/Background/our_framework.md similarity index 100% rename from docs/About/our_framework.md rename to docs/Background/our_framework.md diff --git a/docs/Guidelines/getting_started.md b/docs/Developer_guidelines/getting_started.md similarity index 89% rename from docs/Guidelines/getting_started.md rename to docs/Developer_guidelines/getting_started.md index 897979b..fc6b241 100644 --- a/docs/Guidelines/getting_started.md +++ b/docs/Developer_guidelines/getting_started.md @@ -1,6 +1,6 @@ # How to get started -Make sure to read about [our framework](../About/our_framework.md) to familiarise yourself with each type of component +Make sure to read about [our framework](../Background/our_framework.md) to familiarise yourself with each type of component and decide the type of project that best fits your goals. We assume you already have `conda` or `mamba` installed in your system. diff --git a/docs/Guidelines/requirements.md b/docs/Developer_guidelines/requirements.md similarity index 100% rename from docs/Guidelines/requirements.md rename to docs/Developer_guidelines/requirements.md diff --git a/docs/Guidelines/templates.md b/docs/Developer_guidelines/templates.md similarity index 100% rename from docs/Guidelines/templates.md rename to docs/Developer_guidelines/templates.md diff --git a/docs/Modules/modules.md b/docs/Modules/modules.md new file mode 100644 index 0000000..e1e8c09 --- /dev/null +++ b/docs/Modules/modules.md @@ -0,0 +1,17 @@ +# Modules + +Currently, the following data modules are available. + +!!! note "More extensive docs are coming soon" + + The modules are currently in active development. A more detailed documentation showing the capability of each module will be coming soon. + +- [module_area_potentials](https://github.com/calliope-project/module_area_potentials) +- [module_demand_electricity](https://github.com/calliope-project/module_demand_electricity) +- [module_electricity_grid](https://github.com/calliope-project/module_electricity_grid) +- [module_geoboundaries](https://github.com/calliope-project/module_geo_boundaries) +- [module_hydropower](https://github.com/calliope-project/module_hydropower) +- [module_powerplants](https://github.com/calliope-project/module_powerplants) +- [module_pv_wind](https://github.com/calliope-project/module_pv_wind) + +If you think that an important topic is not covered by the modules above, feel free to develop your own module! Please read the [developer guidelines](../Developer_guidelines/getting_started.md) to learn how to get started. Our templates and recommended good practices are ready to help you, so your module will work smoothly from the start. diff --git a/docs/clio_tools_API/index.md b/docs/clio_tools_API/index.md index 71476c8..14392f1 100644 --- a/docs/clio_tools_API/index.md +++ b/docs/clio_tools_API/index.md @@ -1,3 +1,3 @@ # `clio_tools` API -Here you can find a collection of useful functions that make integrating our different [components](../About/our_framework.md) easier. +Here you can find a collection of useful functions that make integrating our different [components](../Background/our_framework.md) easier. diff --git a/docs/index.md b/docs/index.md index 55ec08b..6a07768 100644 --- a/docs/index.md +++ b/docs/index.md @@ -9,6 +9,8 @@ In essence, we wish to turn very complex models that are hard to maintain and re ![modules](./images/modular.png) +Learn about the full list of available [modules](./Modules/modules.md). + ## For developers -Please check out our [development guide](./Guidelines/getting_started.md). +If you want to start creating your own data modules, check out our [developer guidelines](./Developer_guidelines/getting_started.md). diff --git a/mkdocs.yaml b/mkdocs.yaml index 9ed20bc..81ee795 100644 --- a/mkdocs.yaml +++ b/mkdocs.yaml @@ -93,4 +93,18 @@ plugins: - https://pandas.pydata.org/docs/objects.inv - https://docs.xarray.dev/en/stable/objects.inv +nav: + - Home: index.md + - Background: + - Background/motivation.md + - Background/our_framework.md + - Modules: Modules/modules.md + - Developer guidelines: + - Developer_guidelines/getting_started.md + - Developer_guidelines/requirements.md + - Developer_guidelines/templates.md + - API clio_tools: + - clio_tools_API/index.md + - clio_tools_API/data_module.md + copyright: Copyright © since 2025 clio contributors (MIT licensed)