.. |pythonversion| image:: https://img.shields.io/pypi/pyversions/pygmi :alt: PyPI - Python Version .. |pygmiversion| image:: https://img.shields.io/pypi/v/pygmi :alt: PyPI - Version .. |pygmilicence| image:: https://img.shields.io/github/license/patrick-cole/pygmi :alt: GitHub License
|pythonversion| |pygmiversion| |pygmilicence|
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:
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
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.12 on Windows.
PyGMI should still work with Python 3.11.
PyGMI is developed and has been tested with the following libraries in order to function:
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:
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 pip
sudo apt-get install gdal-bin
sudo apt-get install libgdal-dev
pip install cython
pip install numpy
pip install pygmi
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.12
conda activate pygmi
conda config --add channels conda-forge
conda config --set channel_priority flexible
conda install pyqt
conda install fiona
conda install matplotlib
conda install psutil
conda install numexpr
conda install rasterio
conda install geopandas
conda install natsort
conda install scikit-image
conda install pyopengl
conda install simpeg
conda install shapelysmooth
conda install openpyxl
conda install h5netcdf
conda install rioxarray
conda install pytest
pip install mtpy
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