momlevel.test_data package¶
test_data - module for generating test data
- momlevel.test_data.generate_test_data(start_year=1981, nyears=0, calendar='noleap', seed=123)¶
Function to generate dataset for unit testing
This function generates a test dataset. It includes 5 points in the vertical, latitudinal, and longitudinal dimensions. The dataset contains random values for thetao, so, volcello, deptho and areacello.
If nyears == 0 (default), the time coordinate is a 5 point integer array. If nyears >= 1, a real world monthly time axis is generated.
- Parameters:
start_year (int, optional) – Starting year, by default 1981
nyears (int, optional) – Number of years to generate, by default 0
calendar (str, optional) – CF-time recognized calendar, by default “noleap”
seed (int, optional) – Random number generator seed. By default, 123
- Returns:
ntimes x 5 x 5 x 5 point dataset for unit testing
- Return type:
xarray.core.dataset.Dataset
- momlevel.test_data.generate_test_data_dz(seed=123)¶
Function to generate test dataset for partial bottom cells
- Parameters:
seed (int, optional) – Random number generator seed. By default, 123
- Return type:
xarray.core.dataset.Dataset
- momlevel.test_data.generate_test_data_uv(start_year=1981, nyears=0, calendar='noleap', seed=123)¶
Function to generate dataset for unit testing
This function generates a test dataset. It includes 5 points in the vertical, latitudinal, and longitudinal dimensions. The dataset contains random values for uo, vo, Coriolis, and areacello_bu. The dataset also includes the dyCv and dxCu grid information.
If nyears == 0 (default), the time coordinate is a 5 point integer array. If nyears >= 1, a real world monthly time axis is generated.
- Parameters:
start_year (int, optional) – Starting year, by default 1981
nyears (int, optional) – Number of years to generate, by default 0
calendar (str, optional) – CF-time recognized calendar, by default “noleap”
seed (int, optional) – Random number generator seed. By default, 123
- Returns:
ntimes x 5 x 5 x 5 point dataset for unit testing
- Return type:
xarray.core.dataset.Dataset