momlevel.test_data.tripolar.vertical module¶
vertical.py - module for generating z-level test data
- momlevel.test_data.tripolar.vertical.zlevel_fields(dset=None, include_deptho=True, seed=123)¶
Function to set up a simple z-level vertical grid
This function sets up a simple vertical grid with dimensions and axes in the style of MOM6. Returns depth level centers and interfaces and an optional matching deptho field.
- Parameters:
dset (xarray.core.dataset.Dataset, optional) – Existing dataset to append grid. If not specified, an empty dataset is initialized. By default, None
include_deptho (bool, optional) – Include a matching deptho field. By default, True
seed (int, optional) – Random number generator seed. By default, 123
- Returns:
5-vertical-level dataset for unit testing
- Return type:
xarray.core.dataset.Dataset