Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
BC-Chang committed Nov 27, 2024
1 parent 0383dd7 commit 3dfbfc1
Showing 1 changed file with 24 additions and 12 deletions.
36 changes: 24 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,25 @@
# Digital Porous Media (DPM) Tools
A set of tools to process and analyze digital porous media

Docs:
[https://digital-porous-media.github.io/dpm_tools/html/](https://digital-porous-media.github.io/dpm_tools/html/)

TODO:
- Reading and Writing in data files
- Reading data from DRP
- Computing morphological features
- Segmentation widget
- Visualization tools
- Filtering
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/)



0 comments on commit 3dfbfc1

Please sign in to comment.