Home

Awesome

<p align="center"><img src="https://raw.githubusercontent.com/cgre-aachen/gemgis/main/docs/getting_started/images/Modern1.png" width="600">

Spatial data and information processing for geomodeling and subsurface data

PyPI PyPI Conda GitHub Binder Read the Docs DOI DOI DOI Project Status: Active – The project has reached a stable, usable state and is being actively developed. PyPI - Python Version

<p align="center"><img src="https://raw.githubusercontent.com/cgre-aachen/gemgis/main/docs/getting_started/images/task1.png" width="200"><img src="https://raw.githubusercontent.com/cgre-aachen/gemgis/main/docs/getting_started/images/model1.png" width="300"></p>

Overview

We attempt to simplify the access to open-source spatial data processing for geological modeling and for subsurface data (wells, seismic, etc.) with the development of GemGIS, a Python-based open-source library.

GemGIS wraps and extends the functionality of packages known to the geo-community such as GeoPandas, rasterio, OWSLib, Shapely, PyVista, Pandas, NumPy and the geomodeling package GemPy.

The aim of GemGIS, as indicated by the name, is to become a bridge between conventional geoinformation systems (GIS) such as ArcGIS and QGIS, and geomodeling tools such as GemPy, allowing simpler and more automated workflows from one environment to the other. This also includes making it simpler to visualize the results obtained from GemGIS and GemPy with PyVista or Blender. Further, subsurface data processing workflows are implemented for integrated data analyses.

<p align="center"><img src="https://raw.githubusercontent.com/cgre-aachen/gemgis/main/joss/images/fig1.png" width="800">

<a name="doc"></a>

Resources

Find the documentation of GemGIS here. It includes introductions to the main libraries used and to introductory topics like "What is vector data?" or "What is raster data?".

In addition, tutorial notebooks provide an overview of the different features of GemGIS. The notebooks can also be downloaded directly from here. Furthermore, many example models showcase a variety of geological structures that can be modeled with GemGIS and GemPy. The API Reference provides an overview of the implemented functions in GemGIS and how to use them.

<a name="installation"></a>

Installation

It is recommended to use GemGIS with python">=3.10" in a separated environment. The main packages and its dependencies can be installed via the conda-forge channel. GemGIS is then available through PyPi or Conda.

  1. conda install -c conda-forge geopandas">=0.13.2" rasterio">=1.3.8"
  2. conda install -c conda-forge pyvista">=0.42.1"
  3. pip install gemgis / conda install -c conda-forge gemgis

Check out the Installation Page for more detailed instructions.

If you are an open-source software developer, please install GemGIS and its dependencies, also for building the documentation, using the development YML file. <a name="contributing"></a>

Contribution Guidelines

The Contribution Guidelines for GemGIS can be found here: Contribution Guidelines

We welcome issue reports, questions, ideas for new features and pull-requests to fix issues or even add new features to the software. Once a pull-request is opened, we will guide through the review process.

<a name="ref"></a>

References