veriflow.scores.probabilistic#
Probabilistic verification scores.
For verification of probabilistic and ensemble forecasts, and probabilistic historical simulations of continuous variables.
For reference, see: https://scores.readthedocs.io/en/stable/included.html#probability
Classes
|
Implementation for CRPS for probabilistic forecasts, expressed as cdf. |
|
Configuration for CRPS for CDF. |
|
Implementation for CRPS for an ensemble. |
|
Configuration for CRPS for ensemble supporting both point and gridded data. |
|
Compute the rank histogram (Talagrand diagram) over the specified dimensions. |
|
A rank histogram config element supporting both point and gridded ensemble data. |
- class veriflow.scores.probabilistic.CrpsCDF(config)[source]#
Implementation for CRPS for probabilistic forecasts, expressed as cdf.
- Parameters:
config (CrpsCDFConfig)
- config_class#
alias of
CrpsCDFConfig
- supported_data_specs: ClassVar[set[tuple[DataType, SpatialType]]] = {(DataType.simulated_forecast_probabilistic, SpatialType.point)}#
- config: CrpsCDFConfig#
- classmethod from_config(raw_config)#
Initialize class from config dict.
- class veriflow.scores.probabilistic.CrpsCDFConfig(*, reduce_dims=<factory>, score_adapter, general, crs=None, verification_pair_ids=[], integration_method='exact', **extra_data)[source]#
Configuration for CRPS for CDF.
For reference, see: https://scores.readthedocs.io/en/stable/api.html#scores.probability.crps_cdf
- Parameters:
reduce_dims (list[Literal[StandardDim.station, StandardDim.forecast_reference_time, StandardDim.lead_time, StandardDim.time, StandardDim.x, StandardDim.y]])
score_adapter (Literal[ScoreKind.crps_cdf])
general (Annotated[GeneralInfoConfig, SkipJsonSchema()])
crs (Annotated[str, FieldInfo(annotation=NoneType, required=True, description="A coordinate reference system as a string compatible with pyproj.CRS.from_string, i.e. a PROJ string, a CRS WKT string, or an authority string such as 'EPSG:4326'. The string is not parsed at configuration time so that pyproj remains an optional dependency; it is only parsed when an actual coordinate transformation is required.", metadata=[MinLen(min_length=1)])] | None)
integration_method (Literal['exact', 'trapz'])
extra_data (Any)
- integration_method: Annotated[Literal['exact', 'trapz'], FieldInfo(annotation=NoneType, required=True, description="The method of integration. 'exact' computes the exact integral, 'trapz' uses a trapezoidal rule and is an approximation of the CRPS.")]#
- validate_spatial_dims()#
Validate that x, y and station are never configured together.
- Return type:
ReduceDims
- verification_pair_ids_valid()#
Check provided filter for verification pairs contains valid ids.
- Return type:
- property verification_pairs: list[VerificationPair]#
The configured variable pairs.
If the verification_pairs element is configured for the score, filter only these ids from the verification_pairs defined in general config.
- general#
- crs#
- verification_pair_ids#
- reduce_dims#
- class veriflow.scores.probabilistic.CrpsForEnsemble(config)[source]#
Implementation for CRPS for an ensemble.
- Parameters:
config (CrpsForEnsembleConfig)
- config_class#
alias of
CrpsForEnsembleConfig
- supported_data_specs: ClassVar[set[tuple[DataType, SpatialType]]] = {(DataType.simulated_forecast_ensemble, SpatialType.gridded), (DataType.simulated_forecast_ensemble, SpatialType.point)}#
- config: CrpsForEnsembleConfig#
- classmethod from_config(raw_config)#
Initialize class from config dict.
- class veriflow.scores.probabilistic.CrpsForEnsembleConfig(*, reduce_dims=<factory>, score_adapter, general, crs=None, verification_pair_ids=[], method='ecdf', **extra_data)[source]#
Configuration for CRPS for ensemble supporting both point and gridded data.
For reference, see: See: https://scores.readthedocs.io/en/stable/api.html#scores.probability.crps_for_ensemble
- Parameters:
reduce_dims (list[Literal[StandardDim.station, StandardDim.forecast_reference_time, StandardDim.lead_time, StandardDim.time, StandardDim.x, StandardDim.y]])
score_adapter (Literal[ScoreKind.crps_for_ensemble])
general (Annotated[GeneralInfoConfig, SkipJsonSchema()])
crs (Annotated[str, FieldInfo(annotation=NoneType, required=True, description="A coordinate reference system as a string compatible with pyproj.CRS.from_string, i.e. a PROJ string, a CRS WKT string, or an authority string such as 'EPSG:4326'. The string is not parsed at configuration time so that pyproj remains an optional dependency; it is only parsed when an actual coordinate transformation is required.", metadata=[MinLen(min_length=1)])] | None)
method (Literal['ecdf', 'fair'])
extra_data (Any)
- method: Annotated[Literal['ecdf', 'fair'], FieldInfo(annotation=NoneType, required=False, default='ecdf', description='Method to compute the cumulative distribution function from an ensemble.')]#
- validate_spatial_dims()#
Validate that x, y and station are never configured together.
- Return type:
ReduceDims
- verification_pair_ids_valid()#
Check provided filter for verification pairs contains valid ids.
- Return type:
- property verification_pairs: list[VerificationPair]#
The configured variable pairs.
If the verification_pairs element is configured for the score, filter only these ids from the verification_pairs defined in general config.
- general#
- crs#
- verification_pair_ids#
- reduce_dims#
- class veriflow.scores.probabilistic.RankHistogram(config)[source]#
Compute the rank histogram (Talagrand diagram) over the specified dimensions.
For external documentation, see below: https://scores.readthedocs.io/en/stable/api.html#scores.probability.rank_histogram
- Parameters:
config (RankHistogramConfig)
- config_class#
alias of
RankHistogramConfig
- supported_data_specs: ClassVar[set[tuple[DataType, SpatialType]]] = {(DataType.simulated_forecast_ensemble, SpatialType.gridded), (DataType.simulated_forecast_ensemble, SpatialType.point)}#
- config: RankHistogramConfig#
- static validate_has_rank_dim(result)[source]#
Validate that the rank histogram result has the expected ‘rank’ dimension.
- classmethod from_config(raw_config)#
Initialize class from config dict.
- class veriflow.scores.probabilistic.RankHistogramConfig(*, reduce_dims=<factory>, score_adapter, general, crs=None, verification_pair_ids=[], **extra_data)[source]#
A rank histogram config element supporting both point and gridded ensemble data.
- Parameters:
reduce_dims (list[Literal[StandardDim.station, StandardDim.forecast_reference_time, StandardDim.lead_time, StandardDim.time, StandardDim.x, StandardDim.y]])
score_adapter (Literal[ScoreKind.rank_histogram])
general (Annotated[GeneralInfoConfig, SkipJsonSchema()])
crs (Annotated[str, FieldInfo(annotation=NoneType, required=True, description="A coordinate reference system as a string compatible with pyproj.CRS.from_string, i.e. a PROJ string, a CRS WKT string, or an authority string such as 'EPSG:4326'. The string is not parsed at configuration time so that pyproj remains an optional dependency; it is only parsed when an actual coordinate transformation is required.", metadata=[MinLen(min_length=1)])] | None)
extra_data (Any)
- validate_spatial_dims()#
Validate that x, y and station are never configured together.
- Return type:
ReduceDims
- verification_pair_ids_valid()#
Check provided filter for verification pairs contains valid ids.
- Return type:
- property verification_pairs: list[VerificationPair]#
The configured variable pairs.
If the verification_pairs element is configured for the score, filter only these ids from the verification_pairs defined in general config.
- general#
- crs#
- verification_pair_ids#
- reduce_dims#