Skip to content

Commit

Permalink
Updated installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
Mathias157 committed Sep 18, 2024
1 parent 9177557 commit 4351bc6
Show file tree
Hide file tree
Showing 4 changed files with 30 additions and 10 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# pybalmorel
Convenient python functions for pre- or post-processing the GAMS framework Balmorel. Install into your virtual python environment with:
Convenient python framework for pre-, post-processing or executing the GAMS framework Balmorel. Install into your virtual python environment with:

`pip install pybalmorel`

Expand Down
20 changes: 12 additions & 8 deletions docs/get_started/installation.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,25 @@
## Installation
# 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:
## Requirements
pybalmorel has the following requirements - here illustrated in a environment.yml file that can be used to create the necessary conda environment (note that it will also install pybalmorel itself):
```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
- pandas >= 2.1.4
- matplotlib >= 3.9.0
- geopandas >= 0.14.4
- ipywidgets >= 8.1.3
- ipykernel
- pip
- pip:
- gamsapi[transfer] >= 45.0.0
- pybalmorel
```
4 changes: 3 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# pybalmorel
Convenient python functions for pre- or post-processing the GAMS framework Balmorel. Get started [here](get_started.md).
Convenient python framework for pre-, post-processing or executing the GAMS framework [Balmorel](https://balmorelcommunity.github.io/Balmorel).

Get started [here](get_started.md).


```{toctree}
Expand Down
14 changes: 14 additions & 0 deletions environment.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
name: pybalmorel
channels:
- conda-forge
dependencies:
- python >= 3.9
- pandas >= 2.1.4
- matplotlib >= 3.9.0
- geopandas >= 0.14.4
- ipywidgets >= 8.1.3
- ipykernel
- pip
- pip:
- gamsapi[transfer] >= 45.0.0
- pybalmorel

0 comments on commit 4351bc6

Please sign in to comment.