OpenPNM

Contents

• What is OpenPNM?
• Installation
• Documentation
• Web Sites
• Communication
• Latest source code
• Bug reports
• Developer information
• License information

What is OpenPNM?

OpenPNM is an open-source framework for performing pore network modeling simulations of multiphase transport in porous materials. It includes modules for generating various common network topologies, pore and throat geometry models, pore scale physics models, and fluid property estimation. It also contains a growing set of algorithms for running various simulations such drainage curves, gas diffusion, permeability, and more.

OpenPNM is written in Python making extensive use of Scipy. Python is a very flexible object oriented programming language that will be familiar to those with experience using Matlab. OpenPNM takes advantages of the OOP paradigm to structure the framework, but uses conventional numerical arrays to store data and perform calculations. Our goal is to help other scientists and engineers harness the power and intuitive pore network modeling approach, so if you are interested in this package, please contact us through Github, or email one of the developer directly.

Installation

OpenPNM is available on they Python Pacakage Index (PyPI). If you have pip installed you can get the latest stable version using:

pip install openpnm

Documentation

OpenPNM documentation is available on the web:

http://openpnm.org/docs

Web Sites

The main project website is:

http://openpnm.org

Communication

For information on the latest releases and other important events, join the OpenPNM mailing list:

http://openpnm.org/news

If you require help on any aspect of OpenPNM, contact us on Gitter:

https://gitter.im/PMEAL/OpenPNM

Latest source code

The latest development version of OpenPNM sources are always available at:

https://github.com/PMEAL/OpenPNM

They can be downloaded as a zip file or using the Git client. Alternatively, you can use pip to install straight from the Git repo using:

pip install https://github.com/pmeal/openpnm/archive/master.zip

Bug reports

To search for bugs or report them, please use the OpenPNM Bug Tracker at:

https://github.com/PMEAL/OpenPNM/issues

Developer information

If you would like to take part in OpenPNM development, please join the discussion on Github, or Gitter. We are a small group and can guide you directly.

Please see the developer's discussion on Gitter:

https://gitter.im/PMEAL/OpenPNM

License information

See the file LICENSE.txt for information on the history of this software, terms & conditions for usage, and a DISCLAIMER OF ALL WARRANTIES.