Skip to content

Latest commit

 

History

History
executable file
·
49 lines (31 loc) · 2.64 KB

index.md

File metadata and controls

executable file
·
49 lines (31 loc) · 2.64 KB
Raw
title keywords sidebar permalink summary toc
Spherical Harmonic Tools
spherical harmonics software package, spherical harmonic transform, legendre functions, multitaper spectral analysis, Slepian functions, fortran, Python, gravity, magnetic field
mydoc_sidebar
index.html
pyshtools is an archive of Python software that can be used for spherical harmonic transforms, multitaper spectral analyses, expansions of gridded data into Slepian basis functions, and standard operations on global gravitational and magnetic field data.
false

{% include note.html content="You are reading the documentation for pyshtools. Click here to access the Fortran 95 SHTOOLS documentation." %}

Features

  • Supports all standard normalizations and phase conventions of the spherical harmonic functions.

  • Effortless conversion between real and complex harmonics, between phase conventions, and between 4π normalized, Schmidt semi-normalized, orthonormalized, and unnormalized harmonics.

  • Use of both regularly sampled geographic grids and grids appropriate for Gauss-Legendre quadrature.

  • Spherical harmonic transforms proven to be fast and accurate to high degrees.

  • Supports multiple backends for performing basic mathematical operations, including shtools and the Distinctly Useful Code Collection (DUCC).

  • Perform localized multitaper spectral analyses, or expand gridded data in terms of localized Slepian basis functions.

  • Supports 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.

Easy installation

The Python components of SHTOOLS can be installed using the Python package manager pip or conda. Binaries are pre-built for Linux, macOS and Windows architectures, and you need only to execute one of the following commands in a unix terminal:

pip install pyshtools
pip install --upgrade pyshtools  # to upgrade a pre-existing installation
conda install -c conda-forge pyshtools  # Linux and macOS only
conda update -c conda-forge pyshtools  # to upgrade a pre-existing installation

Permissive licensing

SHTOOLS is open source software and is distributed under the 3-clause BSD license.

Reference

Mark A. Wieczorek and Matthias Meschede (2018). SHTools --- Tools for working with spherical harmonics, Geochemistry, Geophysics, Geosystems, 19, 2574-2592, doi:10.1029/2018GC007529.