README.rst 1.35 KB
Newer Older
Pierre Augier committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51

SpectrAtmo is a Python package for doing spectral analysing of GCM
results.

It uses the library for Spherical Harmonic `SHTns
<http://users.isterre.fr/nschaeff/SHTns/>`_.

License
-------

SpectrAtmo is distributed under the CeCILL-B_ License, enabling reuse
with few restrictions (GPL compatible french License).

.. _CeCILL-B: http://www.cecill.info/index.en.html

If you use SpectAtmos for research work, please `cite this paper
<http://dx.doi.org/10.1175/JAS-D-12-0281.1>`_::

  @article {AugierLindborg2013,
    author = {Pierre Augier and Erik Lindborg},
    title = {A New Formulation of the Spectral Energy Budget of the Atmosphere,
    with Application to Two High-Resolution General Circulation Models},
    journal = {J. Atmos. Sci.},
    doi = {10.1175/JAS-D-12-0281.1},
    volume = {70}, number = {7}, pages = {2293--2308},
    year = {2013},
  }


Installation
------------

Install first `SHTns <http://users.isterre.fr/nschaeff/SHTns/>`_.

If you need `grads <http://iges.org/grads/>`_ to load the data,
install it manually.

To install the package spectatmos in the development mode, from the
root directory::

  sudo python setup.py develop

Tests
-----

From the root directory or from any of the "test" directories::

  python -m unittest discover

Please report bugs and feature request on the `issue tracker
<https://bitbucket.org/paugier/spectatmos/issues>`_.