mpas_tools.mesh.conversion.mask

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

Create region masks on an MPAS mesh using compute_mpas_region_masks.

Parameters:

  • dsMesh (xarray.Dataset) – MPAS mesh dataset.

  • fcMask (geometric_features.FeatureCollection, optional) – Feature collection with regions to mask.

  • logger (logging.Logger, optional) – Logger for capturing output.

  • dir (str, optional) – Directory in which to create a temporary working directory.

  • cores (int, optional) – Number of processes for Python multiprocessing.

Returns:

dsMask (xarray.Dataset) – Dataset containing the computed masks.

Notes

  • Requires compute_mpas_region_masks command-line tool.

  • Temporary files are created and deleted automatically.