
                       S2LET CODE
                      www.s2let.org
              Fast wavelet transforms on the sphere
  ----------------------------------------------------------------

DESCRIPTION
     The S2LET code provides functionality to perform fast and exact
     scale-discretised wavelet transforms on the sphere.

CURRENT VERSION
     Release 2.1b1, November 2016

PREVIOUS VERSIONS
     Release 2.0b1, September 2015
     Release 1.1b1, October 2013
     Release 1.0b1, November 2012

AUTHORS
     B. Leistedt   (www.ixkael.com/blog)
     M. Buttner
     J. Y. H. Chan (www.mssl.ucl.ac.uk/~yhjc2/)
     J. D. McEwen  (www.jasonmcewen.org)


REFERENCES

     J. D. McEwen, M. Büttner, B. Leistedt, H. V. Peiris and Y. Wiaux, 
     Directional spin wavelets on the sphere, IEEE TSP, submitted, 2015 
     (arXiv:1509.06749).

     J. D. McEwen, M. Büttner, B. Leistedt, H. V. Peiris and Y. Wiaux, 
     A novel sampling theorem on the rotation group, IEEE TSP, 2015
     (arXiv:1508.03101).

     B. Leistedt, J. D. McEwen, P. Vandergheynst and Y. Wiaux,
     S2LET: A code to perform fast wavelet analysis on the sphere, 
     Astronomy & Astrophysics, 558, A128, 2013 (arXiv:1211.1680). 
     
     J. D. McEwen and Y. Wiaux, A novel sampling theorem on the
     sphere, IEEE TSP, 59, 2011 (arXiv:1110.6298).

     J. D. McEwen, Ridgelet transform on the sphere, 
     IEEE TSP, submitted, 2015 (arXiv:1510.01595).

     J. Y. H. Chan, B. Leidtedt, T.D. Kitching and J. D. McEwen, 
     Second-generation curvelets on the sphere, 
     IEEE TSP, 65(1):5-14, 2017 (arXiv:1511.05578).


DOCUMENTATION
     See doc/index.html

INSTALLATION
     See documentation

REQUIREMENTS
     SSHT (http://www.spinsht.org/)
     SO3 (http://www.sothree.org/)
     FFTW (http://www.fftw.org/)

OPTIONAL
     CFITSIO (http://heasarc.gsfc.nasa.gov/fitsio/)
     HEALPIX (http://healpix.jpl.nasa.gov/)

DOWNLOAD
     http://www.s2let.org/

SUPPORT
     Please email the authors.

NOTE
     The package is in beta and is still under development.
     Please report problems/bugs by email to: boris.leistedt@gmail.com

LICENSE
     S2LET package to perform fast wavelet transform on the sphere<br>
     Copyright (C) 2012 Boris Leistedt & Jason McEwen

     This program is free software; you can redistribute it and/or
     modify it under the terms of the GNU General Public License
     as published by the Free Software Foundation; either version 2
     of the License, or (at your option) any later version.

     This program is distributed in the hope that it will be useful,
     but WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     GNU General Public License for more details (LICENSE.txt).

     You should have received a copy of the GNU General Public License
     along with this program; if not, write to the Free Software
     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, 
     MA  02110-1301, USA.
