Skip to main content

A python package to support forecast submission, evaluation and access to FTP site for S2S AI prediction project

Project description

AI Weather Quest (AI-WQ-package)

Disclaimer: This package is provided for research and competition participation purposes only. It is not intended for use in any operational or production context. It is not an officially supported ECMWF software product.

Overview

AI-WQ-package is a Python library that supports participation in the ECMWF AI Weather Quest, a competition to develop and evaluate AI-based sub-seasonal forecasts.

The package enables you to:

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

It builds on xarray for efficient NetCDF-based data handling.


Installation

To install the AI-WQ-package on Linux, run the following command:

python3 -m pip install AI-WQ-package

For guidance on installing Python 3 or pip, refer to the official documentation.


Dependencies

The AI-WQ-package requires the following dependencies:

  • numpy (version 1.23 or higher)
  • xarray (version 2024.09.0 or higher)
  • dask (version 2024.9.0)
  • pandas (version 2.2.3 or higher)
  • scipy (version 1.14.1 or higher)
  • netCDF4 (version 1.7.2 or higher)
  • requests (versions 2.32.2 or higher)
  • matplotlib (versions 3.8 or higher)
  • cartopy (versions 0.22 or higher)

If these dependencies conflict with your current working environment, consider installing the package in a new virtual environment.


Upgrading the Package

To upgrade to the latest version, run:

python3 -m pip install --upgrade AI-WQ-package

This project is being actively developed. New updates may be released periodically with detailed annoucements given on the ECMWF-hosted forum.


Software Maturity

Attribute Status
Maturity Static Badge
Support level Best effort — no guaranteed response time
Operational use Not suitable for operational use

[!IMPORTANT] This software is Sandbox, is under active development, and subject to ECMWF's guidelines on Software Maturity. Releases are intended for testing, evaluation, and collaboration rather than production deployment.


License

This project is licensed under the Apache License 2.0. See the LICENSE file for the full text.


Support

This package is not officially supported by ECMWF. Community contributions and questions are welcome via GitHub Issues on the upstream repository or on the ECMWF Community Forum.

For general ECMWF-related enquiries, please use the ECMWF Service Desk.


Documentation

Full documentation is available on ReadTheDocs:

https://ecmwf-ai-weather-quest.readthedocs.io/en/latest/

Project details


Release history Release notifications | RSS feed

This version

3.11

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ai_wq_package-3.11.tar.gz (35.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ai_wq_package-3.11-py3-none-any.whl (39.7 kB view details)

Uploaded Python 3

File details

Details for the file ai_wq_package-3.11.tar.gz.

File metadata

  • Download URL: ai_wq_package-3.11.tar.gz
  • Upload date:
  • Size: 35.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.11

File hashes

Hashes for ai_wq_package-3.11.tar.gz
Algorithm Hash digest
SHA256 865c554220cc310bf5ff4d54c6d5ca0e99b4097118932007d304500bc36ee234
MD5 9263c7eee10d05d7617fcdf26860383e
BLAKE2b-256 365213586234512a709681842728dd2fad41d10546ad212242d7e347f0bacd4c

See more details on using hashes here.

File details

Details for the file ai_wq_package-3.11-py3-none-any.whl.

File metadata

  • Download URL: ai_wq_package-3.11-py3-none-any.whl
  • Upload date:
  • Size: 39.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.11

File hashes

Hashes for ai_wq_package-3.11-py3-none-any.whl
Algorithm Hash digest
SHA256 ffe6595e1d61d6c3684675e6317eebfe9aad677c78ed0c8971bb52564cdef5d0
MD5 2a9701a241e08b4fd03588f581e52d13
BLAKE2b-256 304a742c1232dcbe5e5fb15f80508353aefd650e1087b45af1978552a7c78edf

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page