Welcome to AI-WQ-package documentation!
=========================================

A Python library for participating in the `ECMWF AI Weather Quest <https://aiweatherquest.ecmwf.int>`__.

Overview
--------
*AI-WQ-package* is a Python library designed to streamline participation in the AI Weather Quest. This guide provides step-by-step instructions on how to:

- Submit a forecast to the AI Weather Quest competition.
- Evaluate sub-seasonal forecasts using tools developed by the AI Weather Quest.
- Download training data for initially developing sub-seasonal forecast models. 

The package leverages capability developed through `xarray <https://docs.xarray.dev/en/stable/>`__ for efficient data handling. *AI-WQ-package* requires `Python 3 <https://wiki.python.org/moin/BeginnersGuide/Download>`__, and its source code is available on `GitHub <https://github.com/joshuatalib/AI_weather_quest>`__. 

.. note::

   This project is being actively developed. New updates may be released periodically with detailed annoucements given on the `AI Weather Quest Forum <https://forum.ecmwf.int/c/workshop-and-events/ai-weather-quest/41>`__.


Contents
--------

.. toctree::
   :maxdepth: 2

   installation
   submit_forecast
   plotting_forecast
   forecast_evaluation
   training_data

License
----------

*AI-WQ-package* is released under the open source `Apache License`__.

.. __: http://www.apache.org/licenses/LICENSE-2.0.html