Skip to main content

python package working with porous media

Project description

porous_media logo

porous_media: python utilities for porous media analysis and visualization

GitHub Actions CI/CD Status Current PyPI Version Supported Python Versions GNU Lesser General Public License 3 Zenodo DOI Black 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.

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.

How to cite

Zenodo DOI

Installation

porous_media is available from pypi and can be installed via:

pip install porous_media

Required dependencies

porous_media depends on ffmpeg 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 to get started.

License

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 (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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

porous_media-0.2.2.tar.gz (1.1 MB view hashes)

Uploaded source

Built Distribution

porous_media-0.2.2-py2.py3-none-any.whl (1.1 MB view hashes)

Uploaded py2 py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page