Internal API

This page shows already-implemented Uxarray internal API functions. You can also check the draft Uxarray API documentation to see the tentative whole API and let us know if you have any feedback!

Grid Methods

grid.Grid.__init__	Initialize grid variables, decide if loading happens via file, verts or gridspec.
grid.Grid.__init_ds_var_names__	Populates a dictionary for storing uxarray's internal representation of xarray object.
grid.Grid.__from_ds__	Loads a mesh dataset.
grid.Grid.__from_vert__	Create a grid with one face with vertices specified by the given argument.
grid.Grid.__init_grid_var_attrs__	Initialize attributes for directly accessing Coordinate and Data variables through ugrid conventions.

Grid Helper Modules

_exodus._read_exodus	Exodus file reader.
_exodus._write_exodus	Exodus file writer.
_exodus._get_element_type	Helper function to get exodus element type from number of nodes.
_ugrid._write_ugrid	UGRID file writer.
_ugrid._read_ugrid	UGRID file reader.
_scrip._read_scrip	Function to reassign lat/lon variables to mesh2_node variables.
_scrip._to_ugrid	If input dataset (ds) file is an unstructured SCRIP file, function will reassign SCRIP variables to UGRID conventions in output file (outfile).
helpers._spherical_to_cartesian_unit_	Converts spherical (lat/lon) coordinates to cartesian (x,y,z).
helpers._is_ugrid	Check mesh topology and dimension.