iris.fileformats.netcdf.ugrid_load#
Allow the construction of MeshXY.
API reference |
Tags: topic_load_save | topic_mesh
Extension functions for Iris NetCDF loading, to construct
MeshXY from UGRID data in files.
See also
The UGRID Conventions, https://ugrid-conventions.github.io/ugrid-conventions/
- iris.fileformats.netcdf.ugrid_load.load_mesh(uris, var_name=None)[source]#
Load a single
MeshXYfrom one or more files or stores.Raises an error if more/less than one
MeshXYis found.- Parameters:
uris (str or iterable of str) – One or more filenames/URI’s. Filenames can include wildcards. NetCDF files and Zarr stores are read; anything else is ignored. Any URI’s must support OpenDAP, NcZarr, or a Zarr remote store scheme.
var_name (str, optional) – Only return a
MeshXYif its var_name matches this value.
- Return type:
- iris.fileformats.netcdf.ugrid_load.load_meshes(uris, var_name=None)[source]#
Load
MeshXYobjects from files or Zarr stores.- Parameters:
uris (str or iterable of str) – One or more filenames/URI’s. Filenames can include wildcards. NetCDF files and Zarr stores are read; anything else is ignored. Any URI’s must support OpenDAP, NcZarr, or a Zarr remote store scheme.
var_name (str, optional) – Only return
MeshXYthat have var_names matching this value.
- Returns:
A dictionary mapping each mesh-containing file path/URL in the input
uristo a list of theMeshXYreturned from each.- Return type: