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

PorePy is a simulation tool that targets multiphysics processes in fractured porous media. PorePy comes with:

• Functionality for automatic mesh generation for complex fracture networks in two and three dimensions.

• Numerical methods that allow for simulation of non-linearly coupled multiphysics processes.

• Ready-made simulation setups for coupled processes, including:

  • Thermo-poromechanics coupled with fracture deformation.
  • Multiphase flow and transport.

  The code design prioritizes easy adaptation of these setups to allow for rapid prototyping.

The video below showcases a fully coupled flow and heat transport simulation in a fractured porous medium with 52 fractures. In the simulation, cold fluid is injected through an injection well in the top right of the domain and produced from a production well on the opposite side.

How do I get started?

The best place to start is the tutorials; we suggest looking at the Readme file for guidance on how to approach the tutorials. The tutorials show how to use the code for various common cases and explain key PorePy functionality. The code can be accessed in several ways:

• The most immediate access is running PorePy in your web browser. If you have a GitHub account, use a GitHub codespace for PorePy following these instructions. Note that the building time will be a few minutes.
• If you want to run the code on your own machine, you have two options:
  • If you have Docker installed, we recommend pulling the PorePy Docker image through ‘docker pull porepy/stable’.
  • To install PorePy manually, follow the install instructions.

Documentation can be found here (still under construction).

How can I get involved?

Please see the guidelines for contributing.

Acknowledgements

PorePy is mainly 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, the European Research Council and Equinor.

Citing

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

Keilegavlen, E., Berge, R., Fumagalli, A., Starnoni, M., Stefansson, I., Varela, J., & Berre, I. PorePy: an open-source software for simulation of multiphysics processes in fractured porous media. Computational Geosciences, 25, 243–265 (2021), doi:10.1007/s10596-020-10002-5