momlevel.test_data.tripolar.horizontal module

horizontal.py - module for generating xy test data

momlevel.test_data.tripolar.horizontal.xy_fields(dset=None, point='h', seed=123)

Function to set up a simple x-y grid

This function sets up a simple horizontal grid with dimensions and axes in the style of MOM6. Returns dimensions, geolat/geolon coordinates, and a matching areacello field.

Parameters:
  • dset (xarray.core.dataset.Dataset, optional) – Existing dataset to append grid. If not specified, an empty dataset is initialized. By default, None

  • point (str, optional) – Staggered grid point of either “h”, “u”, “v”, or “c”. By default, “h”

  • 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