pygmi 3.3.0.0
Python Geoscience Modelling and Interpretation
Requires Python: >=3.10
Keywords: Geoscience, Geophysics, Magnetic, Gravity, Modelling, Interpretation, Remote Sensing

PyGMI
=====

.. |pythonversion| image:: https://img.shields.io/pypi/pyversions/pygmi
   :alt: PyPI - Python Version
   :target: https://pypi.org/project/pygmi
.. |pygmiversion| image:: https://img.shields.io/pypi/v/pygmi
   :alt: PyPI - Version
   :target: https://pypi.org/project/pygmi
.. |pygmilicence| image:: https://img.shields.io/github/license/patrick-cole/pygmi
   :alt: GitHub License
   :target: https://github.com/Patrick-Cole/pygmi/blob/pygmi3/LICENSE.txt
.. |pygmirelease| image:: https://img.shields.io/github/release/patrick-cole/pygmi
   :alt: GitHub Release
   :target: https://github.com/Patrick-Cole/pygmi/releases
.. image:: https://joss.theoj.org/papers/10.21105/joss.07019/status.svg
   :target: https://doi.org/10.21105/joss.07019


|pythonversion| |pygmiversion| |pygmilicence| |pygmirelease|

Overview
--------

PyGMI stands for Python Geoscience Modelling and Interpretation. It is a modelling and interpretation suite aimed at magnetic, gravity, remote sensing and other datasets. PyGMI has a graphical user interface, and is meant to be run as such.

PyGMI is developed at the `Council for Geoscience <http://www.geoscience.org.za>`_ (Geological Survey of South Africa).

It includes:

* Magnetic and Gravity 3D forward modelling.
* Cluster Analysis, including use of scikit-learn libraries.
* Routines for cutting, reprojecting and doing simple modifications to data.
* Convenient display of data using pseudo-color, ternary and sunshaded representation.
* MT processing and 1D inversion using MTpy.
* Gravity processing.
* Seismological functions for SEISAN data.
* Remote sensing ratios and improved imports.

It is released under the `Gnu General Public License version 3.0 <http://www.gnu.org/copyleft/gpl.html>`_

The PyGMI `Wiki <http://patrick-cole.github.io/pygmi/index.html>`_ pages, include installation and full usage! Contributors can check this `link <https://github.com/Patrick-Cole/pygmi/blob/pygmi3/CONTRIBUTING.md>`_ for ways to contribute.

The latest release version (including windows installers) can be found `here <https://github.com/Patrick-Cole/pygmi/releases>`_.

You may need to install the `Microsoft Visual C++ Redistributable for Visual Studio 2015, 2017 and 2019 <https://support.microsoft.com/en-us/help/2977003/the-latest-supported-visual-c-downloads>`_.

If you have any comments or queries, you can contact the author either through `GitHub <https://github.com/Patrick-Cole/pygmi>`_ or via email at pcole@geoscience.org.za


Installation
------------
The simplest installation of PyGMI is on Windows, using a pre-built installer at `64-bit <https://github.com/Patrick-Cole/pygmi/releases>`_.

If you prefer building from source, you can use PyPi or Conda.

Once built using PyPi, running pygmi can be done at the command prompt as follows:

   pygmi

If you are in python, you can run PyGMI by using the following commands:

   from pygmi.main import main

   main()

If you prefer not to install pygmi as a library, download the source code and execute the following command to run it manually:

   python quickstart.py

Requirements
^^^^^^^^^^^^
PyGMI will run on both Windows and Linux. It should be noted that the main development is done in Python 3.13 on Windows.

PyGMI should still work with Python 3.10.

PyGMI is developed and has been tested with the following libraries in order to function:

* fiona>=1.10.1
* geopandas>=1.1.2
* h5netcdf>=1.8.1
* matplotlib>=3.10.8
* natsort>=8.4.0
* numba>=0.63.1
* numexpr>=2.14.1
* openpyxl>=3.1.5
* psutil>=7.2.1
* pyside6>=6.10.1
* pytest>=9.0.2
* pyvista>=0.46.5
* pyvistaqt>=0.11.3
* rasterio>=1.5.0
* rioxarray>=0.21.0
* scikit-learn>=1.8.0
* scikit-image>=0.26.0
* shapelysmooth>=0.2.1
* simpeg>=0.25.0
* beautifulsoup4>=4.14.3
* pyyaml>=6.0.3
* pwlf>=2.5.2

PyPi - Windows
^^^^^^^^^^^^^^
Windows users can use the `WinPython <https://winpython.github.io/>`_ distribution as an alternative to Anaconda. It comes with most libraries preinstalled, so using pip should be sufficient.

Install with the following command.

   pip install pygmi

Should you wish to manually install binaries, related binaries can be obtained at the `website <https://github.com/cgohlke/geospatial-wheels/>`_ by Christoph Gohlke.

If you wish to update GDAL, you will need to download and install:

* fiona
* GDAL
* pyproj
* rasterio
* Rtree
* shapely

All these binaries should be downloaded since they have internal co-dependencies.

PyPi - Linux
^^^^^^^^^^^^
Linux normally comes with python installed, but the additional libraries will still need to be installed.

The process is as follows:

   sudo apt-get install pipx
   
   pipx ensurepath

   pipx install pygmi

Once installed, running pygmi can be done at the command prompt as follows:

   pygmi

If you get the following error: *qt.qpa.plugin: Could not load the Qt platform plugin "xcb" in "" even though it was found.*, then you can try the following command, since this is Linux issue:

   sudo apt-get install libxcb-xinerama0

Anaconda
^^^^^^^^
Anaconda users are advised not to use pip since it can break PyQt5. However, one package is installed only by pip, so a Conda environment should be created.

The process to install is as follows:

   conda create -n pygmi python=3.13

   conda activate pygmi

   conda config --env --add channels conda-forge

   conda install pyside6

   conda install fiona

   conda install matplotlib

   conda install psutil

   conda install numexpr

   conda install rasterio

   conda install geopandas

   conda install natsort

   conda install numba

   conda install scikit-learn

   conda install scikit-image

   conda install pyvista

   conda install pyvistaqt

   conda install simpeg

   conda install shapelysmooth

   conda install openpyxl

   conda install h5netcdf

   conda install rioxarray

   conda install pytest

   conda install beautifulsoup4

   conda install pyyaml

   conda install pwlf

   conda update --all

Once this is done, download pygmi, extract (unzip) it to a directory, and run it from its root directory with the following command:

   python quickstart.py

References
----------

* Cole, P. 2012, Development of a 3D Potential Field Forward Modelling System in Python, AGU fall meeting, 3-7 December, San Francisco, USA
* Cole, P. 2013, PyGMI – The use of Python in geophysical modelling and interpretation. South African Geophysical Association, 13th Biennial Conference, Skukuza Rest Camp, Kruger National Park (7-9 October)
* Cole, P. 2014, The history and design behind the Python Geophysical Modelling and Interpretation (PyGMI) package, SciPy 2014, Austin, Texas (6-12 July)
* Cole, P. 2016, The continued evolution of the open source PyGMI project. 35th IGC, Cape Town.
* Cole, P. 2025, PyGMI - a python package for geoscience modelling and interpretation. Journal of Open Source Software, 10(111), 7019, https://doi.org/10.21105/joss.07019