semvec/pypi-packages huggingface dataset:
ogstools 0.7.1
A collection of Python tools aimed at evolving into a modeling toolchain around OpenGeoSys.
License: BSD-3-Clause
Requires Python: >=3.10
Keywords: opengeosys, geoscience, subsurface modeling, hydrogeology, numerical simulation, finite element method, groundwater flow, geochemistry, geotechnical engineering, porous media, contaminant transport, mesh generation, data visualization, scientific computing, open-source software

![OGSTools](https://ogstools.opengeosys.org/stable/_static/ogstools.png "Supporting complex workflows - from preprocessing to simulation to postprocessing")

is a:

- Python library for streamlined usage of [OpenGeoSys](https://www.opengeosys.org) that aims to enable [OpenGeoSys](https://www.opengeosys.org) users to harness the full potential of Python's extensive ecosystem.
- set of interconnected modules for pre- and postprocessing of simulations with [OpenGeoSys](https://www.opengeosys.org),
- 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:

```bash
pip install ogstools
```

For further details see the [User Guide](https://ogstools.opengeosys.org/stable/user-guide/index.html).

# Getting started

For first steps, please take a look at our [examples](https://ogstools.opengeosys.org/stable/auto_examples/index.html).

# Contribution

Please report bugs on [Discourse](https://discourse.opengeosys.org) or fork the repository on our [GitLab](https://gitlab.opengeosys.org/ogs/tools/ogstools) 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](https://ogs.ogs.xyz/tools/ogstools/development/index.html) as your initial point of reference.

You may also contribute by [donating](https://gitlab.opengeosys.org/ogs/tools/ogstools/-/blob/main/donation.md) 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](https://gitlab.opengeosys.org/ogs/tools/ogstools/-/blob/main/docs/user-guide/introduction/motivation.md).

# Related projects

- [ogs](https://pypi.org/project/ogs)
- [ogs6py](https://pypi.org/project/ogs6py)
- [VTUInterface](https://pypi.org/project/VTUinterface)

# License

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