OpenPNM: A Pore Network Modeling Package

TLDR

Pore network modeling is widely used for simulating multiphase transport in porous materials, yet few software options are available. The authors present OpenPNM, a pore‑network modeling package developed collaboratively to fill this software gap. OpenPNM is a Python library built on NumPy and SciPy that manages pore‑network topology, geometry, and physics, offers standard percolation and transport algorithms, and is designed for high flexibility and user customization. The framework is fast, powerful, and concise, as shown by an example that computes effective diffusivity in a partially water‑saturated porous material with only 29 lines of code.

Abstract

Pore network modeling is a widely used technique for simulating multiphase transport in porous materials, but there are very few software options available. This work outlines the OpenPNM package that was jointly developed by several porous media research groups to help address this gap. OpenPNM is written in Python using NumPy and SciPy for most mathematical operations, thus combining Python's ease of use with the performance necessary to perform large simulations. The package assists the user with managing and interacting with all the topological, geometrical, and thermophysical data. It also includes a suite of commonly used algorithms for simulating percolation and performing transport calculations on pore networks. Most importantly, it was designed to be highly flexible to suit any application and be easily customized to include user-specified pore-scale physics models. The framework is fast, powerful, and concise. An illustrative example is included that determines the effective diffusivity through a partially water-saturated porous material with just 29 lines of code.