Skip to main content

Ctrl+K

Xugrid

User Guide
API Reference
Development

User Guide
API Reference
Development

Section Navigation

Changelog

xugrid.load_dataarray
xugrid.open_dataarray
xugrid.load_dataset
xugrid.open_dataset
xugrid.open_mfdataset
xugrid.open_zarr
xugrid.full_like
xugrid.ones_like
xugrid.zeros_like
xugrid.concat
xugrid.merge
xugrid.merge_partitions
xugrid.burn_vector_geometry
xugrid.earcut_triangulate_polygons
xugrid.polygonize

xugrid.UgridDataArray
xugrid.UgridDataArray.ugrid
xugrid.UgridDataArray.from_structured2d
xugrid.UgridDataArray.from_data

xugrid.UgridDataset
xugrid.UgridDataset.ugrid
xugrid.UgridDataset.from_geodataframe
xugrid.UgridDataset.from_structured2d

xugrid.UgridDatasetAccessor
xugrid.UgridDatasetAccessor.assign_node_coords
xugrid.UgridDatasetAccessor.assign_edge_coords
xugrid.UgridDatasetAccessor.assign_face_coords
xugrid.UgridDatasetAccessor.set_node_coords
xugrid.UgridDatasetAccessor.grid
xugrid.UgridDatasetAccessor.name
xugrid.UgridDatasetAccessor.names
xugrid.UgridDatasetAccessor.topology
xugrid.UgridDatasetAccessor.bounds
xugrid.UgridDatasetAccessor.total_bounds
xugrid.UgridDatasetAccessor.crs
xugrid.UgridDatasetAccessor.rename
xugrid.UgridDatasetAccessor.set_crs
xugrid.UgridDatasetAccessor.to_crs
xugrid.UgridDatasetAccessor.sel
xugrid.UgridDatasetAccessor.sel_points
xugrid.UgridDatasetAccessor.rasterize
xugrid.UgridDatasetAccessor.rasterize_like
xugrid.UgridDatasetAccessor.to_periodic
xugrid.UgridDatasetAccessor.to_nonperiodic
xugrid.UgridDatasetAccessor.intersect_line
xugrid.UgridDatasetAccessor.intersect_linestring
xugrid.UgridDatasetAccessor.partition
xugrid.UgridDatasetAccessor.partition_by_label
xugrid.UgridDatasetAccessor.reindex_like
xugrid.UgridDatasetAccessor.to_geodataframe
xugrid.UgridDatasetAccessor.to_dataset
xugrid.UgridDatasetAccessor.to_netcdf
xugrid.UgridDatasetAccessor.to_zarr
xugrid.UgridDataArrayAccessor
xugrid.UgridDataArrayAccessor.assign_node_coords
xugrid.UgridDataArrayAccessor.assign_edge_coords
xugrid.UgridDataArrayAccessor.assign_face_coords
xugrid.UgridDataArrayAccessor.set_node_coords
xugrid.UgridDataArrayAccessor.grids
xugrid.UgridDataArrayAccessor.name
xugrid.UgridDataArrayAccessor.names
xugrid.UgridDataArrayAccessor.topology
xugrid.UgridDataArrayAccessor.bounds
xugrid.UgridDataArrayAccessor.total_bounds
xugrid.UgridDataArrayAccessor.crs
xugrid.UgridDataArrayAccessor.rename
xugrid.UgridDataArrayAccessor.set_crs
xugrid.UgridDataArrayAccessor.to_crs
xugrid.UgridDataArrayAccessor.sel
xugrid.UgridDataArrayAccessor.sel_points
xugrid.UgridDataArrayAccessor.intersect_line
xugrid.UgridDataArrayAccessor.intersect_linestring
xugrid.UgridDataArrayAccessor.label_partitions
xugrid.UgridDataArrayAccessor.partition
xugrid.UgridDataArrayAccessor.partition_by_label
xugrid.UgridDataArrayAccessor.rasterize
xugrid.UgridDataArrayAccessor.rasterize_like
xugrid.UgridDataArrayAccessor.reindex_like
xugrid.UgridDataArrayAccessor.to_node
xugrid.UgridDataArrayAccessor.to_edge
xugrid.UgridDataArrayAccessor.to_face
xugrid.UgridDataArrayAccessor.to_periodic
xugrid.UgridDataArrayAccessor.to_nonperiodic
xugrid.UgridDataArrayAccessor.to_geodataframe
xugrid.UgridDataArrayAccessor.binary_dilation
xugrid.UgridDataArrayAccessor.binary_erosion
xugrid.UgridDataArrayAccessor.connected_components
xugrid.UgridDataArrayAccessor.reverse_cuthill_mckee
xugrid.UgridDataArrayAccessor.interpolate_na
xugrid.UgridDataArrayAccessor.laplace_interpolate
xugrid.UgridDataArrayAccessor.to_dataset
xugrid.UgridDataArrayAccessor.to_netcdf
xugrid.UgridDataArrayAccessor.to_zarr

xugrid.snap_nodes
xugrid.snap_to_grid
xugrid.create_snap_to_grid_dataframe

xugrid.BarycentricInterpolator
xugrid.CentroidLocatorRegridder
xugrid.OverlapRegridder
xugrid.RelativeOverlapRegridder

xugrid.NetworkGridder

xugrid.plot.contour
xugrid.plot.contourf
xugrid.plot.imshow
xugrid.plot.line
xugrid.plot.pcolormesh
xugrid.plot.scatter
xugrid.plot.surface
xugrid.plot.tripcolor

xugrid.Ugrid1d
xugrid.Ugrid1d.topology_dimension
xugrid.Ugrid1d.dims
xugrid.Ugrid1d.sizes
xugrid.Ugrid1d.attrs
xugrid.Ugrid1d.coords
xugrid.Ugrid1d.fill_value
xugrid.Ugrid1d.start_index
xugrid.Ugrid1d.n_node
xugrid.Ugrid1d.node_dimension
xugrid.Ugrid1d.node_coordinates
xugrid.Ugrid1d.set_node_coords
xugrid.Ugrid1d.assign_node_coords
xugrid.Ugrid1d.assign_edge_coords
xugrid.Ugrid1d.get_coordinates
xugrid.Ugrid1d.n_edge
xugrid.Ugrid1d.edge_dimension
xugrid.Ugrid1d.edge_coordinates
xugrid.Ugrid1d.edge_x
xugrid.Ugrid1d.edge_y
xugrid.Ugrid1d.bounds
xugrid.Ugrid1d.edge_bounds
xugrid.Ugrid1d.edge_length
xugrid.Ugrid1d.node_edge_connectivity
xugrid.Ugrid1d.node_node_connectivity
xugrid.Ugrid1d.edge_edge_connectivity
xugrid.Ugrid1d.directed_node_node_connectivity
xugrid.Ugrid1d.directed_edge_edge_connectivity
xugrid.Ugrid1d.get_connectivity_matrix
xugrid.Ugrid1d.is_cyclic
xugrid.Ugrid1d.format_connectivity_as_dense
xugrid.Ugrid1d.format_connectivity_as_sparse
xugrid.Ugrid1d.refine_by_vertices
xugrid.Ugrid1d.copy
xugrid.Ugrid1d.rename
xugrid.Ugrid1d.isel
xugrid.Ugrid1d.sel
xugrid.Ugrid1d.sel_points
xugrid.Ugrid1d.intersect_line
xugrid.Ugrid1d.intersect_linestring
xugrid.Ugrid1d.celltree
xugrid.Ugrid1d.node_kdtree
xugrid.Ugrid1d.edge_kdtree
xugrid.Ugrid1d.locate_nearest_node
xugrid.Ugrid1d.locate_nearest_edge
xugrid.Ugrid1d.locate_points
xugrid.Ugrid1d.intersect_edges
xugrid.Ugrid1d.topology_subset
xugrid.Ugrid1d.merge_partitions
xugrid.Ugrid1d.topological_sort_by_dfs
xugrid.Ugrid1d.contract_vertices
xugrid.Ugrid1d.remove_self_loops
xugrid.Ugrid1d.reindex_like
xugrid.Ugrid1d.from_meshkernel
xugrid.Ugrid1d.mesh
xugrid.Ugrid1d.meshkernel
xugrid.Ugrid1d.set_crs
xugrid.Ugrid1d.to_crs
xugrid.Ugrid1d.write_grid_mapping
xugrid.Ugrid1d.from_dataset
xugrid.Ugrid1d.to_dataset
xugrid.Ugrid1d.from_geodataframe
xugrid.Ugrid1d.from_shapely
xugrid.Ugrid1d.to_shapely
xugrid.Ugrid1d.create_data_array
xugrid.Ugrid1d.plot

xugrid.Ugrid2d
xugrid.Ugrid2d.topology_dimension
xugrid.Ugrid2d.dims
xugrid.Ugrid2d.sizes
xugrid.Ugrid2d.attrs
xugrid.Ugrid2d.coords
xugrid.Ugrid2d.fill_value
xugrid.Ugrid2d.start_index
xugrid.Ugrid2d.n_node
xugrid.Ugrid2d.node_dimension
xugrid.Ugrid2d.node_coordinates
xugrid.Ugrid2d.set_node_coords
xugrid.Ugrid2d.assign_node_coords
xugrid.Ugrid2d.assign_edge_coords
xugrid.Ugrid2d.assign_face_coords
xugrid.Ugrid2d.get_coordinates
xugrid.Ugrid2d.n_edge
xugrid.Ugrid2d.edge_dimension
xugrid.Ugrid2d.edge_coordinates
xugrid.Ugrid2d.edge_x
xugrid.Ugrid2d.edge_y
xugrid.Ugrid2d.edge_length
xugrid.Ugrid2d.n_face
xugrid.Ugrid2d.face_dimension
xugrid.Ugrid2d.face_coordinates
xugrid.Ugrid2d.centroids
xugrid.Ugrid2d.circumcenters
xugrid.Ugrid2d.area
xugrid.Ugrid2d.perimeter
xugrid.Ugrid2d.face_x
xugrid.Ugrid2d.face_y
xugrid.Ugrid2d.bounds
xugrid.Ugrid2d.edge_bounds
xugrid.Ugrid2d.face_bounds
xugrid.Ugrid2d.bounding_polygon
xugrid.Ugrid2d.node_node_connectivity
xugrid.Ugrid2d.node_edge_connectivity
xugrid.Ugrid2d.node_face_connectivity
xugrid.Ugrid2d.edge_node_connectivity
xugrid.Ugrid2d.edge_edge_connectivity
xugrid.Ugrid2d.face_edge_connectivity
xugrid.Ugrid2d.face_face_connectivity
xugrid.Ugrid2d.directed_node_node_connectivity
xugrid.Ugrid2d.directed_edge_edge_connectivity
xugrid.Ugrid2d.get_connectivity_matrix
xugrid.Ugrid2d.format_connectivity_as_dense
xugrid.Ugrid2d.format_connectivity_as_sparse
xugrid.Ugrid2d.validate_edge_node_connectivity
xugrid.Ugrid2d.exterior_edges
xugrid.Ugrid2d.exterior_faces
xugrid.Ugrid2d.copy
xugrid.Ugrid2d.rename
xugrid.Ugrid2d.triangulate
xugrid.Ugrid2d.triangulation
xugrid.Ugrid2d.voronoi_topology
xugrid.Ugrid2d.centroid_triangulation
xugrid.Ugrid2d.tesselate_centroidal_voronoi
xugrid.Ugrid2d.tesselate_circumcenter_voronoi
xugrid.Ugrid2d.reverse_cuthill_mckee
xugrid.Ugrid2d.compute_barycentric_weights
xugrid.Ugrid2d.isel
xugrid.Ugrid2d.sel
xugrid.Ugrid2d.sel_points
xugrid.Ugrid2d.intersect_line
xugrid.Ugrid2d.intersect_linestring
xugrid.Ugrid2d.celltree
xugrid.Ugrid2d.node_kdtree
xugrid.Ugrid2d.edge_kdtree
xugrid.Ugrid2d.face_kdtree
xugrid.Ugrid2d.locate_nearest_node
xugrid.Ugrid2d.locate_nearest_edge
xugrid.Ugrid2d.locate_nearest_face
xugrid.Ugrid2d.locate_points
xugrid.Ugrid2d.intersect_edges
xugrid.Ugrid2d.locate_bounding_box
xugrid.Ugrid2d.rasterize
xugrid.Ugrid2d.rasterize_like
xugrid.Ugrid2d.to_periodic
xugrid.Ugrid2d.to_nonperiodic
xugrid.Ugrid2d.topology_subset
xugrid.Ugrid2d.label_partitions
xugrid.Ugrid2d.partition
xugrid.Ugrid2d.merge_partitions
xugrid.Ugrid2d.reindex_like
xugrid.Ugrid2d.from_meshkernel
xugrid.Ugrid2d.mesh
xugrid.Ugrid2d.meshkernel
xugrid.Ugrid2d.set_crs
xugrid.Ugrid2d.to_crs
xugrid.Ugrid2d.write_grid_mapping
xugrid.Ugrid2d.from_dataset
xugrid.Ugrid2d.to_dataset
xugrid.Ugrid2d.from_geodataframe
xugrid.Ugrid2d.from_structured
xugrid.Ugrid2d.from_structured_bounds
xugrid.Ugrid2d.from_structured_intervals1d
xugrid.Ugrid2d.from_structured_intervals2d
xugrid.Ugrid2d.from_shapely
xugrid.Ugrid2d.to_shapely
xugrid.Ugrid2d.earcut_triangulate_polygons
xugrid.Ugrid2d.create_data_array
xugrid.Ugrid2d.plot

xugrid.UgridRolesAccessor
xugrid.UgridRolesAccessor.topology
xugrid.UgridRolesAccessor.connectivity
xugrid.UgridRolesAccessor.coordinates
xugrid.UgridRolesAccessor.dimensions
xugrid.UgridRolesAccessor.grid_mapping_names
xugrid.UgridRolesAccessor.is_projected

API Reference
xugrid.Ugrid2d.to_dataset

xugrid.Ugrid2d.to_dataset#

Ugrid2d.to_dataset(other: Dataset = None, optional_attributes: bool = False) → Dataset[source]#

previous

xugrid.Ugrid2d.from_dataset

next

xugrid.Ugrid2d.from_geodataframe

On this page

Ugrid2d.to_dataset()

© Copyright Deltares.

Created using Sphinx 9.1.0.

Built with the PyData Sphinx Theme 0.21.0.