Skip to content
Python Simulation Tool for Fractured and Deformable Porous Media
Python Jupyter Notebook Other
Branch: develop
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
dockerfiles Purged the aperture scaling from discretizations Aug 14, 2019
src/porepy Version 1.0.0 Aug 20, 2019
test Merge pull request #303 from pmgbergen/transient_contact_condition Aug 16, 2019
tutorials Fix of ScalarDualSource. Aug 16, 2019
.gitignore add the .eggs folder to gitignore Jun 7, 2019
.travis.yml Update travis Apr 3, 2019
Install.md
LICENSE Create LICENSE Apr 10, 2019
LICENSE.md Update LICENSE.md Jun 24, 2017
MANIFEST.in Manifest Jun 1, 2017
Papers.md Move file with overview of papers using PorePy Aug 14, 2019
Readme.md Update of readme Aug 16, 2019
Readme.rst RST format of Readme, for pypi Jun 1, 2017
requirements-dev.txt Add vtk interface to dependencies Aug 16, 2019
requirements.txt Add vtk interface to dependencies Aug 16, 2019
setup.cfg Surpress warnings from pytest Apr 3, 2019
setup.py Version 1.0.0 Aug 20, 2019

Readme.md

Build Status Coverage Status DOI License: GPL v3 Code style

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.

Reproduce results from papers and preprints

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

Citing

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

E. Keilegavlen, A. Fumagalli, R. Berge, I. Stefansson, I. Berre: PorePy: An Open-Source Simulation Tool for Flow and Transport in Deformable Fractured Rocks. arXiv:1712.00460

Other publications done with PorePy can be found here.

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. For its configuration see Install.

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.

You can’t perform that action at this time.