API Reference

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

Top Level Utilities

polypcolor(ax, descriptor, array, **kwargs)	Create a pseudocolor plot of a unstructured MPAS grid.
Descriptor(mesh_ds[, projection, transform, ...])	Data structure describing unstructured MPAS meshes.
datasets.open_dataset(name[, cache_dir, cache])	Open a dataset from the lcrc database (requires internet), unless a local copy is found.

Descriptor

Constructor

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

Data structure describing unstructured MPAS meshes.

Properties

Descriptor.cell_patches	ndarray of patch coordinates for cell centered values
Descriptor.edge_patches	ndarray of patch coordinates for edge centered values
Descriptor.vertex_patches	ndarray of patch coordinates for vertex centered values
Descriptor.transform	The coordinate system in which patch coordinates are defined.

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