From 4351bc6046c77bd3fd3cd4c5ed0768b44e8eeb27 Mon Sep 17 00:00:00 2001 From: Mathias157 Date: Wed, 18 Sep 2024 22:13:28 +0200 Subject: [PATCH] Updated installation instructions --- README.md | 2 +- docs/get_started/installation.md | 20 ++++++++++++-------- docs/index.md | 4 +++- environment.yml | 14 ++++++++++++++ 4 files changed, 30 insertions(+), 10 deletions(-) create mode 100644 environment.yml diff --git a/README.md b/README.md index ad8f4ff..ce63ff8 100644 --- a/README.md +++ b/README.md @@ -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` diff --git a/docs/get_started/installation.md b/docs/get_started/installation.md index 72c8758..9cc5832 100644 --- a/docs/get_started/installation.md +++ b/docs/get_started/installation.md @@ -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 ``` diff --git a/docs/index.md b/docs/index.md index e059afd..f2379ea 100644 --- a/docs/index.md +++ b/docs/index.md @@ -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} diff --git a/environment.yml b/environment.yml new file mode 100644 index 0000000..3ec21f9 --- /dev/null +++ b/environment.yml @@ -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 \ No newline at end of file