From 9139d1604dcacbe47dc79bf03cb7c96d995e060e Mon Sep 17 00:00:00 2001 From: RemDelaporteMathurin Date: Wed, 31 Jul 2024 13:59:16 +0200 Subject: [PATCH 1/4] add tasks up to 16 --- .github/workflows/test_notebooks.yml | 38 +++++++++++++++++++++++++++- 1 file changed, 37 insertions(+), 1 deletion(-) diff --git a/.github/workflows/test_notebooks.yml b/.github/workflows/test_notebooks.yml index 3a5dceb..1c75314 100644 --- a/.github/workflows/test_notebooks.yml +++ b/.github/workflows/test_notebooks.yml @@ -96,4 +96,40 @@ jobs: run: | cd tasks jupyter-nbconvert --to python task10.ipynb - conda run python task10.py \ No newline at end of file + conda run python task10.py + - name: Run Task 11 + shell: bash -l {0} + run: | + cd tasks + jupyter-nbconvert --to python task1.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 \ No newline at end of file From fda6e14d46d2396d7a7b1ebfa2c64e9f7619c99d Mon Sep 17 00:00:00 2001 From: RemDelaporteMathurin Date: Wed, 31 Jul 2024 14:13:18 +0200 Subject: [PATCH 2/4] updated README --- README.md | 36 ++++++++++++++++++++++++++++++++---- 1 file changed, 32 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 4af16b3..1e54d97 100644 --- a/README.md +++ b/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/HEAD) -## 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) 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 +### B. Binder + +[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/festim-dev/FESTIM-workshop/HEAD) + +[Run this workshop](https://mybinder.org/v2/gh/festim-dev/FESTIM-workshop/HEAD) in BinderHub + +### 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 \ No newline at end of file From 6dbaf392787db201bda87f9fe88f1b334d21fa97 Mon Sep 17 00:00:00 2001 From: RemDelaporteMathurin Date: Wed, 31 Jul 2024 14:13:56 +0200 Subject: [PATCH 3/4] fixed filename --- .github/workflows/test_notebooks.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/test_notebooks.yml b/.github/workflows/test_notebooks.yml index 1c75314..0e884ab 100644 --- a/.github/workflows/test_notebooks.yml +++ b/.github/workflows/test_notebooks.yml @@ -101,7 +101,7 @@ jobs: shell: bash -l {0} run: | cd tasks - jupyter-nbconvert --to python task1.ipynb + jupyter-nbconvert --to python task11.ipynb conda run python task11.py - name: Run Task 12 shell: bash -l {0} From 846478f1ca966d1509597d6ca9923cb24059cbe7 Mon Sep 17 00:00:00 2001 From: RemDelaporteMathurin Date: Wed, 31 Jul 2024 14:48:05 +0200 Subject: [PATCH 4/4] code suggestions --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 1e54d97..bfe6462 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # 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/HEAD) +[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/festim-dev/FESTIM-workshop/main) ## Tasks @@ -46,15 +46,15 @@ ## Getting started -### A. Codespaces (recommended) +### A. Binder (recommended) -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 +[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/festim-dev/FESTIM-workshop/main) -### B. Binder +[Run this workshop](https://mybinder.org/v2/gh/festim-dev/FESTIM-workshop/main) in BinderHub -[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/festim-dev/FESTIM-workshop/HEAD) +### B. Codespaces -[Run this workshop](https://mybinder.org/v2/gh/festim-dev/FESTIM-workshop/HEAD) in BinderHub +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 ### C. Local install