This page provides an auto-generated summary of xarray’s API. For more details and examples, refer to the relevant chapters in the main part of the documentation.
See also: What parts of xarray are considered public API? and How stable is Xarray’s API?.
Top-level functions# Dataset# Creating a dataset# Attributes# Dictionary interface#Datasets implement the mapping interface with keys given by variable names and values given by DataArray objects.
Datetime properties:
Datetime methods:
Timedelta properties:
Timedelta methods:
Reshaping and reorganizing# DataTree# Creating a DataTree#Methods of creating a DataTree.
Attributes relating to the recursive tree-like structure of a DataTree.
Interface to the data objects (optionally) stored inside a single DataTree node. This interface echoes that of xarray.Dataset.
DataTree objects also have a dict-like interface mapping keys to either xarray.DataArrays or to child DataTree nodes.
For manipulating, traversing, navigating, or mapping over the tree structure.
Pathlib-like Interface#DataTree objects deliberately echo some of the API of pathlib.PurePath.
Manipulate the contents of all nodes in a DataTree simultaneously.
Manipulate the contents of a single DataTree node.
Apply operations over multiple DataTree objects.
Compare one DataTree object to another.
Index into all nodes in the subtree simultaneously.
Aggregation#Aggregate data in all nodes in the subtree simultaneously.
ndarray methods#Methods copied from numpy.ndarray objects, here applying to the data in all nodes in the subtree.
Coordinates implement the mapping interface with keys given by variable names and values given by DataArray objects.
Coordinates that are accessed from the coords property of Dataset, DataArray and DataTree objects, respectively.
Default, pandas-backed indexes built-in to Xarray:
More complex indexes built-in to Xarray:
Creating indexes# Universal functions#These functions are equivalent to their NumPy versions, but for xarray objects backed by non-NumPy array types (e.g. cupy, sparse, or jax), they will ensure that the computation is dispatched to the appropriate backend. You can find them in the xarray.ufuncs module:
These classes are building blocks for more complex Indexes:
The Index base class for building custom indexes:
Tutorial# Testing#Test that two DataTree objects are similar.
See the documentation page on testing for a guide on how to use these strategies.
Warning
These strategies should be considered highly experimental, and liable to change at any time.
Exceptions# DataTree#Exceptions raised when manipulating trees.
Advanced API#These backends provide a low-level interface for lazily loading data from external file-formats or protocols, and can be manually invoked to create arguments for the load_store and dump_to_store Dataset methods:
These BackendEntrypoints provide a basic interface to the most commonly used filetypes in the xarray universe.
Deprecated / Pending Deprecation#RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4