compgeo-mox / pygeon

A Python package for consistent mixed-dimensional discretizations in porous media
GNU General Public License v3.0
11 stars 4 forks source link
consistent-discretizations differential-complexes finite-element-methods mixed-dimensional-modeling partial-differential-equations-on-graphs python virtual-element-methods

Pytest Mypy, black, isort, flake8 CodeQL DOI License: GPL v3 Code style: black

PyGeoN: a Python package for Geo-Numerics

Installation for Linux

PyGeoN requires Python >= 3.10

Since for many functionalities PyGeoN depends on PorePy, we assume that the latter is accessible in your PYTHONPATH.

To install PyGeoN, first clone the current version of the code and then install the dependencies by

pip install -r requirements.txt

Additional dependencies can be installed by

pip install -r requirements-dev.txt

Then to install PyGeoN at user level (see also below) type

pip install .

if you want to modify PyGeoN install it in an editable way by writing instead

pip install --user -e .

It might be useful to add PyGeoN to your PYTHONPATH.

Issues

Create an issue.

Getting started

See the tutorials.

License

See license.