.. currentmodule:: uxarray ######## User API ######## This page shows already-implemented Uxarray user API functions. You can also check the `UXarray Milestones `_ and `UXarray RoadMap `_ for a high level understanding of UXarray's future function development milestones and roadmap. Please let us know if you have any feedback! UxDataset ========= A ``xarray.Dataset``-like, multi-dimensional, in memory, array database. Inherits from ``xarray.Dataset`` and has its own unstructured grid-aware dataset operators and attributes through the ``uxgrid`` accessor. Below is a list of features explicitly added to `UxDataset` to work on Unstructured Grids: Class ----- .. autosummary:: :toctree: generated/ UxDataset IO -- .. autosummary:: :toctree: generated/ open_dataset open_mfdataset Attributes ---------- .. autosummary:: :toctree: generated/ UxDataset.uxgrid UxDataset.source_datasets Methods ------- .. autosummary:: :toctree: generated/ UxDataset.info Remapping --------- .. autosummary:: :toctree: generated/ UxDataset.nearest_neighbor_remap UxDataset.inverse_distance_weighted_remap Plotting -------- .. autosummary:: :toctree: generated/ :template: autosummary/accessor.rst UxDataset.plot UxDataArray =========== N-dimensional ``xarray.DataArray``-like array. Inherits from `xarray.DataArray` and has its own unstructured grid-aware array operators and attributes through the ``uxgrid`` accessor. Below is a list of features explicitly added to `UxDataset` to work on Unstructured Grids: Class ----- .. autosummary:: :toctree: generated/ UxDataArray IO -- .. autosummary:: :toctree: generated/ UxDataArray.to_dataset UxDataArray.to_geodataframe UxDataArray.to_polycollection Attributes ---------- .. autosummary:: :toctree: generated/ UxDataArray.uxgrid Topological Aggregations ---------- .. autosummary:: :toctree: generated/ UxDataArray.topological_mean UxDataArray.topological_max UxDataArray.topological_min UxDataArray.topological_prod UxDataArray.topological_sum UxDataArray.topological_std UxDataArray.topological_var UxDataArray.topological_median UxDataArray.topological_all UxDataArray.topological_any Methods ------- .. autosummary:: :toctree: generated/ UxDataArray.integrate UxDataArray.isel Remapping --------- .. autosummary:: :toctree: generated/ UxDataArray.nearest_neighbor_remap UxDataArray.inverse_distance_weighted_remap UxDataArray.nodal_average Plotting -------- .. autosummary:: :toctree: generated/ :template: autosummary/accessor.rst UxDataArray.plot .. autosummary:: :toctree: generated/ :template: autosummary/accessor_method.rst UxDataArray.plot.datashade UxDataArray.plot.rasterize UxDataArray.plot.polygons UxDataArray.plot.points Subsetting ---------- .. autosummary:: :toctree: generated/ :template: autosummary/accessor.rst UxDataArray.subset .. autosummary:: :toctree: generated/ :template: autosummary/accessor_method.rst UxDataArray.subset.nearest_neighbor UxDataArray.subset.bounding_circle UxDataArray.subset.bounding_box Calculus Operators ------------------ .. autosummary:: :toctree: generated/ UxDataArray.integrate UxDataArray.gradient UxDataArray.difference Grid ==== Unstructured grid topology definition to store stores grid topology dimensions, coordinates, variables and provides grid-specific functions. Can be used standalone to explore an unstructured grid topology, or can be seen as the property of ``uxarray.UxDataset`` and ``uxarray.DataArray`` to make them unstructured grid-aware data sets and arrays. Class ----- .. autosummary:: :toctree: generated/ Grid IO -- .. autosummary:: :toctree: generated/ open_grid Grid.from_dataset Grid.from_face_vertices Grid.to_geodataframe Grid.to_polycollection Grid.to_linecollection Grid.validate Methods ------- .. autosummary:: :toctree: generated/ Grid.calculate_total_face_area Grid.compute_face_areas Grid.encode_as Grid.get_ball_tree Grid.get_kd_tree Grid.copy Grid.isel Dimensions ---------- .. autosummary:: :toctree: generated/ Grid.n_node Grid.n_edge Grid.n_face Grid.n_max_face_nodes Grid.n_max_face_edges Grid.n_max_face_faces Grid.n_max_edge_edges Grid.n_max_node_faces Grid.n_max_node_edges Grid.n_max_node_nodes Grid.n_nodes_per_face Spherical Coordinates --------------------- .. autosummary:: :toctree: generated/ Grid.node_lon Grid.node_lat Grid.edge_lon Grid.edge_lat Grid.face_lon Grid.face_lat Cartesian Coordinates --------------------- .. autosummary:: :toctree: generated/ Grid.node_x Grid.node_y Grid.node_z Grid.edge_x Grid.edge_y Grid.edge_z Grid.face_x Grid.face_y Grid.face_z Connectivity ------------ .. autosummary:: :toctree: generated/ Grid.face_node_connectivity Grid.face_edge_connectivity Grid.face_face_connectivity Grid.edge_node_connectivity Grid.edge_edge_connectivity Grid.edge_face_connectivity Grid.node_edge_connectivity Grid.node_face_connectivity Grid Descriptors ---------------- .. autosummary:: :toctree: generated/ Grid.face_areas Grid.antimeridian_face_indices Grid.bounds Attributes ---------- .. autosummary:: :toctree: generated/ Grid.grid_spec Grid.attrs Plotting -------- .. autosummary:: :toctree: generated/ :template: autosummary/accessor.rst Grid.plot .. autosummary:: :toctree: generated/ :template: autosummary/accessor_method.rst Grid.plot.node_coords Grid.plot.nodes Grid.plot.face_coords Grid.plot.face_centers Grid.plot.edge_coords Grid.plot.edge_centers Grid.plot.mesh Grid.plot.edges Subsetting ---------- .. autosummary:: :toctree: generated/ :template: autosummary/accessor.rst Grid.subset .. autosummary:: :toctree: generated/ :template: autosummary/accessor_method.rst Grid.subset.nearest_neighbor Grid.subset.bounding_circle Grid.subset.bounding_box Nearest Neighbor Data Structures ================================ KDTree ------ .. autosummary:: :toctree: generated/ grid.neighbors.KDTree grid.neighbors.KDTree.query grid.neighbors.KDTree.query_radius BallTree -------- .. autosummary:: :toctree: generated/ grid.neighbors.BallTree grid.neighbors.BallTree.query grid.neighbors.BallTree.query_radius Helpers ======= Face Area ---------- .. autosummary:: :toctree: generated/ grid.area.calculate_face_area grid.area.get_all_face_area_from_coords grid.area.calculate_spherical_triangle_jacobian grid.area.calculate_spherical_triangle_jacobian_barycentric grid.area.get_gauss_quadratureDG grid.area.get_tri_quadratureDG Connectivity ------------ .. autosummary:: :toctree: generated/ grid.connectivity.close_face_nodes Arcs ---- .. autosummary:: :toctree: generated/ grid.arcs.in_between grid.arcs.point_within_gca grid.arcs.extreme_gca_latitude Intersections ------------- .. autosummary:: :toctree: generated/ grid.intersections.gca_gca_intersection grid.intersections.gca_constLat_intersection Accurate Computing Utils ----- .. autosummary:: :toctree: generated/ utils.computing.cross_fma utils.computing.dot_fma Numba ----- .. autosummary:: :toctree: generated/ utils.enable_jit_cache utils.disable_jit_cache utils.enable_jit utils.disable_jit