Skip to content

Commit

Permalink
Updated the structure, so more pages are used with less content
Browse files Browse the repository at this point in the history
  • Loading branch information
Mathias157 committed Sep 17, 2024
1 parent 7c0e7cb commit 9778c1d
Show file tree
Hide file tree
Showing 6 changed files with 36 additions and 15 deletions.
2 changes: 1 addition & 1 deletion docs/about.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# About this code

Work in progress ...
This documentation is under construction
4 changes: 2 additions & 2 deletions docs/css/css_options.css
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
/* Changing the ugly purple visited colour to remain blue or white for all links */
/* Cross references remain blue */
a[class="reference internal"]:visited {
color: #2980B9;
color: #6d91a8;
}
a[class="reference external"]:visited {
color: #2980B9;
}

/* Toctree remains white */
li[class='toctree-l1'] a:visited {
div[class="wy-side-scroll"] li[class='toctree-l1'] a:visited {
color: white;
}

Expand Down
8 changes: 8 additions & 0 deletions docs/get_started.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Get Started

```{toctree}
:maxdepth: 1
get_started/installation.md
get_started/examples.md
```
8 changes: 0 additions & 8 deletions docs/introduction.md → docs/get_started/examples.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,3 @@
# Introduction

## Installation
Install into your virtual python environment with:

`pip install pybalmorel`

For more information on how to manage and install virtual environments check out [this resource](https://docs.python.org/3/library/venv.html), or if you are a conda user, [this resource](https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html).

## Examples
The following notebooks provide examples on how to use pybalmorel for pre-processing, post-processing and for executing Balmorel scenarios:
Expand Down
21 changes: 21 additions & 0 deletions docs/get_started/installation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
## Installation
Install into your virtual python environment with:

`pip install pybalmorel`

For more information on how to manage and install virtual environments check out [this resource](https://docs.python.org/3/library/venv.html), or if you are a conda user, [this resource](https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html).

### Requirements
pybalmorel has the following requirements - here illustrated in a environment.yml file that can be used to create the necessary conda environment:
```yaml
name: pybalmorel
channels:
- conda-forge
dependencies:
- python >= 3.9
- pandas>=2.1.4
- matplotlib>=3.9.0
- geopandas>=0.14.4
- gamsapi[transfer]>=45.0.0
- ipywidgets>=8.1.3
```
8 changes: 4 additions & 4 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# pybalmorel
Convenient python functions for pre- or post-processing the GAMS framework Balmorel.
Check out the [introduction](introduction.md).
Convenient python functions for pre- or post-processing the GAMS framework Balmorel. Get started [here](get_started.md).


```{toctree}
:maxdepth: 2
:maxdepth: 1
:caption: pybalmorel
:hidden:
introduction
get_started
```

```{toctree}
Expand Down

0 comments on commit 9778c1d

Please sign in to comment.