eradiate.test_tools.regression.IndependentStudentTTest

class eradiate.test_tools.regression.IndependentStudentTTest(name, value, reference=None, *, variable='brf_srf', threshold, archive_dir, plot)[source]

Bases: AbstractStudentTTest

Independent Student’s T-test

This implementation of a Student’s T-test is following the assumption of independance of the two groups that are tested. The bias of the mean values of the two groups is assumed to be the result of chance under the null hypothesis. It is a two-tailed test.

It is less sensitive to outliers than the paired Student’s T-test.

Parameters:

  • name (str) – Test case name.

  • value (xarray.Dataset) – Simulation result. Must be specified as a dataset.

  • reference (xarray.Dataset or path-like, optional, default: None) – Reference data. Can be specified as an xarray dataset, a path to a NetCDF file or a path to a resource.

  • variable (str, default: brf_srf) – Tested variable

  • threshold (float) – Test metric threshold

  • archive_dir (path-like) – Path to output artefact storage directory. Relative paths are interpreted with respect to the current working directory.

  • plot (bool) – Enable pyplot charts

Fields:

  • name (str) – Test case name.

  • value (xarray.Dataset) – Simulation result.

  • reference (xarray.Dataset or None) – Reference data.

  • variable (str) – Tested variable.

  • threshold (float) – Test metric threshold.

  • archive_dir (pathlib.Path) – Path to output artefact storage directory.

  • plot (bool) – Enable pyplot charts.

run(diagnostic=False)

This method controls the execution steps of the regression test:

  • handle missing reference data

  • catch errors during text evaluation

  • create the appropriate plots and data archives

Returns:

bool – Result of the test criterion comparison.