API docs

Metrics

Deterministic Metrics

metrics.Metric()	Base class for metrics.
metrics.MSE([wind_vector_mse])	Mean squared error.
metrics.SpatialMSE()	MSE without spatial averaging.
metrics.MAE()	Mean absolute error.
metrics.SpatialMAE()	Mean absolute error without spatial averaging.
metrics.Bias()	Bias.
metrics.SpatialBias()	Bias without spatial averaging.
metrics.ACC(climatology)	Anomaly correlation coefficient.
metrics.SEEPS(climatology[, ...])	Spatially averaged SEEPS.
metrics.SpatialSEEPS(climatology[, ...])	Computes Stable Equitable Error in Probability Space.

Probabilistic Metrics

metrics.EnsembleMetric([ensemble_dim])	Ensemble metric base class.
metrics.CRPS([ensemble_dim])	Continuous Ranked Probability Score, averaged over space and time.
metrics.SpatialCRPS([ensemble_dim])	CRPS without spatial averaging.
metrics.CRPSSpread([ensemble_dim])	The spread measure associated with CRPS, E|X - X'|.
metrics.SpatialCRPSSpread([ensemble_dim])	CRPSSpread without spatial averaging.
metrics.CRPSSkill([ensemble_dim])	The skill measure associated with CRPS, E|X - Y|.
metrics.SpatialCRPSSkill([ensemble_dim])	CRPSSkill without spatial averaging.
metrics.EnsembleVariance([ensemble_dim])	The variance of an ensemble of forecasts.
metrics.SpatialEnsembleVariance([ensemble_dim])	Ensemble variance without spatial averaging.
metrics.EnsembleMeanMSE([ensemble_dim])	Mean square error between the ensemble mean and ground truth.
metrics.SpatialEnsembleMeanMSE([ensemble_dim])	EnsembleMeanMSE (MSE, not RMSE), without spatial averaging.
metrics.EnergyScore([ensemble_dim])	The Energy Score along with spread and skill parts.
metrics.EnergyScoreSpread([ensemble_dim])	The spread measure associated with EnergyScore, E‖X - X'‖.
metrics.EnergyScoreSkill([ensemble_dim])	The skill measure associated with EnergyScore, E‖X - Y‖.
metrics.RankHistogram([ensemble_dim, num_bins])	Histogram of truth's rank with respect to forecast ensemble members.
metrics.GaussianCRPS()	The analytical formulation of CRPS for a Gaussian.

Config

config.Selection(variables, time_slice[, ...])	Select a sub-set of forecast and truth data.
config.Paths(forecast, obs, output_dir[, ...])	Configuration for input and output paths.
config.Data(selection, paths[, by_init, ...])	Data configuration class combining Selection and Paths.
config.Eval(metrics[, regions, ...])	Evaluation configuration class.
config.Viz(results[, save_kwargs, colors, ...])	Visualization configuration class.
config.Panel(metric, variable[, level, ...])	Config for each panel.

Regions

regions.Region()	Region selector for spatially averaged metrics.
regions.SliceRegion([lat_slice, lon_slice])	Latitude-longitude box selection.
regions.ExtraTropicalRegion([threshold_lat])	Latitude-longitude box selection.
regions.LandRegion(land_sea_mask[, threshold])	Selects land grid point.
regions.CombinedRegion([regions])	Sequentially applies regions selections.

Derived Variables

derived_variables.DerivedVariable()	Derived variable base class.
derived_variables.WindSpeed(u_name, v_name)	Compute wind speed.
derived_variables.WindDivergence([u_name, ...])	Compute wind divergence.
derived_variables.WindVorticity([u_name, v_name])	Compute wind vorticity.
derived_variables.VerticalVelocity([u_name, ...])	Compute vertical wind velocity, assuming the hydrostatic approximation.
derived_variables.EddyKineticEnergy([...])	Compute eddy kinetic energy.
derived_variables.GeostrophicWindSpeed([...])	Calculate geostrophic wind speed.
derived_variables.AgeostrophicWindSpeed([...])	Calculate ageostrophic wind speed.
derived_variables.UComponentOfAgeostrophicWind([...])	East-west component of ageostrophic wind.
derived_variables.VComponentOfAgeostrophicWind([...])	North-south component of ageostrophic wind.
derived_variables.LapseRate([...])	Compute lapse rate in temperature.
derived_variables.TotalColumnWater([...])	Compute total column water.
derived_variables.IntegratedWaterTransport([...])	Compute integrated horizontal water transport in a vertical column.
derived_variables.RelativeHumidity([...])	Calculate relativity humidity from specific humidity.
derived_variables.PrecipitationAccumulation(...)	Compute precipitation accumulation from hourly accumulations.
derived_variables.AggregatePrecipitationAccumulation(...)	Compute longer aggregation periods from existing shorter accumulations.
derived_variables.ZonalEnergySpectrum(...)	Energy spectrum along the zonal direction.

Evaluation

evaluation.open_source_files(forecast_path, ...)	Open forecast and ground obs Zarr files and standardize them.
evaluation.open_forecast_and_truth_datasets(...)	Open datasets and select desired slices.
evaluation.evaluate_in_memory(data_config, ...)	Run evaluation in memory.
evaluation.evaluate_with_beam(data_config, ...)	Run evaluation with a Beam pipeline.