PyGeoN Documentation

Pytest Mypy, ruff, isort DOI License: GPL v3

PyGeoN is a Python package for Geo-Numerics, focusing on structure-preserving numerical methods for porous media and mixed-dimensional modeling.

Features

  • Structure-preserving discretizations

  • Mixed-dimensional modeling support

  • Integration with PorePy

  • Comprehensive test suite

  • Tutorials and examples

Installation

PyGeoN requires Python >= 3.12

Since PyGeoN depends on PorePy, ensure that it is accessible in your PYTHONPATH.

To install PyGeoN:

pip install -e .

Omit the -e flag if you don’t want the editable version.

Quick Start

See the tutorials to get started with PyGeoN.

Contents

Reports

Additional Information

Indices and tables