Installation

The OpenPNM and PoreSpy libraries are required to analyze XCT images. PoreSpy is used to generate a pore network that is used to extract pore size distribution, pore throat size distribution, and pore coordination numbers. OpenPNM is used to construct a new 2D pore network that will be used to create the micromodel design.

Pip Installation

Install using PiP:

pip install pore2chip

Install from source:

git clone https://github.com/EMSL-Computing/Pore2Chip.git
cd Pore2Chip
python3 -m build
python3 -m pip install pore2chip --no-index --find-links dist/

Conda Environment

Creating a Conda environment:

conda create -n pore2chip python=3.9
conda activate pore2chip
pip install pore2chip

Docker Image

Building a Docker Image with Jupyter Notebook:

git clone https://github.com/EMSL-Computing/Pore2Chip.git
cd Pore2Chip
docker build -t pore2chip
docker run -p 8888:8888 pore2chip

This will automatically run a Jupyter Notebook server in the browser with a python environment that has Pore2Chip and all of its dependencies installed.

Note

This project is under active development.

On this page