SHTOOLS/pyshtools is a Fortran-95/Python library that can be used for spherical harmonic transforms, multitaper spectral analyses, expansions of gridded data into Slepian basis functions, standard operations on global gravitational and magnetic field data.
-
Supports all standard normalizations and phase conventions of the spherical harmonic functions.
-
Effortless conversion between real and complex harmonics, and between different normalization and phase conventions.
-
Use of both regularly sampled geographic grids and grids appropriate for Gauss-Legendre quadrature.
-
Spherical harmonic transforms proven to be accurate up to about degree 2800 for the native Fortran 95 backend and beyond using the DUCC0 backend.
-
Perform localized multitaper spectral analyses, or expand gridded data in terms of localized Slepian basis functions.
-
Support for standard data and file formats, including xarray and netcdf.
-
Import research-grade gravity, topography, and magnetic field datasets with a single command.
-
Creation of publication quality maps using Cartopy and PyGMT.
-
Support multithreaded programming using the OpenMP API.
A variety of Python tutorials and guides are available to explain the main library features. To get started, click on the following Python tutorials and run them interactively in Binder:
- Spherical harmonic coefficients and grids
- Localization windows and spectral analysis
- Gravity and magnetic fields
- Plotting maps
SHTOOLS can be invoked in any Fortran 95 or Python program. The core software is written in Fortran 95, and Python wrappers and dedicated classes allow simple access to the fortran-compiled routines. To install it, run these commands below:
conda install -c conda-forge pyshtools
conda update -c conda-forge pyshtools # to upgrade a pre-existing installationpip install pyshtools
pip install --upgrade pyshtools # to upgrade a pre-existing installation
pip install pyshtools --no-binary pyshtools # build from source
pip install git+https://github.com/SHTOOLS/SHTOOLS@develop # install the develop branch from sourceInstall the system level build requirements:
sudo apt-get install build-essential cmake gfortran # Debian, Ubuntu and derivatives
sudo dnf group install "C Development Tools and Libraries" "Development Tools" # Fedora, Centos, RHEL and derivatives
sudo dnf install cmake gcc-fortran # Fedora, Centos, RHEL and derivatives
xcode-select --install # macOSThen clone the shtools repo, install the other dependencies, and install manually in a conda environment:
git clone https://github.com/SHTOOLS/SHTOOLS.git
cd shtools
conda create -n your_env_name python=3.xx # create a new conda environment, if desired
conda env update -n your_env_name -f environment.yml
conda activate your_env_name # activate the new conda environment
pip install --no-build-isolation -e . # install into the shtools folder and link to the active python environmentInstall using the brew package manager (MacOS, Linux, Windows):
brew install shtoolsInstall using the macports package manager (MacOS):
sudo port install shtoolsClone or download the this repo, and then execute one (or both) of the following commands in the shtools directory:
make fortran
make fortran-mp # for OpenMP Fortran routinesFurther installation instructions and options can be found in the web documentation.
We work on the develop branch and only push releases to master. Please base all pull requests on develop.
For the full list of contributors, see the AUTHORS file.
This project uses the BSD 3-Clause license, as found in the LICENSE file.
- Mark A. Wieczorek and Matthias Meschede (2018). SHTools --- Tools for working with spherical harmonics, Geochemistry, Geophysics, Geosystems, 19, 2574-2592, doi:10.1029/2018GC007529.
- Mark Wieczorek, et al. (2019). SHTOOLS/SHTOOLS. Zenodo, doi:10.5281/zenodo.3457861