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 If loading from file, initialization happens via the specified file.
`grid.Grid.__init_ds_var_names__`	A dictionary for storing uxarray's internal representation of xarray object.
`grid.Grid.__from_file__`	Loads a mesh file Also, called by __init__ routine This routine will automatically detect if it is a UGrid, SCRIP, Exodus, or shape file.
`grid.Grid.__from_vert__`	Create a grid with one face with vertices specified by the given argument.

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).