From 336812be0796406cc8e56e6665747936056036c0 Mon Sep 17 00:00:00 2001 From: Mathias Berg Rosendal <77012503+Mathias157@users.noreply.github.com> Date: Mon, 14 Oct 2024 13:25:52 +0200 Subject: [PATCH] Added documentation on branches (#31) * 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 --- README.md | 5 ++++- base/documentation/gh-pages/README.md | 1 + base/documentation/gh-pages/index.md | 1 + base/documentation/gh-pages/versions.md | 17 +++++++++++++++++ .../gh-pages/versions/dk-highspatialres.md | 13 +++++++++++++ base/documentation/gh-pages/versions/master.md | 3 +++ 6 files changed, 39 insertions(+), 1 deletion(-) create mode 100644 base/documentation/gh-pages/versions.md create mode 100644 base/documentation/gh-pages/versions/dk-highspatialres.md create mode 100644 base/documentation/gh-pages/versions/master.md diff --git a/README.md b/README.md index cf74083e..dc9889bf 100644 --- a/README.md +++ b/README.md @@ -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? diff --git a/base/documentation/gh-pages/README.md b/base/documentation/gh-pages/README.md index 95d775c9..97a9af87 100644 --- a/base/documentation/gh-pages/README.md +++ b/base/documentation/gh-pages/README.md @@ -29,6 +29,7 @@ dependencies: - sphinx - sphinx-rtd-theme - sphinx-autoapi + - sphinx-copybutton ``` ## Installation instructions diff --git a/base/documentation/gh-pages/index.md b/base/documentation/gh-pages/index.md index 3e65663a..eb71f921 100644 --- a/base/documentation/gh-pages/index.md +++ b/base/documentation/gh-pages/index.md @@ -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 diff --git a/base/documentation/gh-pages/versions.md b/base/documentation/gh-pages/versions.md new file mode 100644 index 00000000..cf683103 --- /dev/null +++ b/base/documentation/gh-pages/versions.md @@ -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 +``` \ No newline at end of file diff --git a/base/documentation/gh-pages/versions/dk-highspatialres.md b/base/documentation/gh-pages/versions/dk-highspatialres.md new file mode 100644 index 00000000..e7685ed0 --- /dev/null +++ b/base/documentation/gh-pages/versions/dk-highspatialres.md @@ -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. +::: \ No newline at end of file diff --git a/base/documentation/gh-pages/versions/master.md b/base/documentation/gh-pages/versions/master.md new file mode 100644 index 00000000..a6689a5c --- /dev/null +++ b/base/documentation/gh-pages/versions/master.md @@ -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. \ No newline at end of file