mpas_tools.conversion.mask

mpas_tools.conversion.mask(dsMesh, fcMask=None, logger=None, dir=None, cores=1)[source]

Use compute_mpas_region_masks to create a set of region masks either from mask feature collections

Parameters:

  • dsMesh (xarray.Dataset, optional) – An MPAS mesh on which the masks should be created

  • fcMask (geometric_features.FeatureCollection, optional) – A feature collection containing features to use to create the mask

  • logger (logging.Logger, optional) – A logger for the output if not stdout

  • dir (str, optional) – A directory in which a temporary directory will be added with files produced during mask creation and then deleted upon completion.

  • cores (int, optional) – The number of cores to use for python multiprocessing

Returns:

dsMask (xarray.Dataset) – The masks