pymrm


Namepymrm JSON
Version 2.1.19 PyPI version JSON
download
home_pageNone
SummaryFunctions for multiphase reactor modeling
upload_time2025-09-06 21:10:07
maintainerNone
docs_urlNone
authorNone
requires_python>=3.10
licenseMIT License Copyright (c) 2025 E.A.J.F. Peters Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords mrm modeling multiphase diffusion convection
VCS
bugtrack_url
requirements pip numpy scipy numba pandas matplotlib ipython ipykernel pytest pytest-cov sphinx sphinx_rtd_theme nbclient myst-parser
Travis-CI No Travis.
coveralls test coverage
            # pymrm: Python Package for Multiphase Reactor Modeling

[![CI](https://github.com/multiscale-modelling-multiphase-flows/pymrm/actions/workflows/test.yml/badge.svg)](https://github.com/multiscale-modelling-multiphase-flows/pymrm/actions/workflows/test.yml)
[![PyPI](https://img.shields.io/pypi/v/pymrm.svg)](https://pypi.org/project/pymrm/)
[![Python](https://img.shields.io/pypi/pyversions/pymrm.svg)](https://pypi.org/project/pymrm/)
[![License](https://img.shields.io/github/license/multiscale-modelling-multiphase-flows/pymrm)](https://github.com/multiscale-modelling-multiphase-flows/pymrm/blob/main/LICENSE)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![DOI](https://zenodo.org/badge/901029258.svg)](https://zenodo.org/badge/latestdoi/901029258)


## Overview

pymrm is a Python package for modeling multiphase reactors, developed as part of the Multiphase Reactor Modeling course at Eindhoven University of Technology. Originally implemented in Matlab, pymrm is now a Python-based, open-access tool designed for accessibility and advanced modeling.

## Features

- Tools for modeling diffusion, convection, reaction, and mass transfer.
- User-friendly interface for students and professionals.
- Extensive documentation and example-based learning.

## Installation

Install pymrm directly from PyPI:
```sh
pip install pymrm
```

For detailed instructions, see the [Installation Guide](https://github.com/multiscale-modelling-multiphase-flows/pymrm/blob/main/docs/installation.md).

## Quickstart

Start with the tutorials in the [`tutorials`](https://github.com/multiscale-modelling-multiphase-flows/pymrm/tree/main/tutorials) folder to learn the basics of pymrm. Then, explore the [`examples`](https://github.com/multiscale-modelling-multiphase-flows/pymrm/tree/main/examples) folder for more advanced use cases, including modeling diffusion, convection, and reaction processes.

For extensive documentation, exercises, and additional resources, visit the [PyMRM documentation site](https://multiscale-modelling-multiphase-flows.github.io/pymrm-book).

## Helper utilities

Small building blocks used throughout the package are documented in
[`docs/helpers.md`](docs/helpers.md). These utilities assist with
handling boundary-condition coefficients and constructing sparse
coefficient matrices.

## Contributing

Contributions are welcome! For suggestions or enhancements, please contact us or submit a pull request.


            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "pymrm",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": "\"E.A.J.F. Peters\" <e.a.j.f.peters@tue.nl>",
    "keywords": "MRM, modeling, multiphase, diffusion, convection",
    "author": null,
    "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>",
    "download_url": "https://files.pythonhosted.org/packages/8a/c0/6bc421f6826d5423191cda72b80caf4534195ffd64327ead242c8f03f087/pymrm-2.1.19.tar.gz",
    "platform": null,
    "description": "# pymrm: Python Package for Multiphase Reactor Modeling\n\n[![CI](https://github.com/multiscale-modelling-multiphase-flows/pymrm/actions/workflows/test.yml/badge.svg)](https://github.com/multiscale-modelling-multiphase-flows/pymrm/actions/workflows/test.yml)\n[![PyPI](https://img.shields.io/pypi/v/pymrm.svg)](https://pypi.org/project/pymrm/)\n[![Python](https://img.shields.io/pypi/pyversions/pymrm.svg)](https://pypi.org/project/pymrm/)\n[![License](https://img.shields.io/github/license/multiscale-modelling-multiphase-flows/pymrm)](https://github.com/multiscale-modelling-multiphase-flows/pymrm/blob/main/LICENSE)\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n[![DOI](https://zenodo.org/badge/901029258.svg)](https://zenodo.org/badge/latestdoi/901029258)\n\n\n## Overview\n\npymrm is a Python package for modeling multiphase reactors, developed as part of the Multiphase Reactor Modeling course at Eindhoven University of Technology. Originally implemented in Matlab, pymrm is now a Python-based, open-access tool designed for accessibility and advanced modeling.\n\n## Features\n\n- Tools for modeling diffusion, convection, reaction, and mass transfer.\n- User-friendly interface for students and professionals.\n- Extensive documentation and example-based learning.\n\n## Installation\n\nInstall pymrm directly from PyPI:\n```sh\npip install pymrm\n```\n\nFor detailed instructions, see the [Installation Guide](https://github.com/multiscale-modelling-multiphase-flows/pymrm/blob/main/docs/installation.md).\n\n## Quickstart\n\nStart with the tutorials in the [`tutorials`](https://github.com/multiscale-modelling-multiphase-flows/pymrm/tree/main/tutorials) folder to learn the basics of pymrm. Then, explore the [`examples`](https://github.com/multiscale-modelling-multiphase-flows/pymrm/tree/main/examples) folder for more advanced use cases, including modeling diffusion, convection, and reaction processes.\n\nFor extensive documentation, exercises, and additional resources, visit the [PyMRM documentation site](https://multiscale-modelling-multiphase-flows.github.io/pymrm-book).\n\n## Helper utilities\n\nSmall building blocks used throughout the package are documented in\n[`docs/helpers.md`](docs/helpers.md). These utilities assist with\nhandling boundary-condition coefficients and constructing sparse\ncoefficient matrices.\n\n## Contributing\n\nContributions are welcome! For suggestions or enhancements, please contact us or submit a pull request.\n\n",
    "bugtrack_url": null,
    "license": "MIT License\n        \n        Copyright (c) 2025 E.A.J.F. Peters\n        \n        Permission is hereby granted, free of charge, to any person obtaining a copy\n        of this software and associated documentation files (the \"Software\"), to deal\n        in the Software without restriction, including without limitation the rights\n        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n        copies of the Software, and to permit persons to whom the Software is\n        furnished to do so, subject to the following conditions:\n        \n        The above copyright notice and this permission notice shall be included in all\n        copies or substantial portions of the Software.\n        \n        THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n        SOFTWARE.",
    "summary": "Functions for multiphase reactor modeling",
    "version": "2.1.19",
    "project_urls": {
        "Homepage": "https://multiscale-modelling-multiphase-flows.github.io/pymrm-book",
        "Repository": "https://github.com/multiscale-modelling-multiphase-flows/pymrm"
    },
    "split_keywords": [
        "mrm",
        " modeling",
        " multiphase",
        " diffusion",
        " convection"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "e8098c1200eb191b0253bb76f378f4a4ef9547e9662ddcefbc5f89ceccc95c53",
                "md5": "e5a76a61f2b6d8b58e6e451e03d0c3bb",
                "sha256": "bb5704569e9d3af54c54440744530f9bcd08a16e1e69287ad3f0da07c55eb311"
            },
            "downloads": -1,
            "filename": "pymrm-2.1.19-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "e5a76a61f2b6d8b58e6e451e03d0c3bb",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 33020,
            "upload_time": "2025-09-06T21:10:06",
            "upload_time_iso_8601": "2025-09-06T21:10:06.544557Z",
            "url": "https://files.pythonhosted.org/packages/e8/09/8c1200eb191b0253bb76f378f4a4ef9547e9662ddcefbc5f89ceccc95c53/pymrm-2.1.19-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "8ac06bc421f6826d5423191cda72b80caf4534195ffd64327ead242c8f03f087",
                "md5": "dd6655e07dea35319af9e93bf11c5d0e",
                "sha256": "2b0d82e5f6eb101e2db19e1ad0371628450d266099385c7ee78a0b2da00ca022"
            },
            "downloads": -1,
            "filename": "pymrm-2.1.19.tar.gz",
            "has_sig": false,
            "md5_digest": "dd6655e07dea35319af9e93bf11c5d0e",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 798952,
            "upload_time": "2025-09-06T21:10:07",
            "upload_time_iso_8601": "2025-09-06T21:10:07.828815Z",
            "url": "https://files.pythonhosted.org/packages/8a/c0/6bc421f6826d5423191cda72b80caf4534195ffd64327ead242c8f03f087/pymrm-2.1.19.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-09-06 21:10:07",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "multiscale-modelling-multiphase-flows",
    "github_project": "pymrm",
    "travis_ci": false,
    "coveralls": true,
    "github_actions": true,
    "requirements": [
        {
            "name": "pip",
            "specs": [
                [
                    ">=",
                    "24.0"
                ]
            ]
        },
        {
            "name": "numpy",
            "specs": [
                [
                    ">=",
                    "1.26"
                ]
            ]
        },
        {
            "name": "scipy",
            "specs": [
                [
                    ">=",
                    "1.13"
                ]
            ]
        },
        {
            "name": "numba",
            "specs": [
                [
                    ">=",
                    "0.58"
                ]
            ]
        },
        {
            "name": "pandas",
            "specs": [
                [
                    ">=",
                    "2.2"
                ]
            ]
        },
        {
            "name": "matplotlib",
            "specs": [
                [
                    ">=",
                    "3.8"
                ]
            ]
        },
        {
            "name": "ipython",
            "specs": [
                [
                    ">=",
                    "8.20"
                ]
            ]
        },
        {
            "name": "ipykernel",
            "specs": [
                [
                    ">=",
                    "6.28"
                ]
            ]
        },
        {
            "name": "pytest",
            "specs": [
                [
                    ">=",
                    "8.3.4"
                ]
            ]
        },
        {
            "name": "pytest-cov",
            "specs": []
        },
        {
            "name": "sphinx",
            "specs": []
        },
        {
            "name": "sphinx_rtd_theme",
            "specs": []
        },
        {
            "name": "nbclient",
            "specs": []
        },
        {
            "name": "myst-parser",
            "specs": []
        }
    ],
    "lcname": "pymrm"
}
        
Elapsed time: 9.89814s