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://ogs.ogs.xyz/tools/ogstools>
- **Source code:** <https://gitlab.opengeosys.org/ogs/tools/ogstools>
- **Contributing:** <https://ogs.ogs.xyz/tools/ogstools/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://ogs.ogs.xyz/tools/ogstools/user-guide/index.html).
# Getting started
For first steps, please take a look at our [examples](https://ogs.ogs.xyz/tools/ogstools/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 [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.
Raw data
{
"_id": null,
"home_page": null,
"name": "ogstools",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"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",
"author": null,
"author_email": "OpenGeoSys Community <info@opengeosys.org>",
"download_url": "https://files.pythonhosted.org/packages/7e/30/b5a2649c3673cceb361f668f2f64e43e03cfdb508d31a0ee1671a04041d0/ogstools-0.4.0.tar.gz",
"platform": null,
"description": "![OGS workflow overview](https://ogs.ogs.xyz/tools/ogstools/_static/ogstools.png \"Supporting complex workflows - from preprocessing to simulation to postprocessing\")\n\nis a:\n\n- 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.\n- set of interconnected modules for pre- and postprocessing of simulations with [OpenGeoSys](https://www.opengeosys.org),\n- valuable resource that includes documentation, Jupyter notebooks, and workflows for guidance and reference.\n\n# Overview\n\n- **Website:** <https://www.opengeosys.org>\n- **Documentation:** <https://ogs.ogs.xyz/tools/ogstools>\n- **Source code:** <https://gitlab.opengeosys.org/ogs/tools/ogstools>\n- **Contributing:** <https://ogs.ogs.xyz/tools/ogstools/development/index.html>\n- **Bug reports:** <https://discourse.opengeosys.org>\n\n# Installation\n\nInstall the latest version of ogstools:\n\n```bash\npip install ogstools\n```\n\nFor further details see the [User Guide](https://ogs.ogs.xyz/tools/ogstools/user-guide/index.html).\n\n# Getting started\n\nFor first steps, please take a look at our [examples](https://ogs.ogs.xyz/tools/ogstools/auto_examples/index.html).\n\n# Contribution\n\nPlease 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 [Developer Guide](https://ogs.ogs.xyz/tools/ogstools/development/index.html) as your initial point of reference.\n\nYou may also contribute by [donating](https://gitlab.opengeosys.org/ogs/tools/ogstools/-/blob/main/donation.md) your existing code snippets.\n\n# Motivation\n\nTo 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).\n\n# Related projects\n\n- [ogs](https://pypi.org/project/ogs)\n- [ogs6py](https://pypi.org/project/ogs6py)\n- [VTUInterface](https://pypi.org/project/VTUinterface)\n\n# License\n\n`ogstools` is distributed under the Modified BSD License. See the `LICENSE`-file for the license text.\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "A collection of Python tools aimed at evolving into a modeling toolchain around OpenGeoSys.",
"version": "0.4.0",
"project_urls": {
"Bug Tracker": "https://discourse.opengeosys.org",
"Documentation": "https://ogs.ogs.xyz/tools/ogstools",
"Source Code": "https://gitlab.opengeosys.org/ogs/tools/ogstools"
},
"split_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"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d4c76c29bc06cd502023028157bd79977e1f3c6c6766c86b6aa2d1a6764cda58",
"md5": "ff0054f42a6a386274c98ca600ba54a5",
"sha256": "a601ddece091aa9844ce61f2f4c90bde5a1df9afaef109969ab77ed735a665de"
},
"downloads": -1,
"filename": "ogstools-0.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ff0054f42a6a386274c98ca600ba54a5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 6630100,
"upload_time": "2024-09-06T13:26:24",
"upload_time_iso_8601": "2024-09-06T13:26:24.471569Z",
"url": "https://files.pythonhosted.org/packages/d4/c7/6c29bc06cd502023028157bd79977e1f3c6c6766c86b6aa2d1a6764cda58/ogstools-0.4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7e30b5a2649c3673cceb361f668f2f64e43e03cfdb508d31a0ee1671a04041d0",
"md5": "14855bd36814868f85658ac684e7c891",
"sha256": "55c2d56050140c18941d8c4cad219bd4f9c25226e2c51333247d43fa885c3a6c"
},
"downloads": -1,
"filename": "ogstools-0.4.0.tar.gz",
"has_sig": false,
"md5_digest": "14855bd36814868f85658ac684e7c891",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 15275260,
"upload_time": "2024-09-06T13:26:26",
"upload_time_iso_8601": "2024-09-06T13:26:26.931892Z",
"url": "https://files.pythonhosted.org/packages/7e/30/b5a2649c3673cceb361f668f2f64e43e03cfdb508d31a0ee1671a04041d0/ogstools-0.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-06 13:26:26",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "ogstools"
}
JSON