pymrm 2.2.4__tar.gz → 2.3.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (102) hide show
  1. {pymrm-2.2.4 → pymrm-2.3.0}/CITATION.cff +2 -2
  2. {pymrm-2.2.4 → pymrm-2.3.0}/PKG-INFO +1 -1
  3. {pymrm-2.2.4 → pymrm-2.3.0}/docs/sphinx/conf.py +7 -0
  4. pymrm-2.3.0/examples/ibm_diffusion.ipynb +366 -0
  5. pymrm-2.3.0/examples/ibm_effective_diffusivity.ipynb +483 -0
  6. pymrm-2.3.0/examples/ibm_segmentation.ipynb +541 -0
  7. pymrm-2.3.0/examples/ibm_touching_convergence.ipynb +510 -0
  8. pymrm-2.3.0/examples/ibm_touching_particles.ipynb +551 -0
  9. {pymrm-2.2.4 → pymrm-2.3.0}/src/pymrm/__init__.py +74 -2
  10. {pymrm-2.2.4 → pymrm-2.3.0}/src/pymrm/_version.py +3 -3
  11. pymrm-2.3.0/src/pymrm/ibm.py +1082 -0
  12. pymrm-2.3.0/src/pymrm/ibm_coupling.py +342 -0
  13. pymrm-2.3.0/src/pymrm/ibm_recon.py +804 -0
  14. pymrm-2.3.0/src/pymrm/particles.py +856 -0
  15. pymrm-2.3.0/src/pymrm/segmentation.py +482 -0
  16. {pymrm-2.2.4 → pymrm-2.3.0}/src/pymrm.egg-info/PKG-INFO +1 -1
  17. {pymrm-2.2.4 → pymrm-2.3.0}/src/pymrm.egg-info/SOURCES.txt +17 -0
  18. pymrm-2.3.0/src/pymrm.egg-info/scm_file_list.json +96 -0
  19. pymrm-2.3.0/src/pymrm.egg-info/scm_version.json +8 -0
  20. pymrm-2.3.0/test/test_ibm.py +562 -0
  21. pymrm-2.3.0/test/test_ibm_coupling.py +452 -0
  22. pymrm-2.3.0/test/test_ibm_recon.py +291 -0
  23. pymrm-2.3.0/test/test_particles.py +358 -0
  24. pymrm-2.3.0/test/test_segmentation.py +310 -0
  25. {pymrm-2.2.4 → pymrm-2.3.0}/.coveragerc +0 -0
  26. {pymrm-2.2.4 → pymrm-2.3.0}/.flake8 +0 -0
  27. {pymrm-2.2.4 → pymrm-2.3.0}/.github/black-formatting.yml +0 -0
  28. {pymrm-2.2.4 → pymrm-2.3.0}/.github/workflows/analysis.yml +0 -0
  29. {pymrm-2.2.4 → pymrm-2.3.0}/.github/workflows/build.yml +0 -0
  30. {pymrm-2.2.4 → pymrm-2.3.0}/.github/workflows/python-publish.yml +0 -0
  31. {pymrm-2.2.4 → pymrm-2.3.0}/.github/workflows/test.yml +0 -0
  32. {pymrm-2.2.4 → pymrm-2.3.0}/.github/workflows/update-citation-cff.yml +0 -0
  33. {pymrm-2.2.4 → pymrm-2.3.0}/.github/workflows/validate-citation-cff.yml +0 -0
  34. {pymrm-2.2.4 → pymrm-2.3.0}/.github/workflows/verification.yml +0 -0
  35. {pymrm-2.2.4 → pymrm-2.3.0}/.gitignore +0 -0
  36. {pymrm-2.2.4 → pymrm-2.3.0}/.gitlab-ci.yml +0 -0
  37. {pymrm-2.2.4 → pymrm-2.3.0}/.vscode/launch_debugpy.json +0 -0
  38. {pymrm-2.2.4 → pymrm-2.3.0}/.vscode/settings_pytest.json +0 -0
  39. {pymrm-2.2.4 → pymrm-2.3.0}/Dockerfile +0 -0
  40. {pymrm-2.2.4 → pymrm-2.3.0}/LICENSE +0 -0
  41. {pymrm-2.2.4 → pymrm-2.3.0}/MANIFEST.in +0 -0
  42. {pymrm-2.2.4 → pymrm-2.3.0}/README.md +0 -0
  43. {pymrm-2.2.4 → pymrm-2.3.0}/docs/compile_sphinx.md +0 -0
  44. {pymrm-2.2.4 → pymrm-2.3.0}/docs/dependencies_format.md +0 -0
  45. {pymrm-2.2.4 → pymrm-2.3.0}/docs/helpers.md +0 -0
  46. {pymrm-2.2.4 → pymrm-2.3.0}/docs/installation.md +0 -0
  47. {pymrm-2.2.4 → pymrm-2.3.0}/docs/pymrm-model-style-guide.md +0 -0
  48. {pymrm-2.2.4 → pymrm-2.3.0}/docs/sphinx/.gitignore +0 -0
  49. {pymrm-2.2.4 → pymrm-2.3.0}/docs/sphinx/Makefile +0 -0
  50. {pymrm-2.2.4 → pymrm-2.3.0}/docs/sphinx/index.rst +0 -0
  51. {pymrm-2.2.4 → pymrm-2.3.0}/docs/sphinx/make.bat +0 -0
  52. {pymrm-2.2.4 → pymrm-2.3.0}/environment.yml +0 -0
  53. {pymrm-2.2.4 → pymrm-2.3.0}/examples/counter_current_reaction.ipynb +0 -0
  54. {pymrm-2.2.4 → pymrm-2.3.0}/examples/counter_diffusion_reaction.ipynb +0 -0
  55. {pymrm-2.2.4 → pymrm-2.3.0}/examples/darcy_flow.ipynb +0 -0
  56. {pymrm-2.2.4 → pymrm-2.3.0}/examples/lid_driven_cavity.ipynb +0 -0
  57. {pymrm-2.2.4 → pymrm-2.3.0}/examples/membrane_module_2D.ipynb +0 -0
  58. {pymrm-2.2.4 → pymrm-2.3.0}/examples/membrane_module_2D_Sievert.ipynb +0 -0
  59. {pymrm-2.2.4 → pymrm-2.3.0}/examples/optimization_example.ipynb +0 -0
  60. {pymrm-2.2.4 → pymrm-2.3.0}/examples/particle_model_effectiveness.ipynb +0 -0
  61. {pymrm-2.2.4 → pymrm-2.3.0}/examples/surface_reaction.ipynb +0 -0
  62. {pymrm-2.2.4 → pymrm-2.3.0}/examples/tvd.ipynb +0 -0
  63. {pymrm-2.2.4 → pymrm-2.3.0}/examples/unsteady_convection_reaction.ipynb +0 -0
  64. {pymrm-2.2.4 → pymrm-2.3.0}/examples/unsteady_diffusion_reaction_2D.ipynb +0 -0
  65. {pymrm-2.2.4 → pymrm-2.3.0}/pyproject.toml +0 -0
  66. {pymrm-2.2.4 → pymrm-2.3.0}/requirements.txt +0 -0
  67. {pymrm-2.2.4 → pymrm-2.3.0}/scripts/build_documentation.sh +0 -0
  68. {pymrm-2.2.4 → pymrm-2.3.0}/scripts/run_examples.py +0 -0
  69. {pymrm-2.2.4 → pymrm-2.3.0}/scripts/run_exercises.py +0 -0
  70. {pymrm-2.2.4 → pymrm-2.3.0}/scripts/run_linter.sh +0 -0
  71. {pymrm-2.2.4 → pymrm-2.3.0}/scripts/run_notebook.py +0 -0
  72. {pymrm-2.2.4 → pymrm-2.3.0}/scripts/run_tutorials.py +0 -0
  73. {pymrm-2.2.4 → pymrm-2.3.0}/scripts/run_unit_tests.sh +0 -0
  74. {pymrm-2.2.4 → pymrm-2.3.0}/scripts/split_notebook.py +0 -0
  75. {pymrm-2.2.4 → pymrm-2.3.0}/setup.cfg +0 -0
  76. {pymrm-2.2.4 → pymrm-2.3.0}/src/pymrm/convect.py +0 -0
  77. {pymrm-2.2.4 → pymrm-2.3.0}/src/pymrm/coupling.py +0 -0
  78. {pymrm-2.2.4 → pymrm-2.3.0}/src/pymrm/grid.py +0 -0
  79. {pymrm-2.2.4 → pymrm-2.3.0}/src/pymrm/helpers.py +0 -0
  80. {pymrm-2.2.4 → pymrm-2.3.0}/src/pymrm/interpolate.py +0 -0
  81. {pymrm-2.2.4 → pymrm-2.3.0}/src/pymrm/numjac.py +0 -0
  82. {pymrm-2.2.4 → pymrm-2.3.0}/src/pymrm/operators.py +0 -0
  83. {pymrm-2.2.4 → pymrm-2.3.0}/src/pymrm/solve.py +0 -0
  84. {pymrm-2.2.4 → pymrm-2.3.0}/src/pymrm.egg-info/dependency_links.txt +0 -0
  85. {pymrm-2.2.4 → pymrm-2.3.0}/src/pymrm.egg-info/requires.txt +0 -0
  86. {pymrm-2.2.4 → pymrm-2.3.0}/src/pymrm.egg-info/top_level.txt +0 -0
  87. {pymrm-2.2.4 → pymrm-2.3.0}/test/test_convect.py +0 -0
  88. {pymrm-2.2.4 → pymrm-2.3.0}/test/test_coupling.py +0 -0
  89. {pymrm-2.2.4 → pymrm-2.3.0}/test/test_csr_format.py +0 -0
  90. {pymrm-2.2.4 → pymrm-2.3.0}/test/test_grid.py +0 -0
  91. {pymrm-2.2.4 → pymrm-2.3.0}/test/test_helpers.py +0 -0
  92. {pymrm-2.2.4 → pymrm-2.3.0}/test/test_integration.py +0 -0
  93. {pymrm-2.2.4 → pymrm-2.3.0}/test/test_interpolate.py +0 -0
  94. {pymrm-2.2.4 → pymrm-2.3.0}/test/test_numjac.py +0 -0
  95. {pymrm-2.2.4 → pymrm-2.3.0}/test/test_operators.py +0 -0
  96. {pymrm-2.2.4 → pymrm-2.3.0}/test/test_solve.py +0 -0
  97. {pymrm-2.2.4 → pymrm-2.3.0}/tutorials/diffusion_2D.ipynb +0 -0
  98. {pymrm-2.2.4 → pymrm-2.3.0}/tutorials/diffusion_first_order_kinetics.ipynb +0 -0
  99. {pymrm-2.2.4 → pymrm-2.3.0}/tutorials/diffusion_model_class.ipynb +0 -0
  100. {pymrm-2.2.4 → pymrm-2.3.0}/tutorials/introduction_and_start.ipynb +0 -0
  101. {pymrm-2.2.4 → pymrm-2.3.0}/tutorials/nonlinear_kinetics.ipynb +0 -0
  102. {pymrm-2.2.4 → pymrm-2.3.0}/tutorials/stationary_diffusion.ipynb +0 -0
@@ -1,6 +1,6 @@
1
1
  cff-version: 1.2.0
2
2
  title: "pymrm: Python package for Multiphase Reactor Modeling"
3
- version: "2.2.3"
3
+ version: "2.2.4"
4
4
  message: "If you use pymrm in your work, please cite the version you used."
5
5
  authors:
6
6
  - family-names: Peters
@@ -9,7 +9,7 @@ authors:
9
9
  - family-names: van Sint Annaland
10
10
  given-names: M.
11
11
  orcid: "https://orcid.org/0000-0002-2903-7443"
12
- date-released: "2026-04-17"
12
+ date-released: "2026-06-08"
13
13
  identifiers:
14
14
  - type: doi
15
15
  value: 10.5281/zenodo.17065798
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: pymrm
3
- Version: 2.2.4
3
+ Version: 2.3.0
4
4
  Summary: Functions for multiphase reactor modeling
5
5
  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>
6
6
  Maintainer-email: "E.A.J.F. Peters" <e.a.j.f.peters@tue.nl>
@@ -50,6 +50,13 @@ def run_apidoc(_):
50
50
  docs_dir = Path(__file__).resolve().parent
51
51
  package_dir = docs_dir.parent.parent / 'src' / 'pymrm'
52
52
  apidoc_main(['-f', '-o', str(docs_dir), str(package_dir)])
53
+ package_rst = docs_dir / 'pymrm.rst'
54
+ if package_rst.exists():
55
+ content = package_rst.read_text(encoding='utf-8')
56
+ marker = "\nModule contents\n---------------\n\n.. automodule:: pymrm\n"
57
+ if marker in content:
58
+ content = content.split(marker, 1)[0].rstrip() + "\n"
59
+ package_rst.write_text(content, encoding='utf-8')
53
60
 
54
61
 
55
62
  def setup(app):