Skip to main content

CLIMADA-compatible module for generating and analyzing seasonal forecast hazards from Copernicus data

Project description

Project Logos

Copernicus Seasonal Forecast Tools

GitHub repo License PyPI version Downloads Documentation Status

Repository QR Code

This repository hosts the copernicus-seasonal-forecast-tools package, a Python module developed as part of the U-CLIMADAPT project.

The module bridges seasonal forecast data from the Copernicus Climate Data Store (CDS) with flexible data processing and climate impact modeling workflows. It supports downloading sub-daily Copernicus forecasts and aggregating them to daily resolution, enabling analysis of climate indices for impact forecasting.

Users can:

  • Convert raw Copernicus seasonal forecasts into usable daily datasets.
  • Compute heat-related climate indices (e.g., Heatwaves, Tropical Nights).
  • Generate CLIMADA-compatible hazard objects from processed forecasts.

While not part of the core CLIMADA platform, it is designed for seamless integration with CLIMADA for climate impact and risk workflows.

Documentation

For full documentation of all features and functions, please refer to the Copernicus Seasonal Forecast Tools documentation on ReadTheDocs.

Getting Started

To use this package, you must first configure access to the Copernicus Climate Data Store (CDS), which provides the seasonal forecast datasets.

We've prepared a comprehensive CDS API setup guide to walk you through each step of the process. Once configured, you'll be ready to explore and analyze seasonal forecast data.

Installation

You can install copernicus-seasonal-forecast-tools in three ways, depending on your setup and preferences.

Note: If you want to generate CLIMADA hazard objects, you must install the optional CLIMADA dependency.
For full installation instructions, see the online documentation.

1. Install via pip (recommended for most users)

pip install copernicus-seasonal-forecast-tools
git clone https://github.com/DahyannAraya/copernicus-seasonal-forecast-tools.git (optional)
pip install -r docs/requirements.txt (optional)

2. Install via environment.yml (Conda or Mamba):

git clone https://github.com/DahyannAraya/copernicus-seasonal-forecast-tools.git
conda env create -f environment.yml
conda activate venv_forecast

3. Install directly from GitHub

git clone https://github.com/DahyannAraya/copernicus-seasonal-forecast-tools.git
cd copernicus-seasonal-forecast-tools
pip install .
pip install -r docs/requirements.txt (optional)

CLIMADA Installation

CLIMADA is required to generate hazard layers.

  • If you installed via environment.yml, CLIMADA is already included.
  • If you installed from PyPI and then ran pip install -r docs/requirements.txt, CLIMADA is also installed.

Note
If you want to have all the functionalities of CLIMADA, you must install the full version.
👉 For detailed instructions, follow the official CLIMADA installation guide:
CLIMADA Installation Guide

Example of use

This section provides practical example to help users understand how to work with the copernicus-seasonal-forecast-tools package. The notebooks demonstrate key steps including downloading data, computing climate indices, and generating CLIMADA hazard objects.

  • DEMO_copernicus_forecast_seasonal.ipynb: This is the first notebook to run. It demonstrates how to install and use the seasonal_forecast_tools to download, process, and convert seasonal forecast data into a CLIMADA hazard object.

Notebooks

Notebook Open in Colab GitHub (Documentation)
DEMO Copernicus Seasonal Forecast Open In Colab View on GitHub
Download and Process Data Open In Colab View in Docs
Calculate Climate Indices Open In Colab View in Docs
Calculate a Hazard Object Open In Colab View in Docs
Example for Reading and Plotting Hazard Open In Colab View in Docs

You can find further material in Open In Colab, where we provide an extended demonstration.

License

GPL-3.0 license

Resources

Project details


Download files

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

Source Distribution

copernicus_seasonal_forecast_tools-0.1.1.tar.gz (51.5 kB view details)

Uploaded Source

Built Distribution

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

File details

Details for the file copernicus_seasonal_forecast_tools-0.1.1.tar.gz.

File metadata

File hashes

Hashes for copernicus_seasonal_forecast_tools-0.1.1.tar.gz
Algorithm Hash digest
SHA256 412aa7a4c5f8bd3f8041d33b31bfcc51296fe848c30eed7f354ff43d71e05173
MD5 eed1381dacc3be87de08a65296693cc4
BLAKE2b-256 4fdbb2294c50d2175fea1c0a1f7b22e8075006ebcbf43b59f8a0b3e4bbd2e96e

See more details on using hashes here.

File details

Details for the file copernicus_seasonal_forecast_tools-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for copernicus_seasonal_forecast_tools-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e95cc73e670893ef0c8394ec4b9ea5750d46dd30bb9a55e755aa9cfcb3f9c181
MD5 71f6ab56fe4adb08a22fd0899b89d5d0
BLAKE2b-256 5234b90e2a13eaf650dc45d05f57bf564cd02a348399da59d12ef5d1ba5d48dc

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