.. module:: openpnm :noindex:
OpenPNM is an open source project to provide porous media researchers with a ready-made framework for performing a wide range of pore network simulations.
.. toctree:: :hidden: :maxdepth: 0 installation modules/index _examples/index
If you use OpenPNM in a publication, please add the following citation:
Citation
Gostick J, Aghighi M, Hinebaugh J, Tranter T, Hoeh MA, Day H, Spellacy B, Sharqawy MH, Bazylak A, Burns A, Lehnert W. OpenPNM: a pore network modeling package. Computing in Science & Engineering. 2016 May 25;18(4):60-74. doi:10.1109/MCSE.2016.49.