Skip to content

HaroldDay/OpenPNM

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

OpenPNM

What is OpenPNM? --------------

OpenPNM is open-source framework for conducting 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 large 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 we stress that it is coded by engineers without significant prior knowledge of object-oriented coding. 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

For installation instructions, see INSTALL.txt.

Documentation

OpenPNM documentation is available on the web:

http://openpnm.org

Web sites

The user's site is:

http://openpnm.org

Mailing Lists

Please see the developer's discussion on GitHub:

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

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.

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. We are a small group and can guide you directly.

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.

About

A Python-based package for performing pore network modeling of porous media

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 91.2%
  • CSS 7.5%
  • Shell 1.3%