From 6615490807fae9f804d126a7e7bcec731fbf5529 Mon Sep 17 00:00:00 2001 From: "Carles S. Soriano Perez" Date: Tue, 11 Jul 2023 19:53:02 +0200 Subject: [PATCH] ci: Added files required to generate binder environment --- examples/README.md | 16 ++++++++++++++++ apt.txt => examples/apt.txt | 0 examples/environment.yml | 11 +++++++++++ 3 files changed, 27 insertions(+) create mode 100644 examples/README.md rename apt.txt => examples/apt.txt (100%) create mode 100644 examples/environment.yml diff --git a/examples/README.md b/examples/README.md new file mode 100644 index 000000000..c6442b33e --- /dev/null +++ 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. \ No newline at end of file diff --git a/apt.txt b/examples/apt.txt similarity index 100% rename from apt.txt rename to examples/apt.txt diff --git a/examples/environment.yml b/examples/environment.yml new file mode 100644 index 000000000..bc7d62bef --- /dev/null +++ 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 \ No newline at end of file