Metadata-Version: 1.1
Name: pyshtools
Version: 4.3
Summary: SHTOOLS - Tools for working with spherical harmonics
Home-page: https://shtools.github.io/SHTOOLS/
Author: The SHTOOLS developers
Author-email: mark.a.wieczorek@gmail.com
License: BSD
Download-URL: https://github.com/SHTOOLS/SHTOOLS/zipball/master
Description-Content-Type: UNKNOWN
Description: ![LOGO](misc/logo.png)
        
        [![Documentation](https://img.shields.io/badge/documentation-shtools.github.io%2FSHTOOLS%2F-yellow.svg)](https://shtools.github.io/SHTOOLS/)
        [![DOI](https://zenodo.org/badge/doi/10.5281/zenodo.592762.svg)](https://doi.org/10.5281/zenodo.592762)
        [![Paper](https://img.shields.io/badge/paper-10.1029/2018GC007529-orange.svg)](https://doi.org/10.1029/2018GC007529)
        [![Join the chat at https://gitter.im/SHTOOLS/SHTOOLS](https://badges.gitter.im/SHTOOLS/SHTOOLS.svg)](https://gitter.im/SHTOOLS/SHTOOLS?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
        [![Twitter](https://img.shields.io/twitter/follow/pyshtools.svg?style=social&label=Follow)](https://twitter.com/intent/follow?screen_name=pyshtools)
        
        SHTOOLS/pysthools is a Fortran-95/Python library that can be used to perform
        spherical harmonic transforms and reconstructions, multitaper spectral analyses on the sphere, expansions of functions into Slepian bases, and standard operations on global gravitational and magnetic field data.
        
        ### FEATURES ###
        
        * A wide range of supported spherical harmonic functions:
           * real and complex,
           * all standard normalizations (Geodesy 4&pi;, Schmidt semi-normalized, orthonormalized, unnormalized),
           * Condon-Shortley phase factor of (-1)<sup>m</sup>.
        
        * Clean implementation of the spherical harmonic transforms:
          * exact quadrature rules using the sampling theorem of *Driscoll and Healy* (1994) or Gauss-Legendre quadrature,
          * accurate and fast to approximately degree 2800,
          * Fortran 95 routines are OpenMP compatible and OpenMP thread-safe.
        
        * Selected applications and routines:
           * global spectral analysis, spherical harmonic rotations, Wigner 3j symbols,
           * localized multitaper spectral analyses, expansions in Slepian basis functions, spherical harmonic coupling matrices,
           * standard gravity and magnetic field calculations, computation of the geoid, finite-amplitude potential from topography.
        
        * SHTOOLS is open source software (3-clause BSD license).
        
        ### INSTALLATION ###
        #### pyshtools for Python ####
        
        Binary install for linux/macOS/windows:
        ```bash
        pip install pyshtools
        ```
        Build from source:
        ```bash
        pip install pyshtools --no-binary pyshtools
        ```
        
        #### pyshtools for Anaconda Python ####
        
        Install fftw3 with fortran bindings and then install pyshtools using `pip`:
        
        ```bash
        conda install -c eumetsat fftw3
        pip install pyshtools
        ```
        
        #### pyshtools for Python (developer install) ####
        Linux requirements:
        ```bash
        sudo apt-get install libblas-dev liblapack-dev g++ gfortran libfftw3-dev tcsh
        ```
        macOS requirements:
        ```bash
        brew install fftw
        ```
        To install the develop branch use:
        ```bash
        pip install git+https://github.com/SHTOOLS/SHTOOLS@develop
        ```
        Alternatively, clone the shtools repo
        ```bash
        git clone https://github.com/SHTOOLS/SHTOOLS.git
        ```
        and then execute one of the following commands in the shtools directory:
        ```bash
        pip install .  # installs into the active python environment lib folder
        pip install -v -e .  # installs into the SHTOOLS/pyshtools folder and links to the active python environment
        ```
        
        #### Fortran Library ####
        Clone the shtools repo, and then execute one of the following commands in the shtools directory:
        ```bash
        make fortran
        make fortran-mp  # OpenMP Fortran routines
        ```
        Or use the [brew](http://brew.sh/) package manager (macOS):
        ```bash
        brew tap shtools/shtools
        brew install shtools
        brew install shtools --with-openmp # to install shtools with the OpenMP components.
        ```
        
        More installation instructions and options can be found in the [web documentation](https://shtools.github.io/SHTOOLS/) and GitHub 
        [wiki](https://github.com/SHTOOLS/SHTOOLS/wiki).
        
        ### HOW TO USE ###
        
        SHTOOLS can be invoked in any Fortran 95 or Python program. The core software is written in Fortran 95, and Python wrappers allow simple access to the fortran-compiled routines. A variety of Python notebooks and example files are included that demonstrate the major features of the library.
        
        To get started, check out the following Python tutorial notebooks:
        
        * [Introduction 1: Grids and Spherical Harmonic Coefficients](https://shtools.github.io/SHTOOLS/pages/mydoc/notebooks/Introduction-1.html)
        * [Introduction 2: Localization Windows and Spectral Analysis](https://shtools.github.io/SHTOOLS/pages/mydoc/notebooks/Introduction-2.html)
        * [Introduction 3: Gravity and Magnetic Fields fields](https://shtools.github.io/SHTOOLS/pages/mydoc/notebooks/Introduction-3.html)
        
        ### DEVELOPERS ###
        
        We work on the `develop` branch and only push releases to `master`. Please base all pull requests on `develop`.
        
        ### CITATION ###
        Mark A. Wieczorek and Matthias Meschede (2018). SHTools --- Tools for working with spherical harmonics, *Geochemistry, Geophysics, Geosystems*, doi:[10.1029/2018GC007529](https://doi.org/10.1029/2018GC007529).
        
Keywords: Spherical Harmonics,Spectral Estimation,Slepian Functions,Wigner Symbols,Legendre Functions,Gravity Field,Magnetic Field
Platform: OS Independent
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Fortran
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: GIS
Classifier: Topic :: Scientific/Engineering :: Mathematics
Classifier: Topic :: Scientific/Engineering :: Physics
