Merge branch 'master' into add_geo_set_generator

balmorelcommunity · Sep 22, 2024 · 27c4d0b · 27c4d0b
2 parents 966bd7c + d07cd32
commit 27c4d0b
Show file tree

Hide file tree

Showing 5 changed files with 20 additions and 4 deletions.
diff --git 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/conf.py b/docs/conf.py
@@ -23,7 +23,7 @@
 autoapi_ignore = ["*/conf.py"]
 
 myst_enable_extensions = [
-    "colon_fence",  # ::: can be used instead of ``` for better rendering
+    "colon_fence",  # ::: can be used instead of ``` for better rendering    
 ]
 
 html_theme = "sphinx_rtd_theme"

diff --git a/docs/get_started/installation.md b/docs/get_started/installation.md
@@ -6,7 +6,7 @@ Install into your virtual python environment with:
 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:
+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:

diff --git 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
@@ -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