API Reference

API Reference#

This page provides an auto-generated summary of mosaic’s API.

Plotting#

polypcolor(ax, descriptor, array, **kwargs)

Create a pseudocolor plot of a unstructured MPAS grid.

contour(ax, *args, **kwargs)

Plot contour lines on an unstructured MPAS mesh.

contourf(ax, *args, **kwargs)

Plot filled contours on an unstructured MPAS mesh.

Data Structures#

Descriptor(mesh_ds[, projection, transform, ...])

Data structure describing unstructured MPAS meshes.

Helper Functions#

utils.cull_mesh(ds_base, cells_to_cull)

Cull cells from a mesh using a cell mask

utils.get_invalid_patches(patches)

Helper function to identify problematic patches.

utils.compute_cell_centroid(cell_patches, ...)

Compute Centroid of cell patch using shoelace formula

datasets.open_dataset(name[, cache_dir, cache])

Open a dataset from the lcrc database (requires internet), unless a local copy is found.