aurora.test_utils.mth5 package

Submodules

aurora.test_utils.mth5.fc_helpers module

This module contains functions to used by test that involve Fourier Coefficients in MTH5.

aurora.test_utils.mth5.fc_helpers.read_fc_csv(csv_name: Path | str, as_xarray: bool | None = True) → Dataset | DataFrame[source]

Load Fourier coefficients from a csv file and return as xarray or dataframe

Usage: xrds_obj = read_fc_csv(csv_name) df = read_fc_csv(csv_name, as_xarry=False)

Parameters:

  • csv_name (Union[pathlib.Path, str]) – Path to csv file to read

  • as_xarray (Optional[bool]) – If true return xr.Dataset

Returns:

output

Return type:

xr.Dataset or pd.DataFrame

Module contents