Metrics

metrics

metrics

This module exposes the functions to compute metrics.

Functions

Name	Description
deviation_of_lagrangian_trajectories_compared_to_glo12_analysis	Compute the deviation of Lagrangian trajectories compared to GLO12 analysis.
deviation_of_lagrangian_trajectories_compared_to_glorys_reanalysis	Compute the deviation of Lagrangian trajectories compared to GLORYS reanalysis.
rmsd_of_geostrophic_currents_compared_to_glo12_analysis	Compute the Root Mean Square Deviation (RMSD) of geostrophic currents compared to GLO12 analysis.
rmsd_of_geostrophic_currents_compared_to_glorys_reanalysis	Compute the Root Mean Square Deviation (RMSD) of geostrophic currents compared to GLORYS reanalysis.
rmsd_of_mixed_layer_depth_compared_to_glo12_analysis	Compute the Root Mean Square Deviation (RMSD) of Mixed Layer Depth (MLD) compared to GLO12 analysis.
rmsd_of_mixed_layer_depth_compared_to_glorys_reanalysis	Compute the Root Mean Square Deviation (RMSD) of Mixed Layer Depth (MLD) compared to GLORYS reanalysis.
rmsd_of_variables_compared_to_glo12_analysis	Compute the Root Mean Square Deviation (RMSD) of variables compared to GLO12 analysis.
rmsd_of_variables_compared_to_glorys_reanalysis	Compute the Root Mean Square Deviation (RMSD) of variables compared to GLORYS reanalysis.
rmsd_of_variables_compared_to_observations	Compute the Root Mean Square Deviation (RMSD) of variables compared to observations.

deviation_of_lagrangian_trajectories_compared_to_glo12_analysis

metrics.deviation_of_lagrangian_trajectories_compared_to_glo12_analysis(
    challenger_dataset,
    region='global',
)

Compute the deviation of Lagrangian trajectories compared to GLO12 analysis.

Parameters

Name	Type	Description	Default
challenger_dataset	xarray.Dataset	The challenger dataset.	required
region	str	The OceanBench region to evaluate on.	`'global'`

Returns

Name	Type	Description
	DataFrame	The DataFrame containing the scores.

deviation_of_lagrangian_trajectories_compared_to_glorys_reanalysis

metrics.deviation_of_lagrangian_trajectories_compared_to_glorys_reanalysis(
    challenger_dataset,
    region='global',
)

Compute the deviation of Lagrangian trajectories compared to GLORYS reanalysis.

Parameters

Name	Type	Description	Default
challenger_dataset	xarray.Dataset	The challenger dataset.	required
region	str	The OceanBench region to evaluate on.	`'global'`

Returns

Name	Type	Description
	DataFrame	The DataFrame containing the scores.

rmsd_of_geostrophic_currents_compared_to_glo12_analysis

metrics.rmsd_of_geostrophic_currents_compared_to_glo12_analysis(
    challenger_dataset,
    region='global',
)

Compute the Root Mean Square Deviation (RMSD) of geostrophic currents compared to GLO12 analysis.

Parameters

Name	Type	Description	Default
challenger_dataset	xarray.Dataset	The challenger dataset.	required
region	str	The OceanBench region to evaluate on.	`'global'`

Returns

Name	Type	Description
	DataFrame	The DataFrame containing the scores.

rmsd_of_geostrophic_currents_compared_to_glorys_reanalysis

metrics.rmsd_of_geostrophic_currents_compared_to_glorys_reanalysis(
    challenger_dataset,
    region='global',
)

Compute the Root Mean Square Deviation (RMSD) of geostrophic currents compared to GLORYS reanalysis.

Parameters

Name	Type	Description	Default
challenger_dataset	xarray.Dataset	The challenger dataset.	required
region	str	The OceanBench region to evaluate on.	`'global'`

Returns

Name	Type	Description
	DataFrame	The DataFrame containing the scores.

rmsd_of_mixed_layer_depth_compared_to_glo12_analysis

metrics.rmsd_of_mixed_layer_depth_compared_to_glo12_analysis(
    challenger_dataset,
    region='global',
)

Compute the Root Mean Square Deviation (RMSD) of Mixed Layer Depth (MLD) compared to GLO12 analysis.

Parameters

Name	Type	Description	Default
challenger_dataset	xarray.Dataset	The challenger dataset.	required
region	str	The OceanBench region to evaluate on.	`'global'`

Returns

Name	Type	Description
	DataFrame	The DataFrame containing the scores.

rmsd_of_mixed_layer_depth_compared_to_glorys_reanalysis

metrics.rmsd_of_mixed_layer_depth_compared_to_glorys_reanalysis(
    challenger_dataset,
    region='global',
)

Compute the Root Mean Square Deviation (RMSD) of Mixed Layer Depth (MLD) compared to GLORYS reanalysis.

Parameters

Name	Type	Description	Default
challenger_dataset	xarray.Dataset	The challenger dataset.	required
region	str	The OceanBench region to evaluate on.	`'global'`

Returns

Name	Type	Description
	DataFrame	The DataFrame containing the scores.

rmsd_of_variables_compared_to_glo12_analysis

metrics.rmsd_of_variables_compared_to_glo12_analysis(
    challenger_dataset,
    region='global',
)

Compute the Root Mean Square Deviation (RMSD) of variables compared to GLO12 analysis.

Parameters

Name	Type	Description	Default
challenger_dataset	xarray.Dataset	The challenger dataset.	required
region	str	The OceanBench region to evaluate on.	`'global'`

Returns

Name	Type	Description
	DataFrame	The DataFrame containing the scores.

rmsd_of_variables_compared_to_glorys_reanalysis

metrics.rmsd_of_variables_compared_to_glorys_reanalysis(
    challenger_dataset,
    region='global',
)

Compute the Root Mean Square Deviation (RMSD) of variables compared to GLORYS reanalysis.

Parameters

Name	Type	Description	Default
challenger_dataset	xarray.Dataset	The challenger dataset.	required
region	str	The OceanBench region to evaluate on.	`'global'`

Returns

Name	Type	Description
	DataFrame	The DataFrame containing the scores.

rmsd_of_variables_compared_to_observations

metrics.rmsd_of_variables_compared_to_observations(
    challenger_dataset,
    region='global',
)

Compute the Root Mean Square Deviation (RMSD) of variables compared to observations.

Parameters

Name	Type	Description	Default
challenger_dataset	xarray.Dataset	The challenger dataset.	required
region	str	The OceanBench region to evaluate on.	`'global'`

Returns

Name	Type	Description
	DataFrame	The DataFrame containing the scores.