Skip to content

Commit

Permalink
Added documentation on branches (#31)
Browse files Browse the repository at this point in the history
* Added documentation on branches

* Updated the requirements in the readme for creating documentation

* Made oneliner explanations in overview section

* Made a link for the documentation in the README
  • Loading branch information
Mathias157 authored Oct 14, 2024
1 parent 11776a8 commit 336812b
Show file tree
Hide file tree
Showing 6 changed files with 39 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
# Balmorel

The Balmorel energy system model. Data is included in the [Balmorel_data repository](https://github.com/balmorelcommunity/Balmorel_data), which we recommend cloning to base/ for version control of both base data and framework. Note: The cloned folder should be renamed from "Balmorel_data" to "data" to function properly.
Check out [the documentation](https://balmorelcommunity.github.io/Balmorel/index.html) for tutorials on getting started with the Balmorel energy system model.

Data is included in the [Balmorel_data repository](https://github.com/balmorelcommunity/Balmorel_data), which we recommend cloning to base/ for version control of both base data and framework. Note: The cloned folder should be renamed from "Balmorel_data" to "data" to function properly.

A scenario that's possible to run with an academic trial license of GAMS can be found in the balmorel-demo branch.

## What is Balmorel?
Expand Down
1 change: 1 addition & 0 deletions base/documentation/gh-pages/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ dependencies:
- sphinx
- sphinx-rtd-theme
- sphinx-autoapi
- sphinx-copybutton
```
## Installation instructions
Expand Down
1 change: 1 addition & 0 deletions base/documentation/gh-pages/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ A quick tutorial on how to get started can be found [here](get_started.md), and
:hidden:
get_started
versions
addons
pre_processing
running_on_hpc
Expand Down
17 changes: 17 additions & 0 deletions base/documentation/gh-pages/versions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Versions

A lot of different Balmorel versions exist, some of which are explained in this section.
```{hlist}
:columns: 1
* [The master branch](versions/master.md)
* [A high spatial resolution model of Denmark (municipalities)](versions/dk-highspatialres.md)
```

```{toctree}
:maxdepth: 1
:hidden:
versions/master.md
versions/dk-highspatialres.md
```
13 changes: 13 additions & 0 deletions base/documentation/gh-pages/versions/dk-highspatialres.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# dk-highspatialres

The [dk-highspatialres branch](https://github.com/balmorelcommunity/Balmorel/tree/dk-highspatialres) is used for analysing the effect of various spatial resolutions in Denmark. The [poster below](mberos-spatialagg) illustrates a case study for the EGU 2024 conference, with source codes under the [EGU 2024 Poster](https://github.com/balmorelcommunity/Balmorel/releases/tag/egu24-poster) tag in all mentioned repositories here.

The pre-processing of raw data is performed using the [following balmorel-preprocessing tool](https://github.com/Mathias157/balmorel-preprocessing/tree/spatial_study), and the prepared .inc-files for the fully resolved model can be found in the [data repository](https://github.com/balmorelcommunity/Balmorel_data/tree/dk-highspatialres).

:::{figure} https://github.com/Mathias157/balmorel-preprocessing/raw/master/Raw%20Data%20Processing/Conference%20Poster%20for%20Analysis%20of%20Spatial%20Resolutions%20for%20Modelling%20Sector-Coupled%20Energy%20Systems.png
:name: mberos-spatialagg
:alt: Poster on Danish spatial aggregation study
:width: 100%
:align: center
Poster for EGU24 using the highly resolved model, and aggregations of it.
:::
3 changes: 3 additions & 0 deletions base/documentation/gh-pages/versions/master.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Master

The [master branch](https://github.com/balmorelcommunity/Balmorel/tree/master) and [data](https://github.com/balmorelcommunity/Balmorel_data/tree/master) is updated once in a while to include recent developments in Balmorel, while maintaining a general setup.

0 comments on commit 336812b

Please sign in to comment.