Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions .github/workflows/ci_pipeline.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ jobs:
strategy:
fail-fast: false
matrix:
python: ['3.8', '3.9', '3.10', '3.11', '3.12']
python: ['3.9', '3.10', '3.11', '3.12', '3.13']
defaults:
run:
shell: bash -l {0}
Expand Down Expand Up @@ -44,7 +44,7 @@ jobs:

test-tutorials:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v3
- name: Set up Python 3.11
Expand All @@ -59,4 +59,3 @@ jobs:
- name: Test with pytest-notebook
run: |
pytest ./docs/notebooks --nb-test-files -v

2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ c, b, A = genQCoeffs("ERK4")

> 🔔 _If you are not familiar with SDC or related methods, and want to learn more about it, checkout the
> [latest documentation build](https://qmat.readthedocs.io/en/latest/) and
in particular the [**step by step tutorials**](https://qmat.readthedocs.io/en/latest/notebooks.html)_
in particular the [**step by step notebook tutorials**](https://qmat.readthedocs.io/en/latest/notebooks.html)_

For any contribution, please checkout out (very cool) [Contribution Guidelines](https://qmat.readthedocs.io/en/latest/contributing.html)
and the current [Development Roadmap](https://qmat.readthedocs.io/en/latest/devdoc/roadmap.html).
Expand Down
20 changes: 16 additions & 4 deletions docs/notebooks.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Tutorials
# Notebook Tutorials

📜 *Extensive user guide, mostly based on step-by-step tutorials ...*

Expand All @@ -9,11 +9,11 @@ All tutorials are written in jupyter notebooks, that can be :

> 🛠️ Basic usage tutorials are finalized and polished, the rest is still in construction ...

Notebooks are categorized into three main sections :
Notebooks are categorized into those main sections :

1. **Basic usage** : how to generate and use basic $Q$-coefficients and $Q_\Delta$ approximations, through a step-by-step tutorial going from generic Runge-Kutta methods to SDC for simple problems.
2. **Extended usage** : description of the additional features or `qmat`, like the $S$-matrix,
the `hCoeffs` and `dTau` coefficients, ... going deeper into SDC
2. **Extended usage** : additional features or `qmat` ($S$-matrix, `hCoeffs`, `dTau` coefficients, ...) to go deeper into SDC
3. **Components usage** : how to use the main utility modules, like `qmat.lagrange`, etc ...


```{eval-rst}
Expand All @@ -38,3 +38,15 @@ Extended usage
:glob:

notebooks/1*

Components usage
================

📜 *How to use the utility modules*

.. toctree::
:maxdepth: 1
:glob:

notebooks/2*
```
4 changes: 2 additions & 2 deletions docs/notebooks/02_rk.ipynb

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/notebooks/04_sdc.ipynb

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions docs/notebooks/05_residuals.ipynb

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/notebooks/11_nodeFormulation.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"# Extended Step 1 : Zero-to-Nodes (Z2N) and Node-to-Node (N2N)\n",
"# Advanced Step 1 : Zero-to-Nodes (Z2N) and Node-to-Node (N2N)\n",
"\n",
"📜 _If you already know about SDC from the [original paper](https://link.springer.com/content/pdf/10.1023/A:1022338906936.pdf) of Dutt, Greengard & Rokhlin, you may notice that their description is very different from the one given [in Step 4](./04_sdc.ipynb) ..._\n",
"\n",
Expand Down
2 changes: 1 addition & 1 deletion docs/notebooks/11_prolongation.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"# Step 5 : generalizing the prolongation for RK-type and SDC-type time-steppers\n",
"# Advanced Step 2 : generalizing the prolongation for RK-type and SDC-type time-steppers\n",
"\n",
"🛠️ In construction ..."
]
Expand Down
2 changes: 1 addition & 1 deletion docs/notebooks/12_initialization.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"# Step 6 : generalizing the initialization of SDC-type time-steppers\n",
"# Advanced Step 3 : generalizing the initialization of SDC-type time-steppers\n",
"\n",
"🛠️ In construction ..."
]
Expand Down
570 changes: 570 additions & 0 deletions docs/notebooks/21_lagrange.ipynb

Large diffs are not rendered by default.

21 changes: 21 additions & 0 deletions docs/notebooks/22_nodes.ipynb
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
{
"cells": [
{
"cell_type": "markdown",
"id": "468aa069",
"metadata": {},
"source": [
"# Tutorial 2 : using the `qmat.nodes` module\n",
"\n",
"🛠️ In construction ..."
]
}
],
"metadata": {
"language_info": {
"name": "python"
}
},
"nbformat": 4,
"nbformat_minor": 5
}
7 changes: 5 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ dependencies = [
"numpy",
"scipy",
]
requires-python = ">=3.8"
requires-python = ">=3.9"
maintainers = [
{name = "Thibaut Lunet", email = "thibaut.lunet@tuhh.de"},
]
Expand All @@ -24,11 +24,11 @@ classifiers = [
"License :: OSI Approved :: BSD License",

"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.8",
"Programming Language :: Python :: 3.9",
"Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3.11",
"Programming Language :: Python :: 3.12",
"Programming Language :: Python :: 3.13",
]

[project.optional-dependencies]
Expand Down Expand Up @@ -68,6 +68,9 @@ qmat-stability = "qmat.scripts.stability:main"
nb_diff_ignore = [
"/metadata/",
"/cells/*/outputs/*/data/image/png"]
pythonpath = [
"."
]

[tool.coverage.run]
relative_files = true
Expand Down
Loading