pymrm 1.3.0__tar.gz

pymrm-1.3.0/.gitignore

@@ -0,0 +1,5 @@
+build/
+_*/
+dist/
+.ipynb_checkpoints/
+py_mrm.egg-info/

pymrm-1.3.0/.vscode/settings.json

@@ -0,0 +1,6 @@
+{
+    "python.pythonPath": "D:\\Users\\eajfpeters\\Anaconda3\\python.exe",
+    "python.terminal.activateEnvironment": true,
+    "terminal.integrated.shell.windows": "C:\\Windows\\System32\\cmd.exe",
+    "cmake.configureOnOpen": false,
+}

pymrm-1.3.0/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

pymrm-1.3.0/PKG-INFO

@@ -0,0 +1,44 @@
+Metadata-Version: 2.1
+Name: pymrm
+Version: 1.3.0
+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>
+Project-URL: Homepage, https://gitlab.tue.nl/SMM/research_projects/eajfpeters/pymrm/
+Project-URL: Repository, https://gitlab.tue.nl/SMM/research_projects/eajfpeters/pymrm/
+Keywords: MRM,modeling,multiphase,diffusion,convection
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python
+Classifier: License :: OSI Approved :: MIT License
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: numpy
+Requires-Dist: scipy
+
+# pymrm: Python Package for Multiphase Reactor Modeling
+
+## Overview
+
+Welcome to pymrm, a Python package designed for creating phenomenological models of multiphase reactors. Developed within the ambit of the Multiphase Reactor Modeling course at Eindhoven University of Technology, this package finds its roots in the Department of Chemical Engineering and Chemistry taught by Martin van Sint Annaland and Frank Peters. Originally implemented in Matlab, pymrm stands today as a port to Python, signifying a step forward in accessibility and open access.
+
+## Getting Started
+
+To get a comprehensive understanding of pymrm's capabilities, we recommend exploring the included Jupyter notebook. This notebook is packed with examples that demonstrate the application of the package in the realm of chemical engineering.
+
+### Features
+
+- Comprehensive set of functions for modeling multiphase reactors
+- User-friendly interface tailored for both students and professionals
+- Extensive documentation and example-based learning
+
+### How to Install
+
+pip install pymrm
+
+### Quickstart Guide
+
+Start implementing 1D reaction-diffusion equations, proceed to convection, different phases, mass transfer, etc. The Python notebook: py_mrm_examples.ipynb provides examples that are useful to get you started.
+
+### Contributing
+
+We welcome contributions from the community. If you're interested in enhancing pymrm or have suggestions, please contact us.

pymrm-1.3.0/README.md

@@ -0,0 +1,27 @@
+# pymrm: Python Package for Multiphase Reactor Modeling
+
+## Overview
+
+Welcome to pymrm, a Python package designed for creating phenomenological models of multiphase reactors. Developed within the ambit of the Multiphase Reactor Modeling course at Eindhoven University of Technology, this package finds its roots in the Department of Chemical Engineering and Chemistry taught by Martin van Sint Annaland and Frank Peters. Originally implemented in Matlab, pymrm stands today as a port to Python, signifying a step forward in accessibility and open access.
+
+## Getting Started
+
+To get a comprehensive understanding of pymrm's capabilities, we recommend exploring the included Jupyter notebook. This notebook is packed with examples that demonstrate the application of the package in the realm of chemical engineering.
+
+### Features
+
+- Comprehensive set of functions for modeling multiphase reactors
+- User-friendly interface tailored for both students and professionals
+- Extensive documentation and example-based learning
+
+### How to Install
+
+pip install pymrm
+
+### Quickstart Guide
+
+Start implementing 1D reaction-diffusion equations, proceed to convection, different phases, mass transfer, etc. The Python notebook: py_mrm_examples.ipynb provides examples that are useful to get you started.
+
+### Contributing
+
+We welcome contributions from the community. If you're interested in enhancing pymrm or have suggestions, please contact us.

pymrm-1.3.0/conf.py

@@ -0,0 +1,54 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+import os
+import sys
+sys.path.insert(0, os.path.abspath('.'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'pymrm'
+copyright = '2023, E.A.J.F. Peters'
+author = 'E.A.J.F. Peters'
+
+# The full version, including alpha/beta/rc tags
+release = '1.3.0'
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = ['sphinx.ext.autodoc']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'sphinx_rtd_theme' 
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']

pymrm-1.3.0/conf.rst

@@ -0,0 +1,7 @@
+conf module
+===========
+
+.. automodule:: conf
+   :members:
+   :undoc-members:
+   :show-inheritance:

pymrm-1.3.0/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

pymrm-1.3.0/modules.rst

@@ -0,0 +1,6 @@
+Codes
+=====
+
+.. toctree::
+   :maxdepth: 4
+

pymrm-1.3.0/pymrm/__init__.py

@@ -0,0 +1 @@
+from .pymrm import construct_grad, construct_grad_int, construct_grad_bc, construct_div, construct_convflux_upwind, construct_convflux_upwind_int, construct_convflux_upwind_bc, construct_coefficient_matrix, numjac_local, newton, clip_approach, non_uniform_grid, interp_stagg_to_cntr, interp_cntr_to_stagg, interp_cntr_to_stagg_tvd, upwind, minmod, osher, clam, muscl, smart, stoic, vanleer