ogstools 0.8.1

A collection of Python tools aimed at evolving into a modeling toolchain around OpenGeoSys.

is a:

• Python library for streamlined usage of OpenGeoSys that aims to enable OpenGeoSys users to harness the full potential of Python's extensive ecosystem.
• set of interconnected modules for pre- and postprocessing of simulations with OpenGeoSys,
• valuable resource that includes documentation, Jupyter notebooks, and workflows for guidance and reference.

Overview

• Website: https://www.opengeosys.org
• Documentation: https://ogstools.opengeosys.org
• Source code: https://gitlab.opengeosys.org/ogs/tools/ogstools
• Contributing: https://ogstools.opengeosys.org/stable/development/index.html
• Bug reports: https://discourse.opengeosys.org

Installation

Install the latest version of ogstools:

pip install ogstools[all]

For further details see the User Guide.

Getting started

For first steps, please take a look at our examples.

Contribution

GitHub mirror: This repository is also mirrored at github.com/ufz/ogstools — pull requests opened there are welcome and will be reviewed.

Please report bugs on Discourse or fork the repository on our GitLab and create a merge request. We also welcome contributions in the form of merge requests and are here to assist in ensuring that the code passes all quality checks. We recommend starting with the latest version of the Developer Guide as your initial point of reference.

You may also contribute by donating your existing code snippets.

Motivation

To gain a deeper insight into the rationale behind the development of this Python library, find a comprehensive motivation section available here.

Related projects

• ogs
• ogs6py
• VTUInterface

License

ogstools is distributed under the Modified BSD License. See the LICENSE-file for the license text.