====================================
pySTEPS -- The nowcasting initiative
====================================

pySTEPS is a community-driven initiative for developing and maintaining an easy
to use, modular, free and open source Python framework for short-term ensemble
prediction systems.

The focus is on probabilistic nowcasting of radar precipitation fields,
but pySTEPS is designed to allow a wider range of uses.

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

The documentation is separated in three big branches, intended for different
audiences.


:ref:`user-guide`
~~~~~~~~~~~~~~~~~

This section is intended for new pySTEPS users. It provides an introductory
overview to the pySTEPS package, explains how to install it and make use of the
most important features.

:ref:`pysteps-reference`
~~~~~~~~~~~~~~~~~~~~~~~~

Comprehensive description of all the modules and functions available in pySTEPS.

:ref:`contributors-guides`
~~~~~~~~~~~~~~~~~~~~~~~~~~

Resources and guidelines for pySTEPS developers and contributors.


Contents
========

.. toctree::
    :maxdepth: 1

    user_guide/index
    pysteps_reference/index
    developer_guide/index
    zz_bibliography


====================================
pySTEPS -- The nowcasting initiative
====================================

Pysteps is a community-driven initiative for developing and maintaining an easy
to use, modular, free and open source Python framework for short-term ensemble
prediction systems.

The focus is on probabilistic nowcasting of radar precipitation fields,
but pysteps is designed to allow a wider range of uses.

Pysteps is actively developed on GitHub__, while a more thorough description
of pysteps is available in the pysteps reference publication:

Pulkkinen, S., D. Nerini, A. Perez Hortal, C. Velasco-Forero, U. Germann,
A. Seed, and L. Foresti, 2019:  Pysteps:  an open-source Python library for
probabilistic precipitation nowcasting (v1.0). *Geosci. Model Dev. Discuss.*,
doi:10.5194/gmd-2019-94, **in review**. [source__]

__ https://github.com/pySTEPS/pysteps
__ https://www.geosci-model-dev-discuss.net/gmd-2019-94/


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

The documentation is separated in three big branches, intended for different
audiences.


:ref:`user-guide`
~~~~~~~~~~~~~~~~~

This section is intended for new pysteps users. It provides an introductory
overview to the pysteps package, explains how to install it and make use of the
most important features.

:ref:`pysteps-reference`
~~~~~~~~~~~~~~~~~~~~~~~~

Comprehensive description of all the modules and functions available in pysteps.

:ref:`contributors-guides`
~~~~~~~~~~~~~~~~~~~~~~~~~~

Resources and guidelines for pysteps developers and contributors.


Contents
========

.. toctree::
    :maxdepth: 1

    user_guide/index
    pysteps_reference/index
    developer_guide/index
    zz_bibliography

Add link to github page and reference publication
Add link to github page and reference publication
