From 3dfbfc1db602ad1d542da0ed78e2787f6f89c60b Mon Sep 17 00:00:00 2001 From: Bernard Chang Date: Wed, 27 Nov 2024 09:38:21 -0600 Subject: [PATCH] Update readme --- README.md | 36 ++++++++++++++++++++++++------------ 1 file changed, 24 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 0ed808f..45022fb 100644 --- a/README.md +++ b/README.md @@ -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 `_, 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/) + + +