A python package to support forecast submission, visualisation and evaluation for S2S ML/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 | |
| 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:
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file ai_wq_package-3.27.tar.gz.
File metadata
- Download URL: ai_wq_package-3.27.tar.gz
- Upload date:
- Size: 35.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.11
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
949fc5976154e800e34055ba466b8ce4f05ced7587c4353c3b7f93446ab4ef25
|
|
| MD5 |
41a4ed0b8a54230718a85f59bf221654
|
|
| BLAKE2b-256 |
49394ae55cb3b277908b822952c3889a7ff37c03743d17b34287ca06cf87f37e
|
File details
Details for the file ai_wq_package-3.27-py3-none-any.whl.
File metadata
- Download URL: ai_wq_package-3.27-py3-none-any.whl
- Upload date:
- Size: 39.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.11
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
12aadda138fa78fe6ea72bf9128f1040138251a90f296eacb758e3e73227c8ab
|
|
| MD5 |
067baa06fcaf552d59257234abd9387b
|
|
| BLAKE2b-256 |
b3236d57c5b153003ff9f6b725facb05b9261aaee7a8aa5c192f23a15e6b9808
|