.. Docstrings formatted according to:
   numpy guide:      https://numpydoc.readthedocs.io/en/latest/format.html
   matplotlib guide: https://matplotlib.org/devel/documenting_mpl.html
.. Sphinx is used following this guide (less traditional approach):
   https://daler.github.io/sphinxdoc-test/includeme.html

ClimoPy
=======

|build-status| |coverage| |docs| |license| |pr-welcome|

This package is meant to help climate scientists complete a variety of data analysis tasks.
It provides handy functions for objective and statistical analysis methods, deriving physical quantities, and downloading archived observational and model data.
The Github page is `here <https://github.com/lukelbd/climopy>`__.

Please note this package is a work-in-progress! The examples and documentation
are incomplete, and undiscovered bugs may exist.

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

The latest release can be installed or updated from PyPi as follows:

.. code-block:: bash

   pip install climopy
   pip install --upgrade climopy


Documentation
-------------
The documentation is `published on readthedocs <https://climopy.readthedocs.io>`__.


.. |build-status| image:: https://img.shields.io/travis/lukelbd/climopy.svg?style=flat
    :alt: build status
    :target: https://travis-ci.org/lukelbd/climopy

.. |coverage| image:: https://codecov.io/gh/lukelbd/climopy.org/branch/master/graph/badge.svg
    :alt: coverage
    :target: https://codecov.io/gh/lukelbd/climopy.org

.. |license| image:: https://img.shields.io/github/license/lukelbd/climopy.svg
   :alt: license
   :target: LICENSE.txt

.. |docs| image:: https://readthedocs.org/projects/climopy/badge/?version=latest
    :alt: docs
    :target: https://climopy.readthedocs.io/en/latest/?badge=latest

.. |pr-welcome| image:: https://img.shields.io/badge/PR-Welcome-%23FF8300.svg?
   :alt: PR welcome
   :target: https://git-scm.com/book/en/v2/GitHub-Contributing-to-a-Project

..
.. |quality| image:: https://api.codacy.com/project/badge/Grade/931d7467c69c40fbb1e97a11d092f9cd
   :alt: quality
   :target: https://www.codacy.com/app/lukelbd/climopy?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=lukelbd/climopy&amp;utm_campaign=Badge_Grade

