Skip to content
forked from PMEAL/OpenPNM

A Python package for performing pore network modeling of porous media

License

Notifications You must be signed in to change notification settings

mzdreambig/OpenPNM

 
 

Repository files navigation


WARNING: The dev branch is now highly backwards incompatible with V2! We have made some MAJOR changes that will dramatically improve the usage and maintainability of OpenPNM moving forward, but it required breaking things. Specifically, we have removed the concept of Geometry and Physics objects. All simulations now require just Networks and Phases. We are working feverishly to get this transition finalized and to update the documentation accordingly, but remember we are a small team with lots of other things distracting us. Thanks for your patience.

Overview of OpenPNM

OpenPNM is a comprehensive framework for performing pore network simulations of porous materials.

More Information

For more details about the package can be found in the on-line documentation

Installation and Requirements

Preferred method

The preferred way of installing OpenPNM is through Anaconda Cloud using:

conda install -c conda-forge openpnm

Alternative method

OpenPNM can also be installed from the Python Package Index using:

pip install openpnm

However, we don't recommend installing using pip since pypardiso, which is a blazing fast direct solver, is not available for Windows users who use Python 3.7+.

For developers

For developers who intend to change the source code or contribute to OpenPNM, the source code can be downloaded from Github and installed by running:

pip install -e 'path/to/downloaded/files'

The advantage to installing from the source code is that you can edit the files and have access to your changes each time you import OpenPNM.

OpenPNM requires the Scipy Stack (Numpy, Scipy, Matplotlib, etc), which is most conveniently obtained by installing the Anaconda Distribution.

Asking Questions and Getting Help

Github now has a Discussions function, which works similarly to stack overflow. Please post your question in the Q&A category so devs or users can provide answers, vote on accepted answers, improve on each other's answers, and generally discuss things. Most importantly, all answers are searchable so eventually, once enough questions have been posted and answered, you can find what you're looking for with a simple search.

Contact

OpenPNM is developed by the Porous Materials Engineering and Analysis Lab (PMEAL), in the Department of Chemical Engineering at the University of Waterloo in Waterloo, Ontario, Canada.

The lead developer for this project is Prof. Jeff Gostick ([email protected]).

Acknowledgements

OpenPNM is grateful to CANARIE for their generous funding over the past few years. We would also like to acknowledge the support of NSERC of Canada for funding many of the student that have contributed to OpenPNM since it's inception in 2011.

Citation

If you use OpenPNM in a publication, please cite the following paper:

Gostick et al. "OpenPNM: a pore network modeling package." Computing in Science & Engineering 18, no. 4 (2016): 60-74. doi:10.1109/MCSE.2016.49

Also, we ask that you "star" ⭐ this repository so we can track the number of users who are interested in this project, which is helpful for securing future grant funding.

About

A Python package for performing pore network modeling of porous media

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 99.6%
  • Other 0.4%