pymrm 2.2.1__tar.gz → 2.2.2__tar.gz

{pymrm-2.2.1 → pymrm-2.2.2}/.github/workflows/build.yml

@@ -23,3 +23,16 @@ jobs:
 
     - name: Test Install
       run: python -m pip install .
+
+  documentation:
+    runs-on: ubuntu-latest
+    container:
+      image: python:3.10
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Configure git safe.directory for container
+      run: git config --global --add safe.directory "$GITHUB_WORKSPACE"
+
+    - name: Build documentation (with apidoc regeneration)
+      run: scripts/build_documentation.sh

{pymrm-2.2.1 → pymrm-2.2.2}/CITATION.cff

@@ -1,6 +1,6 @@
 cff-version: 1.2.0
 title: "pymrm: Python package for Multiphase Reactor Modeling"
-version: "2.2.0"
+version: "2.2.1"
 message: "If you use pymrm in your work, please cite the version you used."
 authors:
   - family-names: Peters
@@ -9,7 +9,7 @@ authors:
   - family-names: van Sint Annaland
     given-names: M.
     orcid: "https://orcid.org/0000-0002-2903-7443"
-date-released: "2026-03-24"
+date-released: "2026-04-17"
 identifiers:
   - type: doi
     value: 10.5281/zenodo.17065798

{pymrm-2.2.1 → pymrm-2.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pymrm
-Version: 2.2.1
+Version: 2.2.2
 Summary: Functions for multiphase reactor modeling
 Author-email: "E.A.J.F. Peters" <e.a.j.f.peters@tue.nl>, "M. van Sint Annaland" <M.v.SintAnnaland@tue.nl>, "M. Galanti" <m.galanti@tue.nl>, "D.R. Rieder" <d.r.rieder@tue.nl>
 Maintainer-email: "E.A.J.F. Peters" <e.a.j.f.peters@tue.nl>

{pymrm-2.2.1 → pymrm-2.2.2}/docs/installation.md

@@ -82,7 +82,7 @@ PyMRM is available on PyPI and includes all necessary dependencies.
 ## Verifying the Installation
 
 1. **Test the Installation**:
-   - Navigate to the `examples` folder in the PyMRM repository or download example notebooks from the [PyMRM documentation](https://multiscale-modelling-multiphase-flows.github.io/pymrm-book).
+   - Navigate to the `examples` folder in the PyMRM repository or download example notebooks from the [PyMRM documentation](https://computational-chemical-engineering.github.io/pymrm-book).
    - Open a notebook in VS Code or Jupyter Notebook and execute the cells to verify that PyMRM and its dependencies are working correctly.
 
 2. **Optional: Test in Spyder**:
@@ -94,4 +94,4 @@ PyMRM is available on PyPI and includes all necessary dependencies.
 
 ## Conclusion
 
-You have successfully set up your environment for using PyMRM. Whether you use VS Code or Spyder, you are now ready to start modeling multiphase reactors. For further guidance, refer to the [PyMRM documentation](https://multiscale-modelling-multiphase-flows.github.io/pymrm-book).
+You have successfully set up your environment for using PyMRM. Whether you use VS Code or Spyder, you are now ready to start modeling multiphase reactors. For further guidance, refer to the [PyMRM documentation](https://computational-chemical-engineering.github.io/pymrm-book).

{pymrm-2.2.1 → pymrm-2.2.2}/docs/sphinx/modules.rst

@@ -1,4 +1,4 @@
-pyMRM
+pymrm
 =====
 
 .. toctree::

{pymrm-2.2.1 → pymrm-2.2.2}/docs/sphinx/pymrm.rst

@@ -1,66 +1,77 @@
+pymrm package
+=============
+
 Submodules
-==========
+----------
 
 pymrm.convect module
 --------------------
 
 .. automodule:: pymrm.convect
    :members:
+   :show-inheritance:
    :undoc-members:
+
+pymrm.coupling module
+---------------------
+
+.. automodule:: pymrm.coupling
+   :members:
    :show-inheritance:
+   :undoc-members:
 
 pymrm.grid module
 -----------------
 
 .. automodule:: pymrm.grid
    :members:
-   :undoc-members:
    :show-inheritance:
+   :undoc-members:
 
 pymrm.helpers module
 --------------------
 
 .. automodule:: pymrm.helpers
    :members:
-   :undoc-members:
    :show-inheritance:
+   :undoc-members:
 
 pymrm.interpolate module
 ------------------------
 
 .. automodule:: pymrm.interpolate
    :members:
-   :undoc-members:
    :show-inheritance:
+   :undoc-members:
 
 pymrm.numjac module
 -------------------
 
 .. automodule:: pymrm.numjac
    :members:
-   :undoc-members:
    :show-inheritance:
+   :undoc-members:
 
 pymrm.operators module
 ----------------------
 
 .. automodule:: pymrm.operators
    :members:
-   :undoc-members:
    :show-inheritance:
+   :undoc-members:
 
 pymrm.solve module
 ------------------
 
 .. automodule:: pymrm.solve
    :members:
-   :undoc-members:
    :show-inheritance:
+   :undoc-members:
 
 Module contents
 ---------------
 
 .. automodule:: pymrm
    :members:
-   :undoc-members:
    :show-inheritance:
+   :undoc-members:

{pymrm-2.2.1 → pymrm-2.2.2}/scripts/build_documentation.sh

@@ -5,6 +5,16 @@
 
 pip install myst-parser # workaround. Should be included in Docker image?
 pip install -e .
+sphinx-apidoc -f -o docs/sphinx src/pymrm
+if [[ "${CI}" == "true" ]]; then
+    api_rst_files=(docs/sphinx/pymrm.rst docs/sphinx/modules.rst)
+    if ! git diff --quiet HEAD -- "${api_rst_files[@]}"; then
+        echo "Detected outdated autogenerated Sphinx API files:"
+        git --no-pager diff HEAD -- "${api_rst_files[@]}"
+        echo "Run 'sphinx-apidoc -f -o docs/sphinx src/pymrm' and commit the updated rst files."
+        exit 1
+    fi
+fi
 cd docs/sphinx
 mkdir -p _static
 make html 2>documentation_errors.txt

{pymrm-2.2.1 → pymrm-2.2.2}/src/pymrm/_version.py

@@ -18,7 +18,7 @@ version_tuple: tuple[int | str, ...]
 commit_id: str | None
 __commit_id__: str | None
 
-__version__ = version = '2.2.1'
-__version_tuple__ = version_tuple = (2, 2, 1)
+__version__ = version = '2.2.2'
+__version_tuple__ = version_tuple = (2, 2, 2)
 
-__commit_id__ = commit_id = 'g2edc02389'
+__commit_id__ = commit_id = 'g471977efe'

{pymrm-2.2.1 → pymrm-2.2.2}/src/pymrm.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pymrm
-Version: 2.2.1
+Version: 2.2.2
 Summary: Functions for multiphase reactor modeling
 Author-email: "E.A.J.F. Peters" <e.a.j.f.peters@tue.nl>, "M. van Sint Annaland" <M.v.SintAnnaland@tue.nl>, "M. Galanti" <m.galanti@tue.nl>, "D.R. Rieder" <d.r.rieder@tue.nl>
 Maintainer-email: "E.A.J.F. Peters" <e.a.j.f.peters@tue.nl>

{pymrm-2.2.1 → pymrm-2.2.2}/tutorials/introduction_and_start.ipynb

@@ -73,7 +73,7 @@
    "source": [
     "## Tutorials\n",
     "\n",
-    "This collection of tutorials is designed to familiarize you with the basic building blocks of `PyMRM` and some of its advanced features. The full API documentation is available at [PyMRM Documentation](https://multiscale-modelling-multiphase-flows.github.io/pymrm-book/content/api/index.html).\n",
+    "This collection of tutorials is designed to familiarize you with the basic building blocks of `PyMRM` and some of its advanced features. The full API documentation is available at [PyMRM Documentation](https://computational-chemical-engineering.github.io/pymrm-book/content/api/index.html).\n",
     "\n",
     "Below is an outline of the available tutorials:\n",
     "\n",