Skip to main content

CFT — Climate Forecasting Toolbox

A Python-based tool for statistical climate forecasting, developed by the SADC Climate Services Centre (CSC).

PyPI Read the Docs License: MIT

Table of Contents

Introduction

CFT is a Python-based tool for statistical climate forecasting. From version 7, it consists of six modules:

Module Since Description
Download v6.0 (CDS support added) Downloads predictor/predictand data from CDS, IRIDL, and JMA
Forecast updated in v5 Builds and cross-validates statistical seasonal forecast models
Products (observed) v7.0 Derives agro-climatic products, such as rainy season onset, from observed daily rainfall
Zoning v3 Spatial regionalization of station data into forecast zones
Verification v4 Forecast skill verification
Synthesis v4 Synthesis of forecast outputs

Modules

Download module

Downloads the following data types:

  1. Gridded predictors from CDS — SST, GPH, rainfall, and air temperature, from all models available on CDS as of July 2026 (except UKMO)
  2. Gridded predictand from CDS — rainfall and temperature from the CDS ERA5 dataset
  3. Gridded predictors from IRIDL (legacy) — SST
  4. Gridded predictand from IRIDL (legacy) — CHIRPS precipitation
  5. Gridded forecast/hindcast data from IRIDL (legacy) — SST, precipitation, and geopotential height, for three NMME models operational as of August 2025
  6. Teleconnection indices from JMA (chosen for lowest latency) — IOD, Niño3, Niño4

Data are downloaded to a user-selected directory and converted to a format ingestible by the rest of CFT.

Forecast module

Predictand types: gridded data, or station data

Predictor types:

  • Observed teleconnection indices
  • Observed gridded data (SST)
  • Forecasted gridded fields (not yet implemented)

Forecast output levels:

  • Grid — if the predictand is gridded
  • Zones — if the predictand is gridded or station data; data are spatially aggregated into a zonal average and the forecast is generated for that average
  • Points — if the predictand is station data

Pre-processing approaches:

Approach Description Applicable to
PCR Gridded predictor is reduced to Principal Components (EOFs), used as predictors in the statistical model Gridded predictor, any predictand
CCA Canonical components derived jointly from predictor and predictand —
None No dimensionality reduction Gridded predictor, any predictand

Statistical models: OLS regression, MLP regression, Decision Trees, Random Forest, Lasso regression, Ridge regression

Forecast types: deterministic, and tercile probabilistic. The tercile forecast is also presented as a 4-category forecast, splitting the normal category into normal-to-above and normal-to-below (no probabilities are allocated to these two split categories).

Cross-validation: all forecasts are cross-validated, using either leave-one-out or k-fold. Skill indices are calculated from out-of-fold predictions:

  • ROC score (above / below / normal)
  • RPSS
  • Correlation
  • Heidke skill score (highest-probability category)
  • Ignorance score
  • Reliability score
  • Brier skill score
  • 2AFC

Calibration: probabilistic forecasts are calibrated via quantile mapping — a quantile transform is developed from overlapping hindcast and observed predictand data, then applied to both hindcast and forecast.

Products (observed) module

New in v7.0. Derives agro-climatic products from observed daily rainfall. The first group of products is the onset of the rainy season; further product groups will be added in later versions.

Input data:

  • Gridded data — netCDF file with daily rainfall (time, lat, lon)
  • Station data — CSV file with dates in the first column and one column per station; the top three rows hold station ID, latitude and longitude (ID, Lat, Lon), the same layout as station data in the forecast module

Grid cells and stations without any data are skipped. Negative values, and values equal to the user-defined missing value code, are treated as missing.

Rainfall regime. Onset is calculated separately for summer and winter rainfall locations. The regime of each location is either:

  • derived from the data — a location is summer rainfall if at least ⅔ of its annual rainfall in the climatological period falls in October–March, winter rainfall if at least ⅔ falls in April–September, and all-year rainfall otherwise; or
  • read from a regime map — a netCDF file coded 1 for summer and 2 for winter rainfall (any other value is treated as all-year rainfall).

Onset is not calculated for all-year rainfall locations.

Season definition. For each regime, the user sets the month in which the season starts and the length of the onset search window. The start month should fall in the dry season, before any plausible onset. Onset is searched for from day 1 of that month until the end of the search window; if the onset criterion is not met within the window, the season is reported as having no onset.

Regime Default season start Default search window
Summer rainfall 1 October 123 days (to 31 January)
Winter rainfall 1 March 153 days (to 31 July)

Each season is labelled with the year in which it starts; e.g. the summer season 2020 is the one starting on 1 October 2020.

Onset definitions:

Product Definition
Onset A First day on which rainfall accumulated over 10 days reaches 25 mm (Tadross et al., 2007)
Onset B As Onset A, but not followed by a dry spell of 10 or more consecutive days in the following 20 days
Onset C First day on which rainfall accumulated over 4 days reaches 45 mm
Onset D First day on which rainfall accumulated over 3 days reaches 20 mm, not followed by a dry spell of 10 consecutive days in the following 10 days

Accumulations are trailing sums, and the onset day is the day on which the threshold is reached. A dry day is a day with less than 1 mm of rainfall.

Outputs (for each selected onset definition):

Variable Dimensions Description
onsetDate season, location date of onset
onsetDoy season, location day of the calendar year of onset (1–366)
onsetDekad season, location dekad of the calendar year of onset (1–36)
onsetDaysSinceAnchor season, location days from the season start to onset (0 = season start)
onsetDekadsSinceAnchor season, location dekads from the season start to onset
onsetDoyClim, onsetDekadClim location climatological onset — day of year and dekad
onsetDoyAnom, onsetDekadAnom season, location onset anomaly in days and in dekads; positive values mean later than normal
anchorDate season, location start date of the season
regime location rainfall regime: 1 — summer, 2 — winter
anchorMonth location season start month

A value of -99 means that no onset was found within the search window; missing values mean missing data, or a location that was not processed (no data, or all-year rainfall regime).

The climatology is the mean onset over the climatological period, excluding seasons without onset. Climatology and anomalies are calculated on days counted from the season start, so they are not affected by the year end in summer rainfall seasons that span two calendar years.

Gridded input produces one netCDF file per onset definition, on the same grid as the input data. Station input produces one CSV file per onset definition and output variable, with the same ID/Lat/Lon header rows as the input.

Parallel processing: calculations can be run in parallel over locations, using a fraction of the available CPUs (set as fractionCpus in deep_config.json).

Other modules — Zoning, Verification, Synthesis

The zoning module was adapted to run under the v5 environment in v5.1.

Note: the verification and synthesis modules have not yet been updated to the same extent as the modules above, and aren't documented in detail here yet. (more to follow)

Requirements

  • Python 3.12 (recommended for v6.0)
  • All Python package dependencies are installed automatically via pip — see pyproject.toml for the full list. Notably: numpy, pandas, geopandas, xarray, rioxarray, scipy, shapely, rasterio, rasterstats, scikit-learn, netCDF4, cftime, geocube, GDAL, matplotlib, cartopy, PyQt5, cdsapi.

Installation

1. Set up a Python environment

Installation should be done into a dedicated Python environment. You'll need one of:

Once installed, create a dedicated environment:

mamba create --name cft-env python=3.12

2. Install GDAL first, separately

pip does not reliably handle the GDAL system library, so it must be pre-installed via conda/mamba before installing the sadc-cft package itself:

mamba activate cft-env
mamba install -c conda-forge gdal=3.13.2

3. Install CFT with pip

pip install sadc-cft

4. Confirm the installation

python -m cft

This should launch the main CFT GUI.

Usage — GUI

Activate the environment first, as always:

mamba activate cft-env

Launch the main GUI:

cft

or equivalently:

python -m cft

Launch an individual module directly (forecast, verification, synthesis, zoning, download, products):

forecast-tool

or equivalently:

python -m cft.forecast

(substitute download-tool / verification-tool / synthesis-tool / zoning-tool, or cft.download / cft.verification / cft.synthesis / cft.zoning / cft.products_obs, as needed)

Usage — without GUI

Individual components can be called directly from Python, without launching any GUI.

Forecast

from cft.functions.functions_forecast import computeModelNoGui

computeModelNoGui(config)

where config is a dictionary of forecast model settings, for example:

config = {
    'rootDir': '../test',
    'predictorYear': 2026,
    'predictorMonth': 'Jun',
    'fcstTargetSeas': 'Aug-Oct',
    'fcstTargetYear': 2026,
    'climEndYr': 2015,
    'climStartYr': 1994,
    'predictorExtents': {
        'minLon': -180.0,
        'maxLon': 180.0,
        'minLat': -60.0,
        'maxLat': 60.0,
    },
    'predictorFileName': '/work/code/csc/cft/test/GPH850_System9_CDS_Jun_s300s200e150e250_1981-2026.nc',
    'predictorVar': 'z',
    'predictorCode': 'z',
    'crossval': 'KF',
    'preproc': 'PCR',
    'regression': 'OLS',
    'timeAggregation': 'mean',
    'predictandFileName': '../test/PRCP_CHIRPSp25_IRIDL_Aug-Oct_s340s200e150e250_1981-2025.nc',
    'predictandVar': 'prcp',
    'predictandCategory': 'temperature',
    'predictandMissingValue': '-999',
    'zonesFile': None,
    'zonesAttribute': 'Name',
    'zonesAggregate': False,
    'regridPredictand': False,
    'overlayFile': '../gis/sadc/gadm41_ZAF_1.json',
}

Products (observed)

from cft.functions.functions_products import computeProductsNoGui

computeProductsNoGui(config)

where config is a dictionary of settings, for example:

config = {
    'outDir': '../output',
    'obsFile': '../test/PRCP_CHIRPS_daily_1981-2025.nc',  # .nc (grid) or .csv (stations)
    'obsVar': 'prcp',                                     # ignored for csv
    'obsMissingValue': '',                                # e.g. '-999', '' if none
    'obsDsetCode': 'chirps',                              # used in output file names
    'climStartYr': 1991,
    'climEndYr': 2020,
    'regimeFile': '',                                     # '' - derive regime from data
    'onsetAnchorMonth': {'summer': 10, 'winter': 3},      # season start month
    'onsetWindowDays': {'summer': 123, 'winter': 153},    # onset search window, days
    'parallelize': True,
    'products': {'onsetA': True, 'onsetB': True, 'onsetC': False, 'onsetD': False},
}

Credits

Original developer (2017–2022): Thembani Moitlhobogi

Development/funding History

  • 2010–2017: original version developed under funding from the SADC CSC project SARCIS-DR.
  • November 2022: code ported from the original personal repo (taxmanyana/cft) to the institutional repo, sadc-csc/cft.
  • 2023–2025: development funded under the SADC CSC ClimSA project.
  • Versions after 6.0 developed under funding from the First Rains project.

Source code: maintained at github.com/sadc-csc since v4.0.0. From v6.0.0, also available as a pip package: pypi.org/project/sadc-cft.

Metadata

Release files for sadc-cft 7.0.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for sadc-cft 7.0.3
File Size Uploaded
sadc_cft-7.0.3.tar.gz 143.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for sadc-cft 7.0.3
File Interpreter ABI Platform
sadc_cft-7.0.3-py3-none-any.whl Python 3 none any Details

Total release size: 300.8 kB

Release files / sadc_cft-7.0.3.tar.gz

Download URL sadc_cft-7.0.3.tar.gz
Size 143.8 kB
Tags Source
SHA-256 checksum
How to use checksums
dbf449878d789bcd906494efdcd77d2738118e87ccf65d98960e74def808b11c
BLAKE2b-256 checksum
How to use checksums
b67ffbe2197f78b17896584881718168c3be4150f7cc00445cdc19a3bb6ea1a5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.13

Release files / sadc_cft-7.0.3-py3-none-any.whl

Download URL sadc_cft-7.0.3-py3-none-any.whl
Size 157.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
57eb3d2e600c59e97d1cbf0f021165fe452f4a26baf1fb7e2c0211a26000c912
BLAKE2b-256 checksum
How to use checksums
a8d30d8207396338d5cd5be62883be32238f031b55c510ec81ce61d2f0c96d62
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.13

Release history Release notifications | RSS feed

7.0.4

2 release files

This release

7.0.3 This release

2 release files

7.0.2

2 release files

7.0.1

2 release files

7.0.0

2 release files

6.0.20

2 release files

6.0.19

2 release files

6.0.18

2 release files

6.0.17

2 release files

6.0.16

2 release files

6.0.15

2 release files

6.0.14

2 release files

6.0.12

2 release files

6.0.11

2 release files

6.0.9

2 release files

6.0.8

2 release files

6.0.7

2 release files

6.0.6

2 release files

6.0.5

2 release files

6.0.4

2 release files

6.0.2

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page