ogstools

Mirror of https://gitlab.opengeosys.org/ogs/tools/ogstools

https://github.com/ufz/ogstools

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

✓
CITATION.cff file
Found CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
○
DOI references
○
Academic publication links
○
Academic email domains
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (14.3%) to scientific vocabulary

Last synced: 6 months ago · JSON representation ·

Repository

Mirror of https://gitlab.opengeosys.org/ogs/tools/ogstools

Basic Info

Host: GitHub
Owner: ufz
License: bsd-3-clause
Language: Python
Default Branch: main
Homepage: https://ogstools.opengeosys.org/
Size: 19.8 MB

Statistics

Stars: 3
Watchers: 6
Forks: 0
Open Issues: 0
Releases: 9

Created over 2 years ago · Last pushed 6 months ago

Metadata Files

Readme License Citation

README.md

OGSTools

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:

bash pip install ogstools

For further details see the User Guide.

Getting started

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

Contribution

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

License

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

Owner

Name: OpenGeoSys
Login: ufz
Kind: organization
Email: info@opengeosys.org

Website: https://www.opengeosys.org
Repositories: 40
Profile: https://github.com/ufz

Citation (CITATION.cff)

# Update with `git shortlog -sne`

cff-version: 1.2.0
title: OGSTools
message: >-
    If you use this software, please cite it using these
    metadata.
type: software
authors:
    - given-names: Florian
      family-names: Zill
      orcid: "https://orcid.org/0000-0002-5177-401X"
      affiliation: Helmholtz Centre for Environmental Research -- UFZ
    - given-names: Lars
      family-names: Bilke
      orcid: "https://orcid.org/0000-0001-8986-2413"
      affiliation: Helmholtz Centre for Environmental Research -- UFZ
    - given-names: Tobias
      family-names: Meisel
      orcid: "https://orcid.org/0009-0009-8790-8903"
      affiliation: Helmholtz Centre for Environmental Research -- UFZ
    - given-names: Julian
      family-names: Heinze
      oricd: "https://orcid.org/0009-0004-3449-8852"
      affiliation: Helmholtz Centre for Environmental Research -- UFZ
    - given-names: Feliks K.
      family-names: Kiszkurno
      orcid: "https://orcid.org/0000-0003-3304-4838"
      affiliation: Helmholtz Centre for Environmental Research -- UFZ
    - given-names: Dominik
      family-names: Kern
      orcid: "https://orcid.org/0000-0002-1958-2982"
      affiliation: TU Bergakademie Freiberg
    - given-names: Max
      family-names: Jäschke
      affiliation: Leipzig University of Applied Sciences -- HTWK
    - given-names: Christoph
      family-names: Lehmann
      orcid: "https://orcid.org/0000-0001-7936-9852"
      affiliation: Helmholtz Centre for Environmental Research -- UFZ
identifiers:
    - type: doi
      value: 10.5281/zenodo.10913063
      description: Zenodo DOI for 0.3.0
    - type: doi
      value: 10.5281/zenodo.10913044
      description: Zenodo DOI for 0.2.0
    - type: doi
      value: 10.5281/zenodo.10912983
      description: Zenodo DOI for 0.1.0
    - type: doi
      value: 10.5281/zenodo.10912874
      description: Zenodo DOI for 0.0.3

repository-code: "https://gitlab.opengeosys.org/ogs/tools/ogstools"
url: "https://ogstools.opengeosys.org"
license: BSD-3-Clause

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Open Source Science