Skip to content
Geophysical Inversion and Modeling Library 🌍
C++ Python MATLAB CMake Shell C
Branch: master
Clone or download

Latest commit

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
apps
core fix example May 7, 2020
doc adjust some examples May 17, 2020
pygimli adjust some examples May 17, 2020
.appveyor.yml add path to preinstalled boost on win builds Jan 26, 2016
.gitattributes python/pygimli -> pygimli May 5, 2020
.gitignore Add some generated files to .gitignore May 6, 2020
.grenrc Rename changelog to markdown for proper GitHub Rendering Dec 22, 2017
.jenkins.sh Minor Apr 25, 2020
.landscape.yml python/pygimli -> pygimli May 5, 2020
.prospector.yml + health Jun 30, 2016
.pylintrc linting Nov 20, 2019
.travis.yml move to Ubuntu precise for travis builds Dec 1, 2015
AUTHORS.rst add friedrich to AUTHORS and included file in sphinx build structure Apr 29, 2020
CHANGELOG.md Update changelog May 6, 2020
CITATION.rst Doc: Avoid large whitespace around mpl figs in API doc Aug 28, 2019
CMakeLists.txt python/pygimli -> pygimli May 5, 2020
CONTRIBUTING.md add a new section to the contributing text that explains how to update a Nov 14, 2019
COPYING.rst Fix sphinx link to license Jan 22, 2017
INSTALLATION.rst merge May 10, 2020
ISSUE_TEMPLATE.md Add issue template Jan 2, 2018
MANIFEST.in first change Apr 24, 2020
PULL_REQUEST_TEMPLATE.md Shorten PR template. Jan 12, 2018
README.md merge May 10, 2020
README.rst add friedrich to AUTHORS and included file in sphinx build structure Apr 29, 2020
dependencies.rst first change Apr 24, 2020
gimli.code-workspace add dll to gitignore Oct 28, 2019
setup.cfg Fix pg.version() Apr 25, 2020
setup.py Put apps back to setup.py May 7, 2020
versioneer.py Fix pg.version() Apr 25, 2020

README.md

license release Github commits (since latest release)

pyGIMLi is an open-source library for modelling and inversion and in geophysics. The object-oriented library provides management for structured and unstructured meshes in 2D and 3D, finite-element and finite-volume solvers, various geophysical forward operators, as well as Gauss-Newton based frameworks for constrained, joint and fully-coupled inversions with flexible regularization.

What is pyGIMLi suited for?

  • analyze, visualize and invert geophysical data in a reproducible manner
  • forward modelling of (geo)physical problems on complex 2D and 3D geometries
  • inversion with flexible controls on a-priori information and regularization
  • combination of different methods in constrained, joint and fully-coupled inversions
  • teaching applied geophysics (e.g. in combination with Jupyter notebooks)

What is pyGIMLi NOT suited for?

  • for people that expect a ready-made GUI for interpreting their data
Installation

Anaconda-Server Badge Anaconda-Server Badge Anaconda-Server Badge Anaconda-Server Badge

On all platforms, we recommend to install pyGIMLi via the conda package manager contained in the Anaconda distribution. For details on how to install Anaconda, we refer to: https://docs.anaconda.com/anaconda/install/

To avoid conflicts with other packages, we recommend to install pygimli in a separate environment. Here we call this environment pg, but you can give it any name. Note that this environment has to be created only once.

conda create -n pg -c gimli -c conda-forge pygimli=1.1.0

If you are using Windows or Mac, a new environment named “pg” should be visible in the Anaconda Navigator. If you want to use pygimli from the command line, you have to activate the environment. You can put this line in your ~/.bashrc file so that it is activated automatically if you open a terminal.

conda activate pg

See https://www.pygimli.org/installation.html for more information.

Import convention
import pygimli as pg
print(pg.__version__)

Check www.pygimli.org for additional information, detailed installation instructions and many examples.

Citing pyGIMLi

More information can be found in this paper. If you use pyGIMLi for your work, please cite as:

Rücker, C., Günther, T., Wagner, F.M., 2017. pyGIMLi: An open-source library for modelling and inversion in geophysics, Computers and Geosciences, 109, 106-123, doi: 10.1016/j.cageo.2017.07.011.

BibTeX code:

@article{Ruecker2017,
  title = "{pyGIMLi}: An open-source library for modelling and inversion in geophysics",
  journal = "Computers and Geosciences",
  volume = "109",
  number = "",
  pages = "106--123",
  year = "2017",
  issn = "0098-3004",
  doi = "10.1016/j.cageo.2017.07.011",
  url = "http://www.sciencedirect.com/science/article/pii/S0098300417300584",
  author = "Carsten R\"ucker and Thomas G\"unther and Florian M. Wagner"
}
License

pyGIMLi is distributed under the terms of the Apache 2.0 license. Details on the license agreement can be found here.

You can’t perform that action at this time.