Merge pull request #71 from festim-dev/ci-for-new-demos

CI for new demos and updated README

.github/workflows/test_notebooks.yml

@@ -96,4 +96,40 @@ jobs:
         run: |
           cd tasks
           jupyter-nbconvert --to python task10.ipynb
-          conda run python task10.py
+          conda run python task10.py
+      - name: Run Task 11
+        shell: bash -l {0}
+        run: |
+          cd tasks
+          jupyter-nbconvert --to python task11.ipynb
+          conda run python task11.py
+      - name: Run Task 12
+        shell: bash -l {0}
+        run: |
+          cd tasks
+          jupyter-nbconvert --to python task12.ipynb
+          conda run python task12.py
+      - name: Run Task 13
+        shell: bash -l {0}
+        run: |
+          cd tasks
+          jupyter-nbconvert --to python task13.ipynb
+          conda run python task13.py
+      - name: Run Task 14
+        shell: bash -l {0}
+        run: |
+          cd tasks
+          jupyter-nbconvert --to python task14.ipynb
+          conda run python task14.py
+      - name: Run Task 15
+        shell: bash -l {0}
+        run: |
+          cd tasks
+          jupyter-nbconvert --to python task15.ipynb
+          conda run python task15.py
+      - name: Run Task 16
+        shell: bash -l {0}
+        run: |
+          cd tasks
+          jupyter-nbconvert --to python task16.ipynb
+          conda run python task16.py

README.md

@@ -1,8 +1,11 @@
 # FESTIM-workshop
 
 [![Test](https://github.com/festim-dev/FESTIM-workshop/actions/workflows/test_notebooks.yml/badge.svg)](https://github.com/festim-dev/FESTIM-workshop/actions/workflows/test_notebooks.yml)
+[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/festim-dev/FESTIM-workshop/main)
 
-## Contents
+## Tasks
+
+### Basic
 
 [Task 1](https://github.com/festim-dev/FESTIM-workshop/blob/main/tasks/task01.ipynb): Simple hydrogen transport simulation
 
@@ -14,23 +17,46 @@
 
 [Task 5](https://github.com/festim-dev/FESTIM-workshop/blob/main/tasks/task05.ipynb): Post-processing and visualisation
 
-[Task 6](https://github.com/festim-dev/FESTIM-workshop/blob/main/tasks/task06.ipynb): Advection-diffusion problem
-
 [Task 7](https://github.com/festim-dev/FESTIM-workshop/blob/main/tasks/task07.ipynb): Heat transfer simulation
 
 [Task 8](https://github.com/festim-dev/FESTIM-workshop/blob/main/tasks/task08.ipynb): CAD integration
 
 [Task 9](https://github.com/festim-dev/FESTIM-workshop/blob/main/tasks/task09.ipynb): Integration with the HTM library
 
+
+### Advanced
+
+[Task 6](https://github.com/festim-dev/FESTIM-workshop/blob/main/tasks/task06.ipynb): Advection-diffusion problem
+
 [Task 10](https://github.com/festim-dev/FESTIM-workshop/blob/main/tasks/task10.ipynb): Fitting a TDS spectrum
 
+[Task 11](https://github.com/festim-dev/FESTIM-workshop/blob/main/tasks/task11.ipynb): Radioactive decay ☢️
+
+[Task 12](https://github.com/festim-dev/FESTIM-workshop/blob/main/tasks/task12.ipynb): Soret Effect
+
+[Task 13](https://github.com/festim-dev/FESTIM-workshop/blob/main/tasks/task13.ipynb): Modelling discontinuous trapped concentration profiles
+
+[Task 14](https://github.com/festim-dev/FESTIM-workshop/blob/main/tasks/task14.ipynb): Non-cartesian meshes
+
+[Task 15](https://github.com/festim-dev/FESTIM-workshop/blob/main/tasks/task15.ipynb): Kinetic surface model
+
+[Task 16](https://github.com/festim-dev/FESTIM-workshop/blob/main/tasks/task16.ipynb): Custom classes
+
+
+
 ## Getting started
 
-### A. Codespaces (recommended)
+### A. Binder (recommended)
+
+[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/festim-dev/FESTIM-workshop/main)
+
+[Run this workshop](https://mybinder.org/v2/gh/festim-dev/FESTIM-workshop/main) in BinderHub
+
+### B. Codespaces
 
 You can [create a Codespace](https://github.com/codespaces/new?machine=standardLinux32gb&repo=520445592&ref=main&devcontainer_path=.devcontainer%2Fdevcontainer.json&location=WestEurope) based on this repo
 
-### B. Local install
+### C. Local install
 
 1. Clone this repo
 
@@ -42,3 +68,5 @@ git clone https://github.com/festim-dev/FESTIM-workshop
 ```
 conda env create -f environment.yml
 ```
+
+3. You should then be able to execute the notebooks with the ``festim-workshop`` environment