.. image:: https://github.com/matthiaskoenig/porous_media/raw/main/docs/images/favicon/porous_media-100x100-300dpi.png
:align: left
:alt: porous_media logo
porous_media: python utilities for porous media analysis and visualization
==========================================================================
.. image:: https://github.com/matthiaskoenig/porous_media/workflows/CI-CD/badge.svg
:target: https://github.com/matthiaskoenig/porous_media/workflows/CI-CD
:alt: GitHub Actions CI/CD Status
.. image:: https://img.shields.io/pypi/v/porous_media.svg
:target: https://pypi.org/project/porous_media/
:alt: Current PyPI Version
.. image:: https://img.shields.io/pypi/pyversions/porous_media.svg
:target: https://pypi.org/project/porous_media/
:alt: Supported Python Versions
.. image:: https://img.shields.io/pypi/l/porous_media.svg
:target: http://opensource.org/licenses/LGPL-3.0
:alt: GNU Lesser General Public License 3
.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.8335487.svg
:target: https://doi.org/10.5281/zenodo.8335487
:alt: Zenodo DOI
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/ambv/black
:alt: Black
.. image:: http://www.mypy-lang.org/static/mypy_badge.svg
:target: http://mypy-lang.org/
:alt: mypy
porous_media is a collection of python utilities for working with porous media simulation results and meshes with source code available from
`https://github.com/matthiaskoenig/porous_media <https://github.com/matthiaskoenig/porous_media>`__.
Features include among others
- Visualization of VTK results
- Image processing
- Mesh manipulation
- FEBio helpers
If you have any questions or issues please `open an issue <https://github.com/matthiaskoenig/porous_media/issues>`__.
How to cite
===========
.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.8335487.svg
:target: https://doi.org/10.5281/zenodo.8335487
:alt: Zenodo DOI
Installation
============
`porous_media` is available from `pypi <https://pypi.python.org/pypi/porous_media>`__ and
can be installed via::
pip install porous_media
Required dependencies
----------------------
`porous_media` depends on `ffmpeg <https://ffmpeg.org/>`__ for creation of the videos
which can be installed via on linux via::
sudo apt-get install ffmpeg
Make sure you can execute the following successfully::
ffmpeg
Develop version
---------------
The latest develop version can be installed via::
pip install git+https://github.com/matthiaskoenig/porous_media.git@develop
Or via cloning the repository and installing via::
git clone https://github.com/matthiaskoenig/porous_media.git
cd porous_media
pip install -e .
To install for development use::
pip install -e .[development]
Contributing
============
Contributions are always welcome! Please read the `contributing guidelines
<https://github.com/matthiaskoenig/porous_media/blob/develop/.github/CONTRIBUTING.rst>`__ to
get started.
License
=======
* Source Code: `LGPLv3 <http://opensource.org/licenses/LGPL-3.0>`__
* Documentation: `CC BY-SA 4.0 <http://creativecommons.org/licenses/by-sa/4.0/>`__
The porous_media source is released under both the GPL and LGPL licenses version 2 or
later. You may choose which license you choose to use the software under.
This program is free software: you can redistribute it and/or modify it under
the terms of the GNU General Public License or the GNU Lesser General Public
License as published by the Free Software Foundation, either version 2 of the
License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
PARTICULAR PURPOSE. See the GNU General Public License for more details.
Funding
=======
Matthias König is supported by the Federal Ministry of Education and Research (BMBF, Germany)
within the research network Systems Medicine of the Liver (**LiSyM**, grant number 031L0054)
and by the German Research Foundation (DFG) within the Research Unit Programme FOR 5151
"`QuaLiPerF <https://qualiperf.de>`__ (Quantifying Liver Perfusion-Function Relationship in Complex Resection -
A Systems Medicine Approach)" by grant number 436883643 and by grant number 465194077 (Priority Programme SPP 2311, Subproject SimLivA).
© 2023 Matthias König
Raw data
{
"_id": null,
"home_page": "https://github.com/matthiaskoenig/porous_media",
"name": "porous-media",
"maintainer": "Matthias Koenig",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "konigmatt@googlemail.com",
"keywords": "porous media",
"author": "Matthias Koenig",
"author_email": "konigmatt@googlemail.com",
"download_url": "https://files.pythonhosted.org/packages/8a/70/f1405890f90eb8355a82c18725a485c83ab592aea09ea69d4e7f1edc986b/porous_media-0.2.2.tar.gz",
"platform": null,
"description": ".. image:: https://github.com/matthiaskoenig/porous_media/raw/main/docs/images/favicon/porous_media-100x100-300dpi.png\n :align: left\n :alt: porous_media logo\n\nporous_media: python utilities for porous media analysis and visualization\n==========================================================================\n\n.. image:: https://github.com/matthiaskoenig/porous_media/workflows/CI-CD/badge.svg\n :target: https://github.com/matthiaskoenig/porous_media/workflows/CI-CD\n :alt: GitHub Actions CI/CD Status\n\n.. image:: https://img.shields.io/pypi/v/porous_media.svg\n :target: https://pypi.org/project/porous_media/\n :alt: Current PyPI Version\n\n.. image:: https://img.shields.io/pypi/pyversions/porous_media.svg\n :target: https://pypi.org/project/porous_media/\n :alt: Supported Python Versions\n\n.. image:: https://img.shields.io/pypi/l/porous_media.svg\n :target: http://opensource.org/licenses/LGPL-3.0\n :alt: GNU Lesser General Public License 3\n\n.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.8335487.svg\n :target: https://doi.org/10.5281/zenodo.8335487\n :alt: Zenodo DOI\n\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/ambv/black\n :alt: Black\n\n.. image:: http://www.mypy-lang.org/static/mypy_badge.svg\n :target: http://mypy-lang.org/\n :alt: mypy\n\nporous_media is a collection of python utilities for working with porous media simulation results and meshes with source code available from \n`https://github.com/matthiaskoenig/porous_media <https://github.com/matthiaskoenig/porous_media>`__.\n\nFeatures include among others\n\n- Visualization of VTK results\n- Image processing\n- Mesh manipulation\n- FEBio helpers\n \nIf you have any questions or issues please `open an issue <https://github.com/matthiaskoenig/porous_media/issues>`__.\n\nHow to cite\n===========\n\n.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.8335487.svg\n :target: https://doi.org/10.5281/zenodo.8335487\n :alt: Zenodo DOI\n\nInstallation\n============\n`porous_media` is available from `pypi <https://pypi.python.org/pypi/porous_media>`__ and \ncan be installed via:: \n\n pip install porous_media\n\nRequired dependencies\n----------------------\n`porous_media` depends on `ffmpeg <https://ffmpeg.org/>`__ for creation of the videos \nwhich can be installed via on linux via::\n\n sudo apt-get install ffmpeg\n \nMake sure you can execute the following successfully:: \n\n ffmpeg\n\nDevelop version\n---------------\nThe latest develop version can be installed via::\n\n pip install git+https://github.com/matthiaskoenig/porous_media.git@develop\n\nOr via cloning the repository and installing via::\n\n git clone https://github.com/matthiaskoenig/porous_media.git\n cd porous_media\n pip install -e .\n\nTo install for development use::\n\n pip install -e .[development]\n\n\nContributing\n============\n\nContributions are always welcome! Please read the `contributing guidelines\n<https://github.com/matthiaskoenig/porous_media/blob/develop/.github/CONTRIBUTING.rst>`__ to\nget started.\n\nLicense\n=======\n\n* Source Code: `LGPLv3 <http://opensource.org/licenses/LGPL-3.0>`__\n* Documentation: `CC BY-SA 4.0 <http://creativecommons.org/licenses/by-sa/4.0/>`__\n\nThe porous_media source is released under both the GPL and LGPL licenses version 2 or\nlater. You may choose which license you choose to use the software under.\n\nThis program is free software: you can redistribute it and/or modify it under\nthe terms of the GNU General Public License or the GNU Lesser General Public\nLicense as published by the Free Software Foundation, either version 2 of the\nLicense, or (at your option) any later version.\n\nThis program is distributed in the hope that it will be useful, but WITHOUT ANY\nWARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A\nPARTICULAR PURPOSE. See the GNU General Public License for more details.\n\nFunding\n=======\nMatthias K\u00f6nig is supported by the Federal Ministry of Education and Research (BMBF, Germany)\nwithin the research network Systems Medicine of the Liver (**LiSyM**, grant number 031L0054) \nand by the German Research Foundation (DFG) within the Research Unit Programme FOR 5151 \n\"`QuaLiPerF <https://qualiperf.de>`__ (Quantifying Liver Perfusion-Function Relationship in Complex Resection - \nA Systems Medicine Approach)\" by grant number 436883643 and by grant number 465194077 (Priority Programme SPP 2311, Subproject SimLivA).\n\n\u00a9 2023 Matthias K\u00f6nig\n",
"bugtrack_url": null,
"license": "LGPL-3.0",
"summary": "python package working with porous media",
"version": "0.2.2",
"project_urls": {
"Bug Tracker": "https://github.com/matthiaskoenig/porous_media/issues",
"Documentation": "https://github.com/matthiaskoenig/porous_media",
"Download": "https://pypi.org/project/porous_media",
"Homepage": "https://github.com/matthiaskoenig/porous_media",
"Source Code": "https://github.com/matthiaskoenig/porous_media"
},
"split_keywords": [
"porous",
"media"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ca7c903a2caba3e4cdd4b4d5e84ade8a3acdbbe1b41a708edee0abe2e551673f",
"md5": "12da4d71ed033b37388133e81b073340",
"sha256": "a0e433eb1b94372c0b7b0bfc4a0358a26b55c43a1d316daeeb103935d4367d28"
},
"downloads": -1,
"filename": "porous_media-0.2.2-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "12da4d71ed033b37388133e81b073340",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.9",
"size": 1131000,
"upload_time": "2024-02-01T21:24:08",
"upload_time_iso_8601": "2024-02-01T21:24:08.184433Z",
"url": "https://files.pythonhosted.org/packages/ca/7c/903a2caba3e4cdd4b4d5e84ade8a3acdbbe1b41a708edee0abe2e551673f/porous_media-0.2.2-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8a70f1405890f90eb8355a82c18725a485c83ab592aea09ea69d4e7f1edc986b",
"md5": "b333a85949aeb2c2690f7922e0283b1a",
"sha256": "2db584a8edd8837e5b4a93ec4f9fdcefa46f44db75ababf2d2ec8ec2e8edf86e"
},
"downloads": -1,
"filename": "porous_media-0.2.2.tar.gz",
"has_sig": false,
"md5_digest": "b333a85949aeb2c2690f7922e0283b1a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 1128001,
"upload_time": "2024-02-01T21:24:10",
"upload_time_iso_8601": "2024-02-01T21:24:10.715077Z",
"url": "https://files.pythonhosted.org/packages/8a/70/f1405890f90eb8355a82c18725a485c83ab592aea09ea69d4e7f1edc986b/porous_media-0.2.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-01 21:24:10",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "matthiaskoenig",
"github_project": "porous_media",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "porous-media"
}
JSON
