ci: Added files required to generate binder environment

Deltares · Jul 11, 2023 · 6615490 · 6615490
1 parent 349c6dc
commit 6615490
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 0 deletions.
diff --git a/examples/README.md b/examples/README.md
@@ -0,0 +1,16 @@
+[![Python 3.10](https://img.shields.io/badge/Python-3.10-blue.svg)](https://www.python.org/downloads/release/python-3109/)
+[![GitHub Pages documentation](https://github.com/Deltares/ra2ce/actions/workflows/deploy_docs.yml/badge.svg)](https://github.com/Deltares/ra2ce/actions/workflows/deploy_docs.yml)
+[![Binder branch](https://github.com/Deltares/ra2ce/actions/workflows/binder_branch.yml/badge.svg)](https://github.com/Deltares/ra2ce/actions/workflows/binder_branch.yml)
+
+# Ra2ce Examples
+
+This directory contains all (current) available examples of ra2ce. An environment is ready to run them:
+```
+conda env create -f environment.yml
+conda activate ra2ce_examples_env
+python import ra2ce
+```
+
+At the same time you may use our [binder environment](https://mybinder.org/v2/gh/Deltares/ra2ce/jupyter-binder).
+
+Please refer to our [Ra2ce documentation](https://deltares.github.io/ra2ce/) for more information.
diff --git a/apt.txt → examples/apt.txt b/apt.txt → examples/apt.txt
diff --git a/examples/environment.yml b/examples/environment.yml
@@ -0,0 +1,11 @@
+name: ra2ce_examples_env
+channels:
+  - conda-forge
+  - nodefaults
+dependencies:
+  - conda-forge::python=3.10
+  - conda-forge::gdal=3.5.1
+  - conda-forge::fiona
+  - conda-forge::poetry=1.3.2
+  - pip:
+    - git+https://github.com/Deltares/ra2ce.git