Getting Started

Welcome to Digital Porous Media (DPM) Tools Documentation! DPM Tools is a collection of Python tools and workflows to help streamline analysis of digital porous media images.

See our group’s online repository, Digital Porous Media Portal for an excellent source of data to use these tools with!

Installation

The only prerequisite for installing DPM Tools is Python. We recommend you use the Anaconda Distribution.

Install via Pip

PyVista can be installed via pip from PyPI.

pip install dpm-tools

More Instructions

For more detailed installation instructions, including installing optional dependencies, check out the Installing DPM Tools page.

Installing DPM Tools

Tutorials

We have provided a variety of notebook tutorials for you to get started using DPM Tools workflows!

Tutorial

The best place to get started is our tutorial.

https://digital-porous-media.github.io/dpm_tools/html/tutorials/index.html

Authors

Authors & Citation

We gratefully acknowledge all the contributors that make DPM Tools possible. Please consider citing us if you use DPM Tools in your research.

Authors

Support

We are actively developing and making improvements to our project. If you encounter any issues (or if you’d just like to chat), please open an issue in dpm_tools/issues.