Overview
PoreSpy is a collection of image analysis tools used to extract information from 3D images of porous materials (typically obtained from X-ray tomography). There are many packages that offer generalized image analysis tools (i.e Skimage and Scipy.NDimage in the Python environment, ImageJ, MatLab's Image Processing Toolbox), but they all require building up complex scripts or macros to accomplish tasks of specific use to porous media. The aim of PoreSpy is to provide a set of pre-written tools for all the common porous media measurements.
PoreSpy relies heavily on scipy.ndimage and scikit-image also known as skimage. The former contains an assortment of general image analysis tools such as image morphology filters, while the latter offers more complex but still general functions such as watershed segmentation. PoreSpy tries not to duplicate any of these general functions so you will also have to install and learn how to use them to get the most from PoreSpy. The functions in PoreSpy are generally built up using several of the general functions offered by skimage and scipy. There are a few functions in PoreSpy that are implemented natively, but only when necessary.
Capabilities
PoreSpy consists of the following modules:
generators: Routines for generating artificial images of porous materials useful for testing and illustrationfilters: Functions that accept an image and return an altered imagemetrics: Tools for quantifying properties of imagesnetworks: Algorithms and tools for analyzing images as pore networkssimulations: Physical simulations on images including drainagevisualization: Helper functions for creating useful views of the imageio: Functions for outputting image data in various formats for use in common softwaretools: Various useful tools for working with images
Gallery
Cite as
Gostick J, Khan ZA, Tranter TG, Kok MDR, Agnaou M, Sadeghi MA, Jervis R. PoreSpy: A Python Toolkit for Quantitative Analysis of Porous Media Images. Journal of Open Source Software, 2019. doi:10.21105/joss.01296
Installation
For detailed and up to date installation instructions, see here
Contributing
If you think you may be interested in contributing to PoreSpy and wish to both use and edit the source code, then you should clone the repository to your local machine, and install it using the following PIP command:
pip install -e "C:\path\to\the\local\files\"
For information about contributing, refer to the contributors guide
Acknowledgements
PoreSpy is grateful to CANARIE for their generous funding over the past few years. We would also like to acknowledge the support of NSERC of Canada for funding many of the student that have contributed to PoreSpy since it's inception in 2014.
Examples
A set of examples is included in this repo, and can be browsed here.
2 maintainers
Metadata
2 maintainers
Release files for porespy 3.2.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| porespy-3.2.0.tar.gz | 66.5 MB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| porespy-3.2.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 66.7 MB
Release files / porespy-3.2.0.tar.gz
| Download URL | porespy-3.2.0.tar.gz |
|---|---|
| Size | 66.5 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c61b1ce119e6cd4881164cbd9981196d3991e1ac8adc067c6ae0aca2342ee3f9
|
|
BLAKE2b-256 checksum How to use checksums |
4e8b17dfdcd0bcec5436f6164b6cf0e18d053b7a90c39961505a471d0ea1ce35
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
Hatch/1.16.2 cpython/3.13.16 HTTPX/0.28.1
|
Release files / porespy-3.2.0-py3-none-any.whl
| Download URL | porespy-3.2.0-py3-none-any.whl |
|---|---|
| Size | 252.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
92eb9e9bc069c77428159cfc4373c8ba18958a4fb16f575df6b105aba30a5d52
|
|
BLAKE2b-256 checksum How to use checksums |
cd31322eb764600bdf7e695201fe24b4e42d9422025f248ea69e6b0761148f64
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
Hatch/1.16.2 cpython/3.13.16 HTTPX/0.28.1
|
Security for porespy 3.2.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
