PorePy: A Simulation Tool for Fractured and Deformable Porous Media written in Python.

PorePy currently has the following distinguishing features:

General grids in 2d and 3d, as well as mixed-dimensional grids defined by intersecting fracture networks.
Support for analysis, visualization and gridding of fractured domains.
Discretization of flow and transport, using finite volume methods and virtual finite elements.
Discretization of elasticity and poro-elasticity, using finite volume methods.

PorePy is developed by the Porous Media Group at the University of Bergen, Norway. The software is developed under projects funded by the Research Council of Norway and Statoil.

Citing

If you use PorePy in your research, we ask you to cite the following publication

E. Keilegavlen, R. Berge, A. Fumagalli, M. Starnoni, I. Stefansson, J. Varela, I. Berre: PorePy: An Open-Source Software for Simulation of Multiphysics Processes in Fractured Porous Media. arXiv:1908.09869

Runscripts for most, if not all, papers that uses porepy is available at here. Note that you may have to revert to an older version of PorePy to run the examples (we try to keep the runscripts updated, but sometime fail to do so, for various reasons).

Installation from source

For more detailed install instructions, including how to access GMSH (for meshing), see Install.

PorePy is developed under Python >=3.6.

To get the most current version, install from github:

git clone https://github.com/pmgbergen/porepy.git

cd porepy

To get the stable (though not very frequently updated) version: git checkout master

Install pip install -r requirements.txt

Finally to install PorePy

pip install .

or for editable installs into the user directory:

pip install --user -e .

Using Docker

A docker image is available from docker.io/keileg/porepy:

>  docker pull docker.io/keileg/porepy

For the moment, Docker support should be considered experimental.

(Semi-) Optional packages

To function optimally, PorePy should have access to some more packages:

pymetis (for mesh partitioning).
Some computationally expensive methods can be accelerated with Cython or Numba.
We use shapely for certain geometry-operations.
Meshing: currently by gmsh.

Testing

To test build locally, the second command requires gmsh (see Install)

pip install -r requirements-dev.txt

python setup.py test

Getting started

Confer the tutorials. Also see unit tests.

Problems

Create an issue

License

See license md.

akpopoola/porepy