oocgcm.oceanmodels.nemo.grids.variables_holder_for_2d_grid_from_nemo_ogcm

class oocgcm.oceanmodels.nemo.grids.variables_holder_for_2d_grid_from_nemo_ogcm(nemo_coordinate_file=None, nemo_byte_mask_file=None, chunks=None, byte_mask_level=0)

This class create the dictionnary of variables used for creating a oocgcm.core.grids.generic_2d_grid from NEMO output files.

__init__(nemo_coordinate_file=None, nemo_byte_mask_file=None, chunks=None, byte_mask_level=0)

This holder uses the files meshhgr.nc and byte_mask.nc

Parameters:

nemo_coordinate_file : str

path to NEMO coordinate file associated to the model configuration.

nemo_byte_mask_file : str

path to NEMO mask file associated to the model configuration.

chunks : dict-like

dictionnary of sizes of chunk for creating xarray.DataArray.

byte_mask_level : int

index of the level from which the masks should be loaded

Methods

__init__([nemo_coordinate_file, ...]) This holder uses the files meshhgr.nc and byte_mask.nc
chunk([chunks]) Chunk all the variables.