adding tutorials workflow + update toml

Author: dario-coscia

.github/workflows/tutorial.yml

@@ -0,0 +1,80 @@
+name: "Export tutorials"
+
+on:
+  push:
+    branches:
+      - "**"  # Run on push on all branches
+    # paths:
+    #   - 'tutorials/**/*.ipynb'
+
+jobs:
+  export_tutorials:
+    permissions: write-all
+    runs-on: ubuntu-latest
+    env:
+      TUTORIAL_TIMEOUT: 1200s
+    steps:
+    - uses: actions/checkout@v4
+      with:
+          fetch-depth: 1
+
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: 3.8
+
+    - name: Install dependencies
+      run: |
+        # Dependencies for tutorials
+        python3 -m pip install --upgrade pip .[tutorial] black[jupyter]
+
+    - name: Setup FFmpeg
+      uses: FedericoCarboni/setup-ffmpeg@v2
+        
+    - id: files
+      uses: jitterbit/get-changed-files@v1
+      continue-on-error: true
+      with:
+        token: ${{ secrets.GITHUB_TOKEN }}
+        format: space-delimited
+
+    - name: Configure git
+      run: |
+        git config user.name "github-actions[bot]"
+        git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+
+    - name: Export tutorials to .py and RST
+      run: |
+        set -x
+        for file in ${{ steps.files.outputs.all }}; do
+          if [[ $file == *.ipynb ]]; then
+            filename=$(basename $file)
+
+            pyfilename=$(echo ${filename%?????})py
+            timeout --signal=SIGKILL $TUTORIAL_TIMEOUT python -Xfrozen_modules=off -m jupyter nbconvert --execute $file --to python --output $pyfilename
+
+            rstfilename=$(echo ${filename%?????} | sed -e 's/-//g')rst
+            output_dir="docs/source/_rst/_tutorials"
+            timeout --signal=SIGKILL $TUTORIAL_TIMEOUT python -Xfrozen_modules=off -m jupyter nbconvert --execute $file --to rst --output $rstfilename --output-dir=$output_dir/$(dirname $file | sed 's|tutorials/||')
+          fi
+        done
+        set +x
+        
+    - name: Run formatter
+      run: black tutorials/
+    
+    - uses: benjlevesque/[email protected]
+      id: short-sha
+
+    - name: Remove unwanted files
+      run: |
+        rm -rf build/
+
+    - name: Create Pull Request
+      uses: peter-evans/[email protected]
+      with:
+        labels: maintenance
+        title: Export tutorial changed in ${{ steps.short-sha.outputs.sha }}
+        branch: export-tutorial-${{ steps.short-sha.outputs.sha }}
+        commit-message: export tutorials changed in ${{ steps.short-sha.outputs.sha }}
+        delete-branch: true

pyproject.toml

@@ -22,7 +22,7 @@ dependencies = [
 requires-python = ">=3.8"
 
 [project.optional-dependencies]
-docs = [
+doc = [
     "sphinx>5.0",
     "sphinx_rtd_theme",
     "sphinx_copybutton",
@@ -37,7 +37,8 @@ test = [
 dev = [
     "black @ git+https://github.com/psf/black"
 ]
-tutorials = [
+tutorial = [
+    "jupyter",
     "smithers @ git+https://github.com/mathLab/smithers.git",
     "torchvision",
     "tensorboard",

tutorials/README.md

@@ -33,3 +33,4 @@ Time dependent Kuramoto Sivashinsky equation using the Averaging Neural Operator
 |---------------|-----------|
 Unstructured convolutional autoencoder via continuous convolution |[[.ipynb](tutorial4/tutorial.ipynb), [.py](tutorial4/tutorial.py), [.html](http://mathlab.github.io/PINA/_rst/tutorials/tutorial4/tutorial.html)]|
 POD-RBF and POD-NN for reduced order modeling| [[.ipynb](tutorial8/tutorial.ipynb), [.py](tutorial8/tutorial.py), [.html](http://mathlab.github.io/PINA/_rst/tutorials/tutorial8/tutorial.html)]|
+POD-RBF for modelling Lid Cavity| [[.ipynb](tutorial14/tutorial.ipynb), [.py](tutorial14/tutorial.py), [.html](http://mathlab.github.io/PINA/_rst/tutorials/tutorial14/tutorial.html)]|