CI: Add Workflow to Run Jupyter Notebooks

Author: EZoni

.github/workflows/jupyter.yml

@@ -0,0 +1,34 @@
+name: 📙 Jupyter
+
+on:
+  push:
+    branches:
+      - "development"
+  pull_request:
+    paths-ignore:
+      - "Docs/**"
+      - "**.rst"
+
+concurrency:
+  group: ${{ github.ref }}-${{ github.head_ref }}-jupyter
+  cancel-in-progress: true
+
+jobs:
+  jupyter_notebooks:
+    name: Notebooks
+    runs-on: ubuntu-latest
+    if: github.event.pull_request.draft == false
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.x"
+    - name: Install Dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install nbconvert nbformat jupyter
+    - name: Run Notebooks
+      run: |
+        cd Tools/Algorithms
+        jupyter nbconvert --to notebook --execute psatd.ipynb

.gitignore

@@ -29,6 +29,7 @@ Python/dist/
 Python/pywarpx.egg-info/
 _tmppythonbuild/
 pywarpx.egg-info/
+*.ipynb_checkpoints/
 
 ##########
 # Sphinx #

Tools/Algorithms/psatd.ipynb

@@ -73,9 +73,11 @@
     "    \"\"\"\n",
     "    Simplify matrix W.\n",
     "    \"\"\"\n",
+    "    W = sp.Matrix(W)\n",
     "    for i in range(W.shape[0]):\n",
     "        for j in range(W.shape[1]):\n",
-    "            W[i, j] = W[i, j].expand().simplify()"
+    "            W[i, j] = W[i, j].expand().simplify()\n",
+    "    W = sp.ImmutableMatrix(W)"
    ]
   },
   {
@@ -689,24 +691,6 @@
     "\n",
     "Display the coefficients of the update equations one by one. For example, `coeff_h[('Ex', 'By')]` displays the coefficient of $E^x$ with respect to $B^y$ (resulting from the solution of the homogeneous system, hence the `_h` suffix), while `coeff_nh[('Ex', 'Jx_c0')]` displays the coefficient of $E^x$ with respect to $\\gamma_{J_x}$ (resulting from the solution of the non-homogeneous system, hence the `_nh` suffix). Note that $\\gamma_{J_x}$ is denoted as `Jx_c0` in the notebook, as described in the beginning."
    ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "coeff_h[(\"Ex\", \"By\")]"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "coeff_nh[(\"Ex\", \"Jx_c0\")]"
-   ]
   }
  ],
  "metadata": {
@@ -725,7 +709,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.12.4"
+   "version": "3.13.1"
   }
  },
  "nbformat": 4,