Metadata-Version: 2.4
Name: dpm_tools
Version: 1.0.0
Summary: A collection of tools and workflows to streamline the processing and visualization of porous media images.
Author-email: Digital Porous Media <bcchang@utexas.edu>
Project-URL: Homepage, https://github.com/digital-porous-media/
Project-URL: Repository, https://github.com/digital-porous-media/dpm_tools
Project-URL: Issues, https://github.com/digital-porous-media/dpm_tools/issues
Keywords: digital porous media,image analysis
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: matplotlib
Requires-Dist: pyvista[all]
Requires-Dist: pandas
Requires-Dist: tifffile
Requires-Dist: exifread
Requires-Dist: netcdf4
Requires-Dist: h5py
Requires-Dist: porespy
Requires-Dist: edt
Requires-Dist: scikit-fmm
Requires-Dist: connected-components-3d
Requires-Dist: pyfftw
Requires-Dist: wget
Requires-Dist: dpm-srm
Requires-Dist: dpm-srg
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Requires-Dist: sphinx; extra == "dev"
Requires-Dist: black; extra == "dev"
Requires-Dist: codecov; extra == "dev"
Requires-Dist: coverage; extra == "dev"
Requires-Dist: nbval; extra == "dev"
Requires-Dist: pytest; extra == "dev"
Requires-Dist: pytest-cache; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"
Requires-Dist: pytest-custom-exit-code; extra == "dev"
Requires-Dist: pytest-split; extra == "dev"
Provides-Extra: docs
Requires-Dist: trimesh; extra == "docs"
Requires-Dist: scikit-image; extra == "docs"
Requires-Dist: myst-nb; extra == "docs"
Requires-Dist: pydata-sphinx-theme; extra == "docs"
Requires-Dist: sphinx; extra == "docs"
Requires-Dist: sphinx-copybutton; extra == "docs"
Requires-Dist: sphinx-design; extra == "docs"
Requires-Dist: sphinx-autodoc-typehints; extra == "docs"
Dynamic: license-file

# Digital Porous Media (DPM) Tools
Welcome to DPM Tools! Our team at The University of Texas at Austin has put together a collection of Python modules for processing and visualizing porous media images. Integrated as workflows, the combination of all module functions provide end-to-end capabilities that streamline pre- and post- processing of porous media images. Individual and combined functions can be used to curate images for publication, prepare images for simulation and machine learning (ML) applications, and analyze simulation and ML results. 

By design, DPM Tools integrate functions from open Python packages to implement common digital porous media as workflows.

DPM Tools is implemented within the Digital Porous Media Portal (formerly Digital Rocks Portal) and as a standalone image processing workflow that users can download.

Current Modules:
---

- ``Input/Output (IO)``: Tools for reading and writing digital porous media images from raw, tiff, hdf5, netCDF and matlab files. The tools can edit and convert the files. 

- ``Metrics``: includes several functions for quantifying geometric properties of images.

- ``Segmentation``: algorithms for classifying phases within an image.

- ``Visualization``: workflows for 3D visualization with PyVista.

Further documentation and descriptions of how to use the different modules are available in the related links of this document and in the landing page where the software is published in Zenodo. Our team is continuously maintaining the software and adding new modules. 


## Installation
To install from PyPI:

    pip install dpm-tools

## Documentation:
For further information and examples on how to get started, please see our [documentation](https://digital-porous-media.github.io/dpm_tools/html/)
