earthkit.meteo.regimes

Weather regimes based on projections onto spatial patterns.

• To define a collection or generator of patterns, use the provided generator classes to implement your desired scheme or define your own pattern generator scheme based on the abstract base class Patterns.

• To compute regime indices, use the functions project() and regime_index() together with a given pattern collection/generator.

Note

At the moment, only regular lat-lon grids are supported for the specification of patterns:

{
    "grid": [lon_spacing, lat_spacing],
    "area": [lat0, lon0, lat1, lon1]
}

Submodules

• earthkit.meteo.regimes.array
• earthkit.meteo.regimes.xarray

Classes

ConstantPatterns	Collection of constant/fixed patterns.
ModulatedPatterns	Patterns generated from a set of base patterns and a custom scalar function.
Patterns	Collection/Generator of patterns.

Functions

project(field, patterns, weights, **patterns_extra_coords)	Project onto the given patterns.
regime_index(projections, mean, std)	Regime index by standardisation of projections onto patterns.