Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
File renamed without changes.
17 changes: 17 additions & 0 deletions docs/Modules/modules.md
Original file line number Diff line number Diff line change
@@ -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.
2 changes: 1 addition & 1 deletion docs/clio_tools_API/index.md
Original file line number Diff line number Diff line change
@@ -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.
4 changes: 3 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
14 changes: 14 additions & 0 deletions mkdocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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

Comment thread
irm-codebase marked this conversation as resolved.
copyright: Copyright &copy; since 2025 <a href="https://github.com/calliope-project/clio/blob/main/AUTHORS">clio contributors</a> (MIT licensed)