https://github.com/pmgbergen/porepy

Python Simulation Tool for Fractured and Deformable Porous Media
https://github.com/pmgbergen/porepy

discretization finite-volume-methods fractures porous-media python virtual-elements

Last synced: about 1 month ago
JSON representation

Python Simulation Tool for Fractured and Deformable Porous Media

• Host: GitHub
• URL: https://github.com/pmgbergen/porepy
• Owner: pmgbergen
• License: gpl-3.0
• Created: 2017-04-24T10:43:24.000Z (about 7 years ago)
• Default Branch: develop
• Last Pushed: 2023-12-18T17:03:50.000Z (6 months ago)
• Last Synced: 2023-12-19T11:41:40.315Z (6 months ago)
• Topics: discretization, finite-volume-methods, fractures, porous-media, python, virtual-elements
• Language: Python
• Homepage:
• Size: 74.8 MB
• Stars: 217
• Watchers: 18
• Forks: 88
• Open Issues: 46
• Metadata Files:
  • Readme: Readme.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md
  • Codeowners: .github/CODEOWNERS

Lists

• awesome-python-chemistry - PorePy - A Simulation Tool for Fractured and Deformable Porous Media. (Simulations)
• awesome_awesome_chemoinformatics - PorePy - A Simulation Tool for Fractured and Deformable Porous Media. (Simulations / Packages for atomistic simulations and computational chemistry.)
• awesome-stars - pmgbergen/porepy - Python Simulation Tool for Fractured and Deformable Porous Media (Python)
• awesome-python-chemistry - PorePy - A Simulation Tool for Fractured and Deformable Porous Media. (Simulations)
• awesome-reservoir-engineering - porepy -  Simulation Tool for Fractured and Deformable Porous Media (Software / Petrophysics)

README

        
![Pytest](https://github.com/pmgbergen/porepy/actions/workflows/run-pytest.yml/badge.svg)

![Pytest including slow](https://github.com/pmgbergen/porepy/actions/workflows/run-pytest-all.yml/badge.svg)

![Mypy, black, isort, flake8](https://github.com/pmgbergen/porepy/actions/workflows/run-static-checks.yml/badge.svg)

[![DOI](https://zenodo.org/badge/89228838.svg)](https://zenodo.org/badge/latestdoi/89228838)

[![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)

# 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, possibly intersecting, fracture networks.

- Automatic gridding for complex fracture networks in 2d and 3d.

- Discretization of mixed-dimensional multi-physics processes:

    - Finite volume and mixed and virtual finite element methods for flow

    - Finite volume methods for transport and thermo-poroelasticity

    - Deformation of existing fractures treated as a frictional contact problem

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

# Installation

We recommend using PorePy through a Docker image. The development and stable versions can be obtained, respectively, by 

    docker pull porepy/dev

and

    docker pull porepy/stable

Instructions to install from source can be found [here](https://github.com/pmgbergen/porepy/blob/develop/Install.md).

PorePy is developed under Python >=3.10.

# Getting started

Confer the [tutorials](https://github.com/pmgbergen/porepy/tree/develop/tutorials). 

Documentation can be found [here](https://pmgbergen.github.io/porepy/html/docsrc/porepy/porepy.html) (still under construction).

# 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](https://doi.org/10.1007/s10596-020-10002-5)

# Contributions

For guidelines on how to contribute to PorePy, see [here](./CONTRIBUTING.md)

# License

See [license md](./LICENSE.md).