Skip to main content

A framework for conducting pore network modeling simulations of multiphase transport in porous materials.

Project description

OpenPNM
=======

.. image:: https://travis-ci.org/PMEAL/OpenPNM.svg?branch=develop
:target: https://travis-ci.org/PMEAL/OpenPNM
.. image:: https://coveralls.io/repos/PMEAL/OpenPNM/badge.svg
:target: https://coveralls.io/r/PMEAL/OpenPNM
.. image:: https://badges.gitter.im/Join%20Chat.svg
:alt: Join the chat at https://gitter.im/PMEAL/OpenPNM
:target: https://gitter.im/PMEAL/OpenPNM?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge

.. contents::

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. 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
------------

.. code-block:: python

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.


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.

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for openpnm, version 1.2.0
Filename, size File type Python version Upload date Hashes
Filename, size OpenPNM-1.2.0.tar.gz (147.0 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page