Skip to main content
Back to top
Ctrl
+
K
For users
Installation
Getting Started
Overview: Why UXarray?
Quick Installation
Frequently Asked Questions
Usage Examples
Working with Unstructured Grid Data
Grid Topology Overview
Face Area Calculations
Working with MPAS Grids
Conversion to GeoDataFrame for Visualization with HoloViz Packages
Visualizing Grid Topology
Visualizing Data as Polygons
Visualizing Data as Points
Subsetting an Unstructured Grid: Analysis Over Chicago
API Reference
User API
uxarray.UxDataset
uxarray.open_dataset
uxarray.open_mfdataset
uxarray.UxDataset.uxgrid
uxarray.UxDataset.source_datasets
uxarray.UxDataset.info
uxarray.UxDataset.nearest_neighbor_remap
uxarray.UxDataset.inverse_distance_weighted_remap
uxarray.UxDataset.plot
uxarray.UxDataArray
uxarray.UxDataArray.to_dataset
uxarray.UxDataArray.to_geodataframe
uxarray.UxDataArray.to_polycollection
uxarray.UxDataArray.uxgrid
uxarray.UxDataArray.integrate
uxarray.UxDataArray.isel
uxarray.UxDataArray.nearest_neighbor_remap
uxarray.UxDataArray.inverse_distance_weighted_remap
uxarray.UxDataArray.nodal_average
uxarray.UxDataArray.plot
uxarray.UxDataArray.plot.datashade
uxarray.UxDataArray.plot.rasterize
uxarray.UxDataArray.plot.polygons
uxarray.UxDataArray.plot.points
uxarray.UxDataArray.subset
uxarray.UxDataArray.subset.nearest_neighbor
uxarray.UxDataArray.subset.bounding_circle
uxarray.UxDataArray.subset.bounding_box
uxarray.UxDataArray.integrate
uxarray.UxDataArray.gradient
uxarray.UxDataArray.difference
uxarray.Grid
uxarray.open_grid
uxarray.Grid.from_dataset
uxarray.Grid.from_face_vertices
uxarray.Grid.to_geodataframe
uxarray.Grid.to_polycollection
uxarray.Grid.to_linecollection
uxarray.Grid.validate
uxarray.Grid.calculate_total_face_area
uxarray.Grid.compute_face_areas
uxarray.Grid.encode_as
uxarray.Grid.get_ball_tree
uxarray.Grid.get_kd_tree
uxarray.Grid.copy
uxarray.Grid.isel
uxarray.Grid.n_node
uxarray.Grid.n_edge
uxarray.Grid.n_face
uxarray.Grid.n_max_face_nodes
uxarray.Grid.n_max_face_edges
uxarray.Grid.n_max_face_faces
uxarray.Grid.n_max_edge_edges
uxarray.Grid.n_max_node_faces
uxarray.Grid.n_max_node_edges
uxarray.Grid.n_nodes_per_face
uxarray.Grid.node_lon
uxarray.Grid.node_lat
uxarray.Grid.edge_lon
uxarray.Grid.edge_lat
uxarray.Grid.face_lon
uxarray.Grid.face_lat
uxarray.Grid.node_x
uxarray.Grid.node_y
uxarray.Grid.node_z
uxarray.Grid.edge_x
uxarray.Grid.edge_y
uxarray.Grid.edge_z
uxarray.Grid.face_x
uxarray.Grid.face_y
uxarray.Grid.face_z
uxarray.Grid.face_node_connectivity
uxarray.Grid.face_edge_connectivity
uxarray.Grid.face_face_connectivity
uxarray.Grid.edge_node_connectivity
uxarray.Grid.edge_edge_connectivity
uxarray.Grid.edge_face_connectivity
uxarray.Grid.node_edge_connectivity
uxarray.Grid.node_face_connectivity
uxarray.Grid.face_areas
uxarray.Grid.antimeridian_face_indices
uxarray.Grid.bounds
uxarray.Grid.attrs
uxarray.Grid.plot
uxarray.Grid.plot.node_coords
uxarray.Grid.plot.nodes
uxarray.Grid.plot.face_coords
uxarray.Grid.plot.face_centers
uxarray.Grid.plot.edge_coords
uxarray.Grid.plot.edge_centers
uxarray.Grid.plot.mesh
uxarray.Grid.plot.edges
uxarray.Grid.subset
uxarray.Grid.subset.nearest_neighbor
uxarray.Grid.subset.bounding_circle
uxarray.Grid.subset.bounding_box
uxarray.grid.neighbors.KDTree
uxarray.grid.neighbors.KDTree.query
uxarray.grid.neighbors.KDTree.query_radius
uxarray.grid.neighbors.BallTree
uxarray.grid.neighbors.BallTree.query
uxarray.grid.neighbors.BallTree.query_radius
uxarray.grid.area.calculate_face_area
uxarray.grid.area.get_all_face_area_from_coords
uxarray.grid.area.calculate_spherical_triangle_jacobian
uxarray.grid.area.calculate_spherical_triangle_jacobian_barycentric
uxarray.grid.area.get_gauss_quadratureDG
uxarray.grid.area.get_tri_quadratureDG
uxarray.grid.connectivity.close_face_nodes
uxarray.grid.coordinates.node_lonlat_rad_to_xyz
uxarray.grid.coordinates.node_xyz_to_lonlat_rad
uxarray.grid.coordinates.normalize_in_place
uxarray.grid.arcs.in_between
uxarray.grid.arcs.point_within_gca
uxarray.grid.arcs.extreme_gca_latitude
uxarray.grid.intersections.gca_gca_intersection
uxarray.grid.intersections.gca_constLat_intersection
uxarray.utils.computing.cross_fma
uxarray.utils.computing.dot_fma
Internal API
uxarray.UxDataset
uxarray.UxDataset._source_datasets
uxarray.UxDataset._uxgrid
uxarray.UxDataset.__getitem__
uxarray.UxDataset.__setitem__
uxarray.UxDataset._calculate_binary_op
uxarray.UxDataset._construct_dataarray
uxarray.UxDataset._construct_direct
uxarray.UxDataset._copy
uxarray.UxDataset._replace
uxarray.UxDataArray
uxarray.UxDataArray._uxgrid
uxarray.UxDataArray._construct_direct
uxarray.UxDataArray._copy
uxarray.UxDataArray._replace
uxarray.UxDataArray._face_centered
uxarray.UxDataArray._node_centered
uxarray.UxDataArray._slice_from_grid
uxarray.Grid
uxarray.Grid.__eq__
uxarray.Grid.__ne__
uxarray.grid.connectivity._face_nodes_to_sparse_matrix
uxarray.grid.connectivity._replace_fill_values
uxarray.grid.connectivity._build_edge_node_connectivity
uxarray.grid.connectivity._build_node_faces_connectivity
uxarray.grid.connectivity._build_edge_face_connectivity
uxarray.grid.connectivity._populate_edge_node_connectivity
uxarray.grid.connectivity._populate_edge_face_connectivity
uxarray.grid.connectivity._populate_n_nodes_per_face
uxarray.grid.coordinates._get_lonlat_from_xyz
uxarray.grid.coordinates._get_xyz_from_lonlat
uxarray.grid.coordinates._populate_cartesian_xyz_coord
uxarray.grid.coordinates._populate_lonlat_coord
uxarray.grid.coordinates._populate_face_centroids
uxarray.grid.coordinates._construct_face_centroids
uxarray.grid.coordinates._set_desired_longitude_range
uxarray.grid.coordinates._populate_edge_centroids
uxarray.grid.coordinates._construct_edge_centroids
uxarray.grid.arcs._angle_of_2_vectors
uxarray.grid.arcs._decide_pole_latitude
uxarray.grid.utils._newton_raphson_solver_for_gca_constLat
uxarray.grid.utils._inv_jacobian
uxarray.grid.utils._get_lonlat_rad_face_edge_nodes
uxarray.grid.validation._check_connectivity
uxarray.grid.validation._check_duplicate_nodes
uxarray.grid.validation._check_area
uxarray.utils.computing._err_fmac
uxarray.utils.computing._fast_two_mult
uxarray.utils.computing._fast_two_sum
uxarray.utils.computing._two_sum
uxarray.utils.computing._two_prod_fma
uxarray.utils.computing._comp_prod_fma
uxarray.utils.computing._sum_of_squares_re
uxarray.utils.computing._vec_sum
uxarray.utils.computing._norm_faithful
uxarray.utils.computing._norm_l
uxarray.utils.computing._norm_g
uxarray.utils.computing._two_square
uxarray.utils.computing._acc_sqrt
uxarray.utils.computing._split
uxarray.grid.integrate._get_zonal_faces_weight_at_constLat
uxarray.grid.integrate._get_zonal_face_interval
uxarray.grid.integrate._process_overlapped_intervals
uxarray.grid.integrate._is_edge_gca
uxarray.grid.integrate._get_faces_constLat_intersection_info
uxarray.remap.nearest_neighbor._nearest_neighbor
uxarray.remap.nearest_neighbor._nearest_neighbor_uxda
uxarray.remap.nearest_neighbor._nearest_neighbor_uxds
uxarray.remap.inverse_distance_weighted._inverse_distance_weighted_remap
uxarray.remap.inverse_distance_weighted._inverse_distance_weighted_remap_uxda
uxarray.remap.inverse_distance_weighted._inverse_distance_weighted_remap_uxds
uxarray.io._ugrid._read_ugrid
uxarray.io._ugrid._encode_ugrid
uxarray.io._ugrid._is_ugrid
uxarray.io._ugrid._validate_minimum_ugrid
uxarray.io._mpas._read_mpas
uxarray.io._mpas._primal_to_ugrid
uxarray.io._mpas._dual_to_ugrid
uxarray.io._mpas._replace_padding
uxarray.io._mpas._replace_zeros
uxarray.io._exodus._read_exodus
uxarray.io._exodus._encode_exodus
uxarray.io._exodus._get_element_type
uxarray.io._scrip._to_ugrid
uxarray.io._scrip._read_scrip
uxarray.io._scrip._encode_scrip
uxarray.io._shapefile._read_shpfile
uxarray.io._vertices._read_face_vertices
uxarray.io.utils._parse_grid_type
uxarray.core.utils._map_dims_to_ugrid
uxarray.plot.grid_plot._plot_coords_as_points
uxarray.plot.dataarray_plot._plot_data_as_points
uxarray.plot.dataarray_plot._polygon_raster
uxarray.plot.dataarray_plot._point_raster
uxarray.plot.utils.HoloviewsBackend
uxarray.grid.slice._slice_node_indices
uxarray.subset.grid_accessor.GridSubsetAccessor
uxarray.subset.dataarray_accessor.DataArraySubsetAccessor
uxarray.grid.neighbors._populate_edge_node_distances
uxarray.grid.neighbors._construct_edge_node_distances
uxarray.grid.neighbors._populate_edge_face_distances
uxarray.grid.neighbors._construct_edge_face_distances
uxarray.core.gradient._calculate_edge_face_difference
uxarray.core.gradient._calculate_edge_node_difference
uxarray.core.gradient._calculate_grad_on_edge_from_faces
Tutorials
Cite Uxarray
For developers
Contributor's Guide
Community
GitHub Discussions
GitHub Issues
Ugrid Conventions
Repository
Suggest edit
Open issue
.rst
.pdf
uxarray.io._ugrid._is_ugrid
Contents
_is_ugrid()
uxarray.io._ugrid._is_ugrid
#
uxarray.io._ugrid.
_is_ugrid
(
ds
)
#
Check mesh topology and dimension.
Contents
_is_ugrid()
