Metadata-Version: 2.1
Name: climpred
Version: 1.0.0
Summary: An xarray wrapper for analysis of ensemble forecast models for climate prediction.
Home-page: https://github.com/bradyrx/climpred
Maintainer: Riley X. Brady and Aaron Spring
Maintainer-email: riley.brady@colorado.edu
License: MIT
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.6
Requires-Dist: numpy
Requires-Dist: xarray
Requires-Dist: scipy
Requires-Dist: xskillscore
Requires-Dist: eofs
Provides-Extra: graphics
Requires-Dist: matplotlib ; extra == 'graphics'

.. image:: https://i.imgur.com/HPOdOsR.png

An xarray wrapper for analysis of ensemble forecast models for climate prediction.

.. image:: https://travis-ci.org/bradyrx/climpred.svg?branch=master)](https://travis-ci.org/bradyrx/climpred
    :target: https://travis-ci.org/bradyrx/climpred

.. image:: https://api.codacy.com/project/badge/Grade/a532752e9e814c6e895694463f307cd9
    :target: https://www.codacy.com/app/bradyrx/climpred?utm_source=github.com&utm_medium=referral&utm_content=bradyrx/climpred&utm_campaign=Badge_Grade

.. image:: https://coveralls.io/repos/github/bradyrx/climpred/badge.svg?branch=master
    :target: https://coveralls.io/github/bradyrx/climpred?branch=master

.. image:: https://img.shields.io/readthedocs/climpred/latest.svg?style=flat
    :target: https://climpred.readthedocs.io/en/latest/?badge=latest
    :alt: Documentation Status

.. image:: https://badges.gitter.im/Join%20Chat.svg
    :target: https://gitter.im/climpred



Release
=======

We are diligently working on our v1 release. The goal for v1 is to have ``climpred`` ready to take in subseasonal-to-seasonal and seasonal-to-decadal prediction ensembles and to perform determinstic skill metrics on them. We will have early-stage objects (``HindcastEnsemble`` and ``PerfectModelEnsemble``) to make computations easier on the user. We will also have documentation ready so the capabilities of ``climpred`` are more clear.

In the meantime, you can install the package following the steps below and reference the notebooks for guidance. Please raise any issues if you encounter any bugs or have any ideas; you can also raise a PR to add new features. Feel free to contact us if you have questions.

Installation
============

.. code-block:: bash

    pip install git+https://github.com/bradyrx/climpred

Documentation
=============

Documentation is in development and can be found on readthedocs_.

.. _readthedocs: https://climpred.readthedocs.io/en/latest/ 


