From e072b98399567b523b17dccbf0a9b39d53fbcfb9 Mon Sep 17 00:00:00 2001 From: jnnr <32454596+jnnr@users.noreply.github.com> Date: Tue, 14 Oct 2025 11:32:17 +0200 Subject: [PATCH 01/10] Rename docs chapter --- .../images/bloat-growth-problem.png | Bin .../images/toolset_simple.drawio.png | Bin docs/{About => Background}/motivation.md | 0 docs/{About => Background}/our_framework.md | 0 4 files changed, 0 insertions(+), 0 deletions(-) rename docs/{About => Background}/images/bloat-growth-problem.png (100%) rename docs/{About => Background}/images/toolset_simple.drawio.png (100%) rename docs/{About => Background}/motivation.md (100%) rename docs/{About => Background}/our_framework.md (100%) 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 From 1cf3e6cd68e3563c722061ac3f0c51d1a70353bf Mon Sep 17 00:00:00 2001 From: jnnr <32454596+jnnr@users.noreply.github.com> Date: Tue, 14 Oct 2025 11:54:48 +0200 Subject: [PATCH 02/10] Rename chapter to developer guidelines --- docs/{Guidelines => Developer_guidelines}/getting_started.md | 0 docs/{Guidelines => Developer_guidelines}/requirements.md | 0 docs/{Guidelines => Developer_guidelines}/templates.md | 0 docs/index.md | 2 +- 4 files changed, 1 insertion(+), 1 deletion(-) rename docs/{Guidelines => Developer_guidelines}/getting_started.md (100%) rename docs/{Guidelines => Developer_guidelines}/requirements.md (100%) rename docs/{Guidelines => Developer_guidelines}/templates.md (100%) diff --git a/docs/Guidelines/getting_started.md b/docs/Developer_guidelines/getting_started.md similarity index 100% rename from docs/Guidelines/getting_started.md rename to docs/Developer_guidelines/getting_started.md 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/index.md b/docs/index.md index 55ec08b..feab7b0 100644 --- a/docs/index.md +++ b/docs/index.md @@ -11,4 +11,4 @@ In essence, we wish to turn very complex models that are hard to maintain and re ## For developers -Please check out our [development guide](./Guidelines/getting_started.md). +Please check out our [developer guidelines](./Developer_guidelines/getting_started.md). From a56cb21774ed8922628f6cbcc9b4247b5d1e3995 Mon Sep 17 00:00:00 2001 From: jnnr <32454596+jnnr@users.noreply.github.com> Date: Tue, 14 Oct 2025 15:25:05 +0200 Subject: [PATCH 03/10] Add list of modules --- docs/Modules/modules.md | 13 +++++++++++++ docs/index.md | 4 +++- 2 files changed, 16 insertions(+), 1 deletion(-) create mode 100644 docs/Modules/modules.md diff --git a/docs/Modules/modules.md b/docs/Modules/modules.md new file mode 100644 index 0000000..47e522e --- /dev/null +++ b/docs/Modules/modules.md @@ -0,0 +1,13 @@ +# Modules + +Currently, the data the following data modules are available. + +- [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. \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index feab7b0..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 [developer guidelines](./Developer_guidelines/getting_started.md). +If you want to start creating your own data modules, check out our [developer guidelines](./Developer_guidelines/getting_started.md). From 72fce0c2a75c395d0747f5a2849ebd031ce0c083 Mon Sep 17 00:00:00 2001 From: jnnr <32454596+jnnr@users.noreply.github.com> Date: Tue, 14 Oct 2025 15:25:18 +0200 Subject: [PATCH 04/10] Define navbar order --- mkdocs.yaml | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/mkdocs.yaml b/mkdocs.yaml index 9ed20bc..d29a07d 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_modules.md + copyright: Copyright © since 2025 clio contributors (MIT licensed) From 2d125a52e957d6466ae76f3c9163aa05df822ad6 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Tue, 14 Oct 2025 13:36:30 +0000 Subject: [PATCH 05/10] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- docs/Modules/modules.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/Modules/modules.md b/docs/Modules/modules.md index 47e522e..73088b4 100644 --- a/docs/Modules/modules.md +++ b/docs/Modules/modules.md @@ -10,4 +10,4 @@ Currently, the data the following data modules are available. - [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. \ No newline at end of file +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. From 135ae6a911ab6c7adb29a5bb4a8aeb44bc13652a Mon Sep 17 00:00:00 2001 From: jnnr <32454596+jnnr@users.noreply.github.com> Date: Tue, 14 Oct 2025 17:13:09 +0200 Subject: [PATCH 06/10] Fix misspelling of file --- mkdocs.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mkdocs.yaml b/mkdocs.yaml index d29a07d..81ee795 100644 --- a/mkdocs.yaml +++ b/mkdocs.yaml @@ -105,6 +105,6 @@ nav: - Developer_guidelines/templates.md - API clio_tools: - clio_tools_API/index.md - - clio_tools_API/data_modules.md + - clio_tools_API/data_module.md copyright: Copyright © since 2025 clio contributors (MIT licensed) From df8a506f9545c8fb6b7fa82ed7ca98632a475f83 Mon Sep 17 00:00:00 2001 From: jnnr <32454596+jnnr@users.noreply.github.com> Date: Tue, 14 Oct 2025 17:20:37 +0200 Subject: [PATCH 07/10] Fix broken links --- docs/Developer_guidelines/getting_started.md | 2 +- docs/clio_tools_API/index.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/Developer_guidelines/getting_started.md b/docs/Developer_guidelines/getting_started.md index 897979b..fc6b241 100644 --- a/docs/Developer_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/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. From 0d8f3c141e87e3ae88eac92a8ab4152a23a530a7 Mon Sep 17 00:00:00 2001 From: jnnr <32454596+jnnr@users.noreply.github.com> Date: Tue, 14 Oct 2025 17:28:01 +0200 Subject: [PATCH 08/10] Add note on module docs coming soon --- docs/Modules/modules.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/Modules/modules.md b/docs/Modules/modules.md index 73088b4..aa58ea9 100644 --- a/docs/Modules/modules.md +++ b/docs/Modules/modules.md @@ -2,6 +2,10 @@ Currently, the data the following data modules are available. +!!! note "More extensive docs are coming soon" + + The modules are currently in active development. A more detailled 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) From 534b9db2ecc658296abbdf669a4215c0c08fbb92 Mon Sep 17 00:00:00 2001 From: jnnr <32454596+jnnr@users.noreply.github.com> Date: Tue, 14 Oct 2025 17:30:01 +0200 Subject: [PATCH 09/10] Fix typo --- docs/Modules/modules.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/Modules/modules.md b/docs/Modules/modules.md index aa58ea9..eb8c578 100644 --- a/docs/Modules/modules.md +++ b/docs/Modules/modules.md @@ -4,7 +4,7 @@ Currently, the data the following data modules are available. !!! note "More extensive docs are coming soon" - The modules are currently in active development. A more detailled documentation showing the capability of each module will be 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) From 4c85d74d4cdade2eed9b1945f7a21dcf86ded828 Mon Sep 17 00:00:00 2001 From: jnnr <32454596+jnnr@users.noreply.github.com> Date: Tue, 14 Oct 2025 17:33:25 +0200 Subject: [PATCH 10/10] Fix another typo --- docs/Modules/modules.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/Modules/modules.md b/docs/Modules/modules.md index eb8c578..e1e8c09 100644 --- a/docs/Modules/modules.md +++ b/docs/Modules/modules.md @@ -1,6 +1,6 @@ # Modules -Currently, the data the following data modules are available. +Currently, the following data modules are available. !!! note "More extensive docs are coming soon"