Metadata-Version: 2.1
Name: dpm_tools
Version: 0.0.2
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"

# 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 tools and workflows to help streamline analysis of digital porous media images. 

Our intent is for these tools to be used with our group's online repository, `Digital Rocks Portal <https://www.digitalrocksportal.org/>`_, an excellent source of data! The Portal is currently undergoing redesign, but we are excited to unveil it with these integrated tools in early 2025!

## Capabilities
The Digital Porous Media team is working hard on adding new features and making improvements to this toolbox. So far, DPM Tools is comprised of the following modules:

- ```io```: Tools for obtaining, reading, and writing digital porous media images in a variety of file formats.
- ```metrics```: Functions for quantifying geometric properties of images
- ```segmentation```: Algorithms for classifying phases within an image
- ```visualization```: Workflows for 3D visualization

The goal of this project is to gather tools that are commonly used in digital porous media analysis, not to reinvent the wheel. By design, we tried to only build functions and workflows that are not readily available in other Python packages. If you have any requests for new features, please feel free to reach out!

## Installation
To install from PyPI:

    pip install dpm-tools

## Docs:
For examples on getting started, please see our [documentation](https://digital-porous-media.github.io/dpm_tools/html/)
