API reference

This page provides an auto-generated summary of the MPAS mesh-tools API. For more details and examples, refer to the relevant chapters in the main part of the documentation.

MPAS mesh tools

translate(mesh[, xOffset, yOffset])

Translates the coordinate system of the planar MPAS mesh by an arbitrary shift in x and/or y

convert(dsIn[, graphInfoFileName, logger, dir])	Use MpasMeshConverter.x to convert an input mesh to a valid MPAS mesh that is fully compliant with the MPAS mesh specification.
cull(dsIn[, dsMask, dsInverse, dsPreserve, ...])	Use MpasCellCuller.x to cull cells from a mesh based on the cullCell field in the input file or DataSet and/or the provided masks.
mask(dsMesh[, fcMask, logger, dir, cores])	Use compute_mpas_region_masks to create a set of region masks either from mask feature collections

write_netcdf(ds, fileName[, fillValues, ...])

Write an xarray.Dataset to a file with NetCDF4 fill values and the given name of the string dimension.

Ocean Tools

add_critical_land_blockages(dsMask, dsBlockages)	Add the masks associated with one or more transects to the land mask
widen_transect_edge_masks(dsMask, dsMesh[, ...])	Alter critical passages at polar latitudes to be at least two cells wide, to avoid sea ice blockage