From 349f1cef87a2438fbc572850d063cb52b73ab948 Mon Sep 17 00:00:00 2001 From: Deepak Cherian Date: Wed, 16 Jul 2025 11:30:54 -0600 Subject: [PATCH 1/4] Restructure API documentation into organized sections MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Ian Hunt-Isaak Co-Authored-By: Claude --- .gitignore | 4 + doc/api.rst | 1806 +----------------------------------- doc/api/accessors.rst | 13 + doc/api/advanced.rst | 60 ++ doc/api/coarsen.rst | 48 + doc/api/coordinates.rst | 79 ++ doc/api/custom-indexes.rst | 39 + doc/api/dataarray.rst | 342 +++++++ doc/api/dataset.rst | 213 +++++ doc/api/datatree.rst | 307 ++++++ doc/api/deprecated.rst | 20 + doc/api/encoding.rst | 17 + doc/api/exceptions.rst | 24 + doc/api/groupby.rst | 85 ++ doc/api/indexes.rst | 34 + doc/api/io.rst | 86 ++ doc/api/plotting.rst | 59 ++ doc/api/resample.rst | 82 ++ doc/api/rolling-exp.rst | 13 + doc/api/rolling.rst | 49 + doc/api/testing.rst | 42 + doc/api/top-level.rst | 30 + doc/api/tutorial.rst | 12 + doc/api/ufuncs.rst | 115 +++ doc/api/weighted.rst | 36 + 25 files changed, 1835 insertions(+), 1780 deletions(-) create mode 100644 doc/api/accessors.rst create mode 100644 doc/api/advanced.rst create mode 100644 doc/api/coarsen.rst create mode 100644 doc/api/coordinates.rst create mode 100644 doc/api/custom-indexes.rst create mode 100644 doc/api/dataarray.rst create mode 100644 doc/api/dataset.rst create mode 100644 doc/api/datatree.rst create mode 100644 doc/api/deprecated.rst create mode 100644 doc/api/encoding.rst create mode 100644 doc/api/exceptions.rst create mode 100644 doc/api/groupby.rst create mode 100644 doc/api/indexes.rst create mode 100644 doc/api/io.rst create mode 100644 doc/api/plotting.rst create mode 100644 doc/api/resample.rst create mode 100644 doc/api/rolling-exp.rst create mode 100644 doc/api/rolling.rst create mode 100644 doc/api/testing.rst create mode 100644 doc/api/top-level.rst create mode 100644 doc/api/tutorial.rst create mode 100644 doc/api/ufuncs.rst create mode 100644 doc/api/weighted.rst diff --git a/.gitignore b/.gitignore index 3c02c76e706..4df55889991 100644 --- a/.gitignore +++ b/.gitignore @@ -70,8 +70,12 @@ asv_bench/pkgs # xarray specific doc/_build doc/generated/ +doc/api/generated/ xarray/tests/data/*.grib.*.idx +# Claude Code +.claude/ + # Sync tools Icon* diff --git a/doc/api.rst b/doc/api.rst index b46d807e8d4..1b161ebe034 100644 --- a/doc/api.rst +++ b/doc/api.rst @@ -12,1783 +12,29 @@ documentation. See also: :ref:`public-api` and :ref:`api-stability`. -Top-level functions -=================== - -.. autosummary:: - :toctree: generated/ - - apply_ufunc - align - broadcast - concat - merge - combine_by_coords - combine_nested - where - infer_freq - full_like - zeros_like - ones_like - cov - corr - cross - dot - polyval - map_blocks - show_versions - set_options - get_options - unify_chunks - -Dataset -======= - -Creating a dataset ------------------- - -.. autosummary:: - :toctree: generated/ - - Dataset - decode_cf - -Attributes ----------- - -.. autosummary:: - :toctree: generated/ - - Dataset.dims - Dataset.sizes - Dataset.dtypes - Dataset.data_vars - Dataset.coords - Dataset.attrs - Dataset.encoding - Dataset.indexes - Dataset.xindexes - Dataset.chunks - Dataset.chunksizes - Dataset.nbytes - -Dictionary interface --------------------- - -Datasets implement the mapping interface with keys given by variable names -and values given by ``DataArray`` objects. - -.. autosummary:: - :toctree: generated/ - - Dataset.__getitem__ - Dataset.__setitem__ - Dataset.__delitem__ - Dataset.update - Dataset.get - Dataset.items - Dataset.keys - Dataset.values - -Dataset contents ----------------- - -.. autosummary:: - :toctree: generated/ - - Dataset.copy - Dataset.assign - Dataset.assign_coords - Dataset.assign_attrs - Dataset.pipe - Dataset.merge - Dataset.rename - Dataset.rename_vars - Dataset.rename_dims - Dataset.swap_dims - Dataset.expand_dims - Dataset.drop_vars - Dataset.drop_indexes - Dataset.drop_duplicates - Dataset.drop_dims - Dataset.drop_encoding - Dataset.drop_attrs - Dataset.set_coords - Dataset.reset_coords - Dataset.convert_calendar - Dataset.interp_calendar - Dataset.get_index - -Comparisons ------------ - -.. autosummary:: - :toctree: generated/ - - Dataset.equals - Dataset.identical - Dataset.broadcast_equals - -Indexing --------- - -.. autosummary:: - :toctree: generated/ - - Dataset.loc - Dataset.isel - Dataset.sel - Dataset.drop_sel - Dataset.drop_isel - Dataset.head - Dataset.tail - Dataset.thin - Dataset.squeeze - Dataset.interp - Dataset.interp_like - Dataset.reindex - Dataset.reindex_like - Dataset.set_index - Dataset.reset_index - Dataset.set_xindex - Dataset.reorder_levels - Dataset.query - -Missing value handling ----------------------- - -.. autosummary:: - :toctree: generated/ - - Dataset.isnull - Dataset.notnull - Dataset.combine_first - Dataset.count - Dataset.dropna - Dataset.fillna - Dataset.ffill - Dataset.bfill - Dataset.interpolate_na - Dataset.where - Dataset.isin - -Computation ------------ - -.. autosummary:: - :toctree: generated/ - - Dataset.map - Dataset.reduce - Dataset.groupby - Dataset.groupby_bins - Dataset.rolling - Dataset.rolling_exp - Dataset.cumulative - Dataset.weighted - Dataset.coarsen - Dataset.resample - Dataset.diff - Dataset.quantile - Dataset.differentiate - Dataset.integrate - Dataset.map_blocks - Dataset.polyfit - Dataset.curvefit - Dataset.eval - -Aggregation ------------ - -.. autosummary:: - :toctree: generated/ - - Dataset.all - Dataset.any - Dataset.argmax - Dataset.argmin - Dataset.count - Dataset.idxmax - Dataset.idxmin - Dataset.max - Dataset.min - Dataset.mean - Dataset.median - Dataset.prod - Dataset.sum - Dataset.std - Dataset.var - Dataset.cumsum - Dataset.cumprod - -ndarray methods ---------------- - -.. autosummary:: - :toctree: generated/ - - Dataset.argsort - Dataset.astype - Dataset.clip - Dataset.conj - Dataset.conjugate - Dataset.imag - Dataset.round - Dataset.real - Dataset.rank - -Reshaping and reorganizing --------------------------- - -.. autosummary:: - :toctree: generated/ - - Dataset.transpose - Dataset.stack - Dataset.unstack - Dataset.to_stacked_array - Dataset.shift - Dataset.roll - Dataset.pad - Dataset.sortby - Dataset.broadcast_like - -DataArray -========= - -.. autosummary:: - :toctree: generated/ - - DataArray - -Attributes ----------- - -.. autosummary:: - :toctree: generated/ - - DataArray.values - DataArray.data - DataArray.coords - DataArray.dims - DataArray.sizes - DataArray.name - DataArray.attrs - DataArray.encoding - DataArray.indexes - DataArray.xindexes - DataArray.chunksizes - -ndarray attributes ------------------- - -.. autosummary:: - :toctree: generated/ - - DataArray.ndim - DataArray.nbytes - DataArray.shape - DataArray.size - DataArray.dtype - DataArray.chunks - - -DataArray contents ------------------- - -.. autosummary:: - :toctree: generated/ - - DataArray.assign_coords - DataArray.assign_attrs - DataArray.pipe - DataArray.rename - DataArray.swap_dims - DataArray.expand_dims - DataArray.drop_vars - DataArray.drop_indexes - DataArray.drop_duplicates - DataArray.drop_encoding - DataArray.drop_attrs - DataArray.reset_coords - DataArray.copy - DataArray.convert_calendar - DataArray.interp_calendar - DataArray.get_index - DataArray.astype - DataArray.item - -Indexing --------- - -.. autosummary:: - :toctree: generated/ - - DataArray.__getitem__ - DataArray.__setitem__ - DataArray.loc - DataArray.isel - DataArray.sel - DataArray.drop_sel - DataArray.drop_isel - DataArray.head - DataArray.tail - DataArray.thin - DataArray.squeeze - DataArray.interp - DataArray.interp_like - DataArray.reindex - DataArray.reindex_like - DataArray.set_index - DataArray.reset_index - DataArray.set_xindex - DataArray.reorder_levels - DataArray.query - -Missing value handling ----------------------- - -.. autosummary:: - :toctree: generated/ - - DataArray.isnull - DataArray.notnull - DataArray.combine_first - DataArray.count - DataArray.dropna - DataArray.fillna - DataArray.ffill - DataArray.bfill - DataArray.interpolate_na - DataArray.where - DataArray.isin - -Comparisons ------------ - -.. autosummary:: - :toctree: generated/ - - DataArray.equals - DataArray.identical - DataArray.broadcast_equals - -Computation ------------ - -.. autosummary:: - :toctree: generated/ - - DataArray.reduce - DataArray.groupby - DataArray.groupby_bins - DataArray.rolling - DataArray.rolling_exp - DataArray.cumulative - DataArray.weighted - DataArray.coarsen - DataArray.resample - DataArray.get_axis_num - DataArray.diff - DataArray.dot - DataArray.quantile - DataArray.differentiate - DataArray.integrate - DataArray.polyfit - DataArray.map_blocks - DataArray.curvefit - -Aggregation ------------ - -.. autosummary:: - :toctree: generated/ - - DataArray.all - DataArray.any - DataArray.argmax - DataArray.argmin - DataArray.count - DataArray.idxmax - DataArray.idxmin - DataArray.max - DataArray.min - DataArray.mean - DataArray.median - DataArray.prod - DataArray.sum - DataArray.std - DataArray.var - DataArray.cumsum - DataArray.cumprod - -ndarray methods ---------------- - -.. autosummary:: - :toctree: generated/ - - DataArray.argsort - DataArray.clip - DataArray.conj - DataArray.conjugate - DataArray.imag - DataArray.searchsorted - DataArray.round - DataArray.real - DataArray.T - DataArray.rank - - -String manipulation -------------------- - -.. autosummary:: - :toctree: generated/ - :template: autosummary/accessor.rst - - DataArray.str - -.. autosummary:: - :toctree: generated/ - :template: autosummary/accessor_method.rst - - DataArray.str.capitalize - DataArray.str.casefold - DataArray.str.cat - DataArray.str.center - DataArray.str.contains - DataArray.str.count - DataArray.str.decode - DataArray.str.encode - DataArray.str.endswith - DataArray.str.extract - DataArray.str.extractall - DataArray.str.find - DataArray.str.findall - DataArray.str.format - DataArray.str.get - DataArray.str.get_dummies - DataArray.str.index - DataArray.str.isalnum - DataArray.str.isalpha - DataArray.str.isdecimal - DataArray.str.isdigit - DataArray.str.islower - DataArray.str.isnumeric - DataArray.str.isspace - DataArray.str.istitle - DataArray.str.isupper - DataArray.str.join - DataArray.str.len - DataArray.str.ljust - DataArray.str.lower - DataArray.str.lstrip - DataArray.str.match - DataArray.str.normalize - DataArray.str.pad - DataArray.str.partition - DataArray.str.repeat - DataArray.str.replace - DataArray.str.rfind - DataArray.str.rindex - DataArray.str.rjust - DataArray.str.rpartition - DataArray.str.rsplit - DataArray.str.rstrip - DataArray.str.slice - DataArray.str.slice_replace - DataArray.str.split - DataArray.str.startswith - DataArray.str.strip - DataArray.str.swapcase - DataArray.str.title - DataArray.str.translate - DataArray.str.upper - DataArray.str.wrap - DataArray.str.zfill - -Datetimelike properties ------------------------ - -**Datetime properties**: - -.. autosummary:: - :toctree: generated/ - :template: autosummary/accessor_attribute.rst - - DataArray.dt.year - DataArray.dt.month - DataArray.dt.day - DataArray.dt.hour - DataArray.dt.minute - DataArray.dt.second - DataArray.dt.microsecond - DataArray.dt.nanosecond - DataArray.dt.dayofweek - DataArray.dt.weekday - DataArray.dt.dayofyear - DataArray.dt.quarter - DataArray.dt.days_in_month - DataArray.dt.daysinmonth - DataArray.dt.days_in_year - DataArray.dt.season - DataArray.dt.time - DataArray.dt.date - DataArray.dt.decimal_year - DataArray.dt.calendar - DataArray.dt.is_month_start - DataArray.dt.is_month_end - DataArray.dt.is_quarter_end - DataArray.dt.is_year_start - DataArray.dt.is_leap_year - -**Datetime methods**: - -.. autosummary:: - :toctree: generated/ - :template: autosummary/accessor_method.rst - - DataArray.dt.floor - DataArray.dt.ceil - DataArray.dt.isocalendar - DataArray.dt.round - DataArray.dt.strftime - -**Timedelta properties**: - -.. autosummary:: - :toctree: generated/ - :template: autosummary/accessor_attribute.rst - - DataArray.dt.days - DataArray.dt.seconds - DataArray.dt.microseconds - DataArray.dt.nanoseconds - DataArray.dt.total_seconds - -**Timedelta methods**: - -.. autosummary:: - :toctree: generated/ - :template: autosummary/accessor_method.rst - - DataArray.dt.floor - DataArray.dt.ceil - DataArray.dt.round - - -Reshaping and reorganizing --------------------------- - -.. autosummary:: - :toctree: generated/ - - DataArray.transpose - DataArray.stack - DataArray.unstack - DataArray.to_unstacked_dataset - DataArray.shift - DataArray.roll - DataArray.pad - DataArray.sortby - DataArray.broadcast_like - -DataTree -======== - -Creating a DataTree -------------------- - -Methods of creating a ``DataTree``. - -.. autosummary:: - :toctree: generated/ - - DataTree - DataTree.from_dict - -Tree Attributes ---------------- - -Attributes relating to the recursive tree-like structure of a ``DataTree``. - -.. autosummary:: - :toctree: generated/ - - DataTree.parent - DataTree.children - DataTree.name - DataTree.path - DataTree.root - DataTree.is_root - DataTree.is_leaf - DataTree.leaves - DataTree.level - DataTree.depth - DataTree.width - DataTree.subtree - DataTree.subtree_with_keys - DataTree.descendants - DataTree.siblings - DataTree.lineage - DataTree.parents - DataTree.ancestors - DataTree.groups - DataTree.xindexes - -Data Contents -------------- - -Interface to the data objects (optionally) stored inside a single ``DataTree`` node. -This interface echoes that of ``xarray.Dataset``. - -.. autosummary:: - :toctree: generated/ - - DataTree.dims - DataTree.sizes - DataTree.data_vars - DataTree.ds - DataTree.coords - DataTree.attrs - DataTree.encoding - DataTree.indexes - DataTree.nbytes - DataTree.dataset - DataTree.to_dataset - DataTree.has_data - DataTree.has_attrs - DataTree.is_empty - DataTree.is_hollow - DataTree.chunksizes - -Dictionary Interface --------------------- - -``DataTree`` objects also have a dict-like interface mapping keys to either ``xarray.DataArray``\s or to child ``DataTree`` nodes. - -.. autosummary:: - :toctree: generated/ - - DataTree.__getitem__ - DataTree.__setitem__ - DataTree.__delitem__ - DataTree.update - DataTree.get - DataTree.items - DataTree.keys - DataTree.values - -Tree Manipulation ------------------ - -For manipulating, traversing, navigating, or mapping over the tree structure. - -.. autosummary:: - :toctree: generated/ - - DataTree.orphan - DataTree.same_tree - DataTree.relative_to - DataTree.iter_lineage - DataTree.find_common_ancestor - DataTree.map_over_datasets - DataTree.pipe - DataTree.match - DataTree.filter - DataTree.filter_like - -Pathlib-like Interface ----------------------- - -``DataTree`` objects deliberately echo some of the API of :py:class:`pathlib.PurePath`. - -.. autosummary:: - :toctree: generated/ - - DataTree.name - DataTree.parent - DataTree.parents - DataTree.relative_to - -.. Missing: - -.. .. - -.. ``DataTree.glob`` -.. ``DataTree.joinpath`` -.. ``DataTree.with_name`` -.. ``DataTree.walk`` -.. ``DataTree.rename`` -.. ``DataTree.replace`` - -DataTree Contents ------------------ - -Manipulate the contents of all nodes in a ``DataTree`` simultaneously. - -.. autosummary:: - :toctree: generated/ - - DataTree.copy - - .. DataTree.assign_coords - .. DataTree.merge - .. DataTree.rename - .. DataTree.rename_vars - .. DataTree.rename_dims - .. DataTree.swap_dims - .. DataTree.expand_dims - .. DataTree.drop_vars - .. DataTree.drop_dims - .. DataTree.set_coords - .. DataTree.reset_coords - -DataTree Node Contents ----------------------- - -Manipulate the contents of a single ``DataTree`` node. - -.. autosummary:: - :toctree: generated/ - - DataTree.assign - DataTree.drop_nodes - -DataTree Operations -------------------- - -Apply operations over multiple ``DataTree`` objects. - -.. autosummary:: - :toctree: generated/ - - map_over_datasets - group_subtrees - -Comparisons ------------ - -Compare one ``DataTree`` object to another. - -.. autosummary:: - :toctree: generated/ - - DataTree.isomorphic - DataTree.equals - DataTree.identical - -Indexing --------- - -Index into all nodes in the subtree simultaneously. - -.. autosummary:: - :toctree: generated/ - - DataTree.isel - DataTree.sel - -.. DataTree.drop_sel -.. DataTree.drop_isel -.. DataTree.head -.. DataTree.tail -.. DataTree.thin -.. DataTree.squeeze -.. DataTree.interp -.. DataTree.interp_like -.. DataTree.reindex -.. DataTree.reindex_like -.. DataTree.set_index -.. DataTree.reset_index -.. DataTree.reorder_levels -.. DataTree.query - -.. .. - -.. Missing: -.. ``DataTree.loc`` - - -.. Missing Value Handling -.. ---------------------- - -.. .. autosummary:: -.. :toctree: generated/ - -.. DataTree.isnull -.. DataTree.notnull -.. DataTree.combine_first -.. DataTree.dropna -.. DataTree.fillna -.. DataTree.ffill -.. DataTree.bfill -.. DataTree.interpolate_na -.. DataTree.where -.. DataTree.isin - -.. Computation -.. ----------- - -.. Apply a computation to the data in all nodes in the subtree simultaneously. - -.. .. autosummary:: -.. :toctree: generated/ - -.. DataTree.map -.. DataTree.reduce -.. DataTree.diff -.. DataTree.quantile -.. DataTree.differentiate -.. DataTree.integrate -.. DataTree.map_blocks -.. DataTree.polyfit -.. DataTree.curvefit - -Aggregation ------------ - -Aggregate data in all nodes in the subtree simultaneously. - -.. autosummary:: - :toctree: generated/ - - DataTree.all - DataTree.any - DataTree.max - DataTree.min - DataTree.mean - DataTree.median - DataTree.prod - DataTree.sum - DataTree.std - DataTree.var - DataTree.cumsum - DataTree.cumprod - -ndarray methods ---------------- - -Methods copied from :py:class:`numpy.ndarray` objects, here applying to the data in all nodes in the subtree. - -.. autosummary:: - :toctree: generated/ - - DataTree.argsort - DataTree.conj - DataTree.conjugate - DataTree.round -.. DataTree.astype -.. DataTree.clip -.. DataTree.rank - -.. Reshaping and reorganising -.. -------------------------- - -.. Reshape or reorganise the data in all nodes in the subtree. - -.. .. autosummary:: -.. :toctree: generated/ - -.. DataTree.transpose -.. DataTree.stack -.. DataTree.unstack -.. DataTree.shift -.. DataTree.roll -.. DataTree.pad -.. DataTree.sortby -.. DataTree.broadcast_like - -Coordinates -=========== - -Creating coordinates --------------------- - -.. autosummary:: - :toctree: generated/ - - Coordinates - Coordinates.from_xindex - Coordinates.from_pandas_multiindex - -Attributes ----------- - -.. autosummary:: - :toctree: generated/ - - Coordinates.dims - Coordinates.sizes - Coordinates.dtypes - Coordinates.variables - Coordinates.indexes - Coordinates.xindexes - -Dictionary Interface --------------------- - -Coordinates implement the mapping interface with keys given by variable names -and values given by ``DataArray`` objects. - -.. autosummary:: - :toctree: generated/ - - Coordinates.__getitem__ - Coordinates.__setitem__ - Coordinates.__delitem__ - Coordinates.update - Coordinates.get - Coordinates.items - Coordinates.keys - Coordinates.values - -Coordinates contents --------------------- - -.. autosummary:: - :toctree: generated/ - - Coordinates.to_dataset - Coordinates.to_index - Coordinates.assign - Coordinates.merge - Coordinates.copy - -Comparisons ------------ - -.. autosummary:: - :toctree: generated/ - - Coordinates.equals - Coordinates.identical - -Proxies -------- - -Coordinates that are accessed from the ``coords`` property of Dataset, DataArray -and DataTree objects, respectively. - -.. autosummary:: - :toctree: generated/ - - core.coordinates.DatasetCoordinates - core.coordinates.DataArrayCoordinates - core.coordinates.DataTreeCoordinates - -Indexes -======= - -Default, pandas-backed indexes built-in to Xarray: - -.. autosummary:: - :toctree: generated/ - - indexes.PandasIndex - indexes.PandasMultiIndex - - -More complex indexes built-in to Xarray: - -.. autosummary:: - :toctree: generated/ - - CFTimeIndex - indexes.RangeIndex - indexes.NDPointIndex - - -Creating indexes ----------------- -.. autosummary:: - :toctree: generated/ - - cftime_range - date_range - date_range_like - indexes.RangeIndex.arange - indexes.RangeIndex.linspace - - -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: - -.. autosummary:: - :toctree: generated/ - - ufuncs.abs - ufuncs.absolute - ufuncs.acos - ufuncs.acosh - ufuncs.arccos - ufuncs.arccosh - ufuncs.arcsin - ufuncs.arcsinh - ufuncs.arctan - ufuncs.arctanh - ufuncs.asin - ufuncs.asinh - ufuncs.atan - ufuncs.atanh - ufuncs.bitwise_count - ufuncs.bitwise_invert - ufuncs.bitwise_not - ufuncs.cbrt - ufuncs.ceil - ufuncs.conj - ufuncs.conjugate - ufuncs.cos - ufuncs.cosh - ufuncs.deg2rad - ufuncs.degrees - ufuncs.exp - ufuncs.exp2 - ufuncs.expm1 - ufuncs.fabs - ufuncs.floor - ufuncs.invert - ufuncs.isfinite - ufuncs.isinf - ufuncs.isnan - ufuncs.isnat - ufuncs.log - ufuncs.log10 - ufuncs.log1p - ufuncs.log2 - ufuncs.logical_not - ufuncs.negative - ufuncs.positive - ufuncs.rad2deg - ufuncs.radians - ufuncs.reciprocal - ufuncs.rint - ufuncs.sign - ufuncs.signbit - ufuncs.sin - ufuncs.sinh - ufuncs.spacing - ufuncs.sqrt - ufuncs.square - ufuncs.tan - ufuncs.tanh - ufuncs.trunc - ufuncs.add - ufuncs.arctan2 - ufuncs.atan2 - ufuncs.bitwise_and - ufuncs.bitwise_left_shift - ufuncs.bitwise_or - ufuncs.bitwise_right_shift - ufuncs.bitwise_xor - ufuncs.copysign - ufuncs.divide - ufuncs.equal - ufuncs.float_power - ufuncs.floor_divide - ufuncs.fmax - ufuncs.fmin - ufuncs.fmod - ufuncs.gcd - ufuncs.greater - ufuncs.greater_equal - ufuncs.heaviside - ufuncs.hypot - ufuncs.lcm - ufuncs.ldexp - ufuncs.left_shift - ufuncs.less - ufuncs.less_equal - ufuncs.logaddexp - ufuncs.logaddexp2 - ufuncs.logical_and - ufuncs.logical_or - ufuncs.logical_xor - ufuncs.maximum - ufuncs.minimum - ufuncs.mod - ufuncs.multiply - ufuncs.nextafter - ufuncs.not_equal - ufuncs.pow - ufuncs.power - ufuncs.remainder - ufuncs.right_shift - ufuncs.subtract - ufuncs.true_divide - ufuncs.angle - ufuncs.isreal - ufuncs.iscomplex - -IO / Conversion -=============== - -Dataset methods ---------------- - -.. autosummary:: - :toctree: generated/ - - load_dataset - open_dataset - open_mfdataset - open_zarr - save_mfdataset - Dataset.as_numpy - Dataset.from_dataframe - Dataset.from_dict - Dataset.to_dataarray - Dataset.to_dataframe - Dataset.to_dask_dataframe - Dataset.to_dict - Dataset.to_netcdf - Dataset.to_pandas - Dataset.to_zarr - Dataset.chunk - Dataset.close - Dataset.compute - Dataset.filter_by_attrs - Dataset.info - Dataset.load - Dataset.persist - Dataset.unify_chunks - -DataArray methods ------------------ - -.. autosummary:: - :toctree: generated/ - - load_dataarray - open_dataarray - DataArray.as_numpy - DataArray.from_dict - DataArray.from_iris - DataArray.from_series - DataArray.to_dask_dataframe - DataArray.to_dataframe - DataArray.to_dataset - DataArray.to_dict - DataArray.to_index - DataArray.to_iris - DataArray.to_masked_array - DataArray.to_netcdf - DataArray.to_numpy - DataArray.to_pandas - DataArray.to_series - DataArray.to_zarr - DataArray.chunk - DataArray.close - DataArray.compute - DataArray.persist - DataArray.load - DataArray.unify_chunks - -DataTree methods ----------------- - -.. autosummary:: - :toctree: generated/ - - open_datatree - open_groups - DataTree.to_dict - DataTree.to_netcdf - DataTree.to_zarr - DataTree.chunk - DataTree.load - DataTree.compute - DataTree.persist - -.. .. - -.. Missing: -.. ``open_mfdatatree`` - -Encoding/Decoding -================= - -Coder objects -------------- - -.. autosummary:: - :toctree: generated/ - - coders.CFDatetimeCoder - -Plotting -======== - -Dataset -------- - -.. autosummary:: - :toctree: generated/ - :template: autosummary/accessor_method.rst - - Dataset.plot.scatter - Dataset.plot.quiver - Dataset.plot.streamplot - -DataArray ---------- - -.. autosummary:: - :toctree: generated/ - :template: autosummary/accessor_callable.rst - - DataArray.plot - -.. autosummary:: - :toctree: generated/ - :template: autosummary/accessor_method.rst - - DataArray.plot.contourf - DataArray.plot.contour - DataArray.plot.hist - DataArray.plot.imshow - DataArray.plot.line - DataArray.plot.pcolormesh - DataArray.plot.step - DataArray.plot.scatter - DataArray.plot.surface - - -Faceting --------- -.. autosummary:: - :toctree: generated/ - - plot.FacetGrid - plot.FacetGrid.add_colorbar - plot.FacetGrid.add_legend - plot.FacetGrid.add_quiverkey - plot.FacetGrid.map - plot.FacetGrid.map_dataarray - plot.FacetGrid.map_dataarray_line - plot.FacetGrid.map_dataset - plot.FacetGrid.map_plot1d - plot.FacetGrid.set_axis_labels - plot.FacetGrid.set_ticks - plot.FacetGrid.set_titles - plot.FacetGrid.set_xlabels - plot.FacetGrid.set_ylabels - - - -GroupBy objects -=============== - -.. currentmodule:: xarray.core.groupby - -Dataset -------- - -.. autosummary:: - :toctree: generated/ - - DatasetGroupBy - DatasetGroupBy.map - DatasetGroupBy.reduce - DatasetGroupBy.assign - DatasetGroupBy.assign_coords - DatasetGroupBy.first - DatasetGroupBy.last - DatasetGroupBy.fillna - DatasetGroupBy.quantile - DatasetGroupBy.where - DatasetGroupBy.all - DatasetGroupBy.any - DatasetGroupBy.count - DatasetGroupBy.cumsum - DatasetGroupBy.cumprod - DatasetGroupBy.max - DatasetGroupBy.mean - DatasetGroupBy.median - DatasetGroupBy.min - DatasetGroupBy.prod - DatasetGroupBy.std - DatasetGroupBy.sum - DatasetGroupBy.var - DatasetGroupBy.dims - DatasetGroupBy.groups - DatasetGroupBy.shuffle_to_chunks - -DataArray ---------- - -.. autosummary:: - :toctree: generated/ - - DataArrayGroupBy - DataArrayGroupBy.map - DataArrayGroupBy.reduce - DataArrayGroupBy.assign_coords - DataArrayGroupBy.first - DataArrayGroupBy.last - DataArrayGroupBy.fillna - DataArrayGroupBy.quantile - DataArrayGroupBy.where - DataArrayGroupBy.all - DataArrayGroupBy.any - DataArrayGroupBy.count - DataArrayGroupBy.cumsum - DataArrayGroupBy.cumprod - DataArrayGroupBy.max - DataArrayGroupBy.mean - DataArrayGroupBy.median - DataArrayGroupBy.min - DataArrayGroupBy.prod - DataArrayGroupBy.std - DataArrayGroupBy.sum - DataArrayGroupBy.var - DataArrayGroupBy.dims - DataArrayGroupBy.groups - DataArrayGroupBy.shuffle_to_chunks - -Grouper Objects ---------------- - -.. currentmodule:: xarray - -.. autosummary:: - :toctree: generated/ - - groupers.BinGrouper - groupers.UniqueGrouper - groupers.TimeResampler - groupers.SeasonGrouper - groupers.SeasonResampler - - -Rolling objects -=============== - -.. currentmodule:: xarray.computation.rolling - -Dataset -------- - -.. autosummary:: - :toctree: generated/ - - DatasetRolling - DatasetRolling.construct - DatasetRolling.reduce - DatasetRolling.argmax - DatasetRolling.argmin - DatasetRolling.count - DatasetRolling.max - DatasetRolling.mean - DatasetRolling.median - DatasetRolling.min - DatasetRolling.prod - DatasetRolling.std - DatasetRolling.sum - DatasetRolling.var - -DataArray ---------- - -.. autosummary:: - :toctree: generated/ - - DataArrayRolling - DataArrayRolling.__iter__ - DataArrayRolling.construct - DataArrayRolling.reduce - DataArrayRolling.argmax - DataArrayRolling.argmin - DataArrayRolling.count - DataArrayRolling.max - DataArrayRolling.mean - DataArrayRolling.median - DataArrayRolling.min - DataArrayRolling.prod - DataArrayRolling.std - DataArrayRolling.sum - DataArrayRolling.var - -Coarsen objects -=============== - -Dataset -------- - -.. autosummary:: - :toctree: generated/ - - DatasetCoarsen - DatasetCoarsen.all - DatasetCoarsen.any - DatasetCoarsen.construct - DatasetCoarsen.count - DatasetCoarsen.max - DatasetCoarsen.mean - DatasetCoarsen.median - DatasetCoarsen.min - DatasetCoarsen.prod - DatasetCoarsen.reduce - DatasetCoarsen.std - DatasetCoarsen.sum - DatasetCoarsen.var - -DataArray ---------- - -.. autosummary:: - :toctree: generated/ - - DataArrayCoarsen - DataArrayCoarsen.all - DataArrayCoarsen.any - DataArrayCoarsen.construct - DataArrayCoarsen.count - DataArrayCoarsen.max - DataArrayCoarsen.mean - DataArrayCoarsen.median - DataArrayCoarsen.min - DataArrayCoarsen.prod - DataArrayCoarsen.reduce - DataArrayCoarsen.std - DataArrayCoarsen.sum - DataArrayCoarsen.var - -Exponential rolling objects -=========================== - -.. currentmodule:: xarray.computation.rolling_exp - -.. autosummary:: - :toctree: generated/ - - RollingExp - RollingExp.mean - RollingExp.sum - -Weighted objects -================ - -.. currentmodule:: xarray.computation.weighted - -Dataset -------- - -.. autosummary:: - :toctree: generated/ - - DatasetWeighted - DatasetWeighted.mean - DatasetWeighted.quantile - DatasetWeighted.sum - DatasetWeighted.std - DatasetWeighted.var - DatasetWeighted.sum_of_weights - DatasetWeighted.sum_of_squares - -DataArray ---------- - -.. autosummary:: - :toctree: generated/ - - DataArrayWeighted - DataArrayWeighted.mean - DataArrayWeighted.quantile - DataArrayWeighted.sum - DataArrayWeighted.std - DataArrayWeighted.var - DataArrayWeighted.sum_of_weights - DataArrayWeighted.sum_of_squares - -Resample objects -================ - -.. currentmodule:: xarray.core.resample - -Dataset -------- - -.. autosummary:: - :toctree: generated/ - - DatasetResample - DatasetResample.asfreq - DatasetResample.backfill - DatasetResample.interpolate - DatasetResample.nearest - DatasetResample.pad - DatasetResample.all - DatasetResample.any - DatasetResample.apply - DatasetResample.assign - DatasetResample.assign_coords - DatasetResample.bfill - DatasetResample.count - DatasetResample.ffill - DatasetResample.fillna - DatasetResample.first - DatasetResample.last - DatasetResample.map - DatasetResample.max - DatasetResample.mean - DatasetResample.median - DatasetResample.min - DatasetResample.prod - DatasetResample.quantile - DatasetResample.reduce - DatasetResample.std - DatasetResample.sum - DatasetResample.var - DatasetResample.where - DatasetResample.dims - DatasetResample.groups - - -DataArray ---------- - -.. autosummary:: - :toctree: generated/ - - DataArrayResample - DataArrayResample.asfreq - DataArrayResample.backfill - DataArrayResample.interpolate - DataArrayResample.nearest - DataArrayResample.pad - DataArrayResample.all - DataArrayResample.any - DataArrayResample.apply - DataArrayResample.assign_coords - DataArrayResample.bfill - DataArrayResample.count - DataArrayResample.ffill - DataArrayResample.fillna - DataArrayResample.first - DataArrayResample.last - DataArrayResample.map - DataArrayResample.max - DataArrayResample.mean - DataArrayResample.median - DataArrayResample.min - DataArrayResample.prod - DataArrayResample.quantile - DataArrayResample.reduce - DataArrayResample.std - DataArrayResample.sum - DataArrayResample.var - DataArrayResample.where - DataArrayResample.dims - DataArrayResample.groups - -Accessors -========= - -.. currentmodule:: xarray.core - -.. autosummary:: - :toctree: generated/ - - accessor_dt.DatetimeAccessor - accessor_dt.TimedeltaAccessor - accessor_str.StringAccessor - - -Custom Indexes -============== -.. currentmodule:: xarray - -Building custom indexes ------------------------ - -These classes are building blocks for more complex Indexes: - -.. autosummary:: - :toctree: generated/ - - indexes.CoordinateTransform - indexes.CoordinateTransformIndex - indexes.NDPointIndex - indexes.TreeAdapter - -The Index base class for building custom indexes: - -.. autosummary:: - :toctree: generated/ - - Index.from_variables - Index.concat - Index.stack - Index.unstack - Index.create_variables - Index.should_add_coord_to_array - Index.to_pandas_index - Index.isel - Index.sel - Index.join - Index.reindex_like - Index.equals - Index.roll - Index.rename - Index.copy - - -Tutorial -======== - -.. autosummary:: - :toctree: generated/ - - tutorial.open_dataset - tutorial.load_dataset - tutorial.open_datatree - tutorial.load_datatree - -Testing -======= - -.. autosummary:: - :toctree: generated/ - - testing.assert_equal - testing.assert_identical - testing.assert_allclose - testing.assert_chunks_equal - -Test that two ``DataTree`` objects are similar. - -.. autosummary:: - :toctree: generated/ - - testing.assert_isomorphic - testing.assert_equal - testing.assert_identical - -Hypothesis Testing Strategies -============================= - -.. currentmodule:: xarray - -See the :ref:`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. - -.. autosummary:: - :toctree: generated/ - - testing.strategies.supported_dtypes - testing.strategies.names - testing.strategies.dimension_names - testing.strategies.dimension_sizes - testing.strategies.attrs - testing.strategies.variables - testing.strategies.unique_subset_of - -Exceptions -========== - -.. autosummary:: - :toctree: generated/ - - AlignmentError - CoordinateValidationError - MergeError - SerializationWarning - -DataTree --------- - -Exceptions raised when manipulating trees. - -.. autosummary:: - :toctree: generated/ - - TreeIsomorphismError - InvalidTreeError - NotFoundInTreeError - -Advanced API -============ - -.. autosummary:: - :toctree: generated/ - - Coordinates - Dataset.variables - DataArray.variable - DataTree.variables - Variable - IndexVariable - as_variable - Index - IndexSelResult - Context - register_dataset_accessor - register_dataarray_accessor - register_datatree_accessor - Dataset.set_close - backends.BackendArray - backends.BackendEntrypoint - backends.list_engines - backends.refresh_engines - -.. .. - -.. Missing: -.. ``DataTree.set_close`` - -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: - -.. autosummary:: - :toctree: generated/ - - backends.NetCDF4DataStore - backends.H5NetCDFStore - backends.PydapDataStore - backends.ScipyDataStore - backends.ZarrStore - backends.FileManager - backends.CachingFileManager - backends.DummyFileManager - -These BackendEntrypoints provide a basic interface to the most commonly -used filetypes in the xarray universe. - -.. autosummary:: - :toctree: generated/ - - backends.NetCDF4BackendEntrypoint - backends.H5netcdfBackendEntrypoint - backends.PydapBackendEntrypoint - backends.ScipyBackendEntrypoint - backends.StoreBackendEntrypoint - backends.ZarrBackendEntrypoint - -Deprecated / Pending Deprecation -================================ - -.. autosummary:: - :toctree: generated/ - - Dataset.drop - DataArray.drop - Dataset.apply - core.groupby.DataArrayGroupBy.apply - core.groupby.DatasetGroupBy.apply - -.. autosummary:: - :toctree: generated/ - :template: autosummary/accessor_attribute.rst - - DataArray.dt.weekofyear - DataArray.dt.week +.. toctree:: + :maxdepth: 1 + + api/top-level + api/dataset + api/dataarray + api/datatree + api/coordinates + api/indexes + api/ufuncs + api/io + api/encoding + api/plotting + api/groupby + api/rolling + api/coarsen + api/rolling-exp + api/weighted + api/resample + api/accessors + api/custom-indexes + api/tutorial + api/testing + api/exceptions + api/advanced + api/deprecated diff --git a/doc/api/accessors.rst b/doc/api/accessors.rst new file mode 100644 index 00000000000..d9e7fb8d6dd --- /dev/null +++ b/doc/api/accessors.rst @@ -0,0 +1,13 @@ +.. currentmodule:: xarray + +Accessors +========= + +.. currentmodule:: xarray.core + +.. autosummary:: + :toctree: generated/ + + accessor_dt.DatetimeAccessor + accessor_dt.TimedeltaAccessor + accessor_str.StringAccessor diff --git a/doc/api/advanced.rst b/doc/api/advanced.rst new file mode 100644 index 00000000000..5585beb3e52 --- /dev/null +++ b/doc/api/advanced.rst @@ -0,0 +1,60 @@ +.. currentmodule:: xarray + +Advanced API +============ + +.. autosummary:: + :toctree: generated/ + + Coordinates + Dataset.variables + DataArray.variable + DataTree.variables + Variable + IndexVariable + as_variable + Index + IndexSelResult + Context + register_dataset_accessor + register_dataarray_accessor + register_datatree_accessor + Dataset.set_close + backends.BackendArray + backends.BackendEntrypoint + backends.list_engines + backends.refresh_engines + +.. .. + +.. Missing: +.. ``DataTree.set_close`` + +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: + +.. autosummary:: + :toctree: generated/ + + backends.NetCDF4DataStore + backends.H5NetCDFStore + backends.PydapDataStore + backends.ScipyDataStore + backends.ZarrStore + backends.FileManager + backends.CachingFileManager + backends.DummyFileManager + +These BackendEntrypoints provide a basic interface to the most commonly +used filetypes in the xarray universe. + +.. autosummary:: + :toctree: generated/ + + backends.NetCDF4BackendEntrypoint + backends.H5netcdfBackendEntrypoint + backends.PydapBackendEntrypoint + backends.ScipyBackendEntrypoint + backends.StoreBackendEntrypoint + backends.ZarrBackendEntrypoint diff --git a/doc/api/coarsen.rst b/doc/api/coarsen.rst new file mode 100644 index 00000000000..d3edc722044 --- /dev/null +++ b/doc/api/coarsen.rst @@ -0,0 +1,48 @@ +.. currentmodule:: xarray + +Coarsen objects +=============== + +.. currentmodule:: xarray.computation.rolling + +Dataset +------- + +.. autosummary:: + :toctree: generated/ + + DatasetCoarsen + DatasetCoarsen.all + DatasetCoarsen.any + DatasetCoarsen.construct + DatasetCoarsen.count + DatasetCoarsen.max + DatasetCoarsen.mean + DatasetCoarsen.median + DatasetCoarsen.min + DatasetCoarsen.prod + DatasetCoarsen.reduce + DatasetCoarsen.std + DatasetCoarsen.sum + DatasetCoarsen.var + +DataArray +--------- + +.. autosummary:: + :toctree: generated/ + + DataArrayCoarsen + DataArrayCoarsen.all + DataArrayCoarsen.any + DataArrayCoarsen.construct + DataArrayCoarsen.count + DataArrayCoarsen.max + DataArrayCoarsen.mean + DataArrayCoarsen.median + DataArrayCoarsen.min + DataArrayCoarsen.prod + DataArrayCoarsen.reduce + DataArrayCoarsen.std + DataArrayCoarsen.sum + DataArrayCoarsen.var diff --git a/doc/api/coordinates.rst b/doc/api/coordinates.rst new file mode 100644 index 00000000000..513a87af895 --- /dev/null +++ b/doc/api/coordinates.rst @@ -0,0 +1,79 @@ +.. currentmodule:: xarray + +Coordinates +=========== + +Creating coordinates +-------------------- + +.. autosummary:: + :toctree: generated/ + + Coordinates + Coordinates.from_xindex + Coordinates.from_pandas_multiindex + +Attributes +---------- + +.. autosummary:: + :toctree: generated/ + + Coordinates.dims + Coordinates.sizes + Coordinates.dtypes + Coordinates.variables + Coordinates.indexes + Coordinates.xindexes + +Dictionary Interface +-------------------- + +Coordinates implement the mapping interface with keys given by variable names +and values given by ``DataArray`` objects. + +.. autosummary:: + :toctree: generated/ + + Coordinates.__getitem__ + Coordinates.__setitem__ + Coordinates.__delitem__ + Coordinates.update + Coordinates.get + Coordinates.items + Coordinates.keys + Coordinates.values + +Coordinates contents +-------------------- + +.. autosummary:: + :toctree: generated/ + + Coordinates.to_dataset + Coordinates.to_index + Coordinates.assign + Coordinates.merge + Coordinates.copy + +Comparisons +----------- + +.. autosummary:: + :toctree: generated/ + + Coordinates.equals + Coordinates.identical + +Proxies +------- + +Coordinates that are accessed from the ``coords`` property of Dataset, DataArray +and DataTree objects, respectively. + +.. autosummary:: + :toctree: generated/ + + core.coordinates.DatasetCoordinates + core.coordinates.DataArrayCoordinates + core.coordinates.DataTreeCoordinates diff --git a/doc/api/custom-indexes.rst b/doc/api/custom-indexes.rst new file mode 100644 index 00000000000..153f51d1ba6 --- /dev/null +++ b/doc/api/custom-indexes.rst @@ -0,0 +1,39 @@ +.. currentmodule:: xarray + +Custom Indexes +============== +.. currentmodule:: xarray + +Building custom indexes +----------------------- + +These classes are building blocks for more complex Indexes: + +.. autosummary:: + :toctree: generated/ + + indexes.CoordinateTransform + indexes.CoordinateTransformIndex + indexes.NDPointIndex + indexes.TreeAdapter + +The Index base class for building custom indexes: + +.. autosummary:: + :toctree: generated/ + + Index.from_variables + Index.concat + Index.stack + Index.unstack + Index.create_variables + Index.should_add_coord_to_array + Index.to_pandas_index + Index.isel + Index.sel + Index.join + Index.reindex_like + Index.equals + Index.roll + Index.rename + Index.copy diff --git a/doc/api/dataarray.rst b/doc/api/dataarray.rst new file mode 100644 index 00000000000..e21c9d85a0a --- /dev/null +++ b/doc/api/dataarray.rst @@ -0,0 +1,342 @@ +.. currentmodule:: xarray + +DataArray +========= + +.. autosummary:: + :toctree: generated/ + + DataArray + +Attributes +---------- + +.. autosummary:: + :toctree: generated/ + + DataArray.values + DataArray.data + DataArray.coords + DataArray.dims + DataArray.sizes + DataArray.name + DataArray.attrs + DataArray.encoding + DataArray.indexes + DataArray.xindexes + DataArray.chunksizes + +ndarray attributes +------------------ + +.. autosummary:: + :toctree: generated/ + + DataArray.ndim + DataArray.nbytes + DataArray.shape + DataArray.size + DataArray.dtype + DataArray.chunks + + +DataArray contents +------------------ + +.. autosummary:: + :toctree: generated/ + + DataArray.assign_coords + DataArray.assign_attrs + DataArray.pipe + DataArray.rename + DataArray.swap_dims + DataArray.expand_dims + DataArray.drop_vars + DataArray.drop_indexes + DataArray.drop_duplicates + DataArray.drop_encoding + DataArray.drop_attrs + DataArray.reset_coords + DataArray.copy + DataArray.convert_calendar + DataArray.interp_calendar + DataArray.get_index + DataArray.astype + DataArray.item + +Indexing +-------- + +.. autosummary:: + :toctree: generated/ + + DataArray.__getitem__ + DataArray.__setitem__ + DataArray.loc + DataArray.isel + DataArray.sel + DataArray.drop_sel + DataArray.drop_isel + DataArray.head + DataArray.tail + DataArray.thin + DataArray.squeeze + DataArray.interp + DataArray.interp_like + DataArray.reindex + DataArray.reindex_like + DataArray.set_index + DataArray.reset_index + DataArray.set_xindex + DataArray.reorder_levels + DataArray.query + +Missing value handling +---------------------- + +.. autosummary:: + :toctree: generated/ + + DataArray.isnull + DataArray.notnull + DataArray.combine_first + DataArray.count + DataArray.dropna + DataArray.fillna + DataArray.ffill + DataArray.bfill + DataArray.interpolate_na + DataArray.where + DataArray.isin + +Comparisons +----------- + +.. autosummary:: + :toctree: generated/ + + DataArray.equals + DataArray.identical + DataArray.broadcast_equals + +Computation +----------- + +.. autosummary:: + :toctree: generated/ + + DataArray.reduce + DataArray.groupby + DataArray.groupby_bins + DataArray.rolling + DataArray.rolling_exp + DataArray.cumulative + DataArray.weighted + DataArray.coarsen + DataArray.resample + DataArray.get_axis_num + DataArray.diff + DataArray.dot + DataArray.quantile + DataArray.differentiate + DataArray.integrate + DataArray.polyfit + DataArray.map_blocks + DataArray.curvefit + +Aggregation +----------- + +.. autosummary:: + :toctree: generated/ + + DataArray.all + DataArray.any + DataArray.argmax + DataArray.argmin + DataArray.count + DataArray.idxmax + DataArray.idxmin + DataArray.max + DataArray.min + DataArray.mean + DataArray.median + DataArray.prod + DataArray.sum + DataArray.std + DataArray.var + DataArray.cumsum + DataArray.cumprod + +ndarray methods +--------------- + +.. autosummary:: + :toctree: generated/ + + DataArray.argsort + DataArray.clip + DataArray.conj + DataArray.conjugate + DataArray.imag + DataArray.searchsorted + DataArray.round + DataArray.real + DataArray.T + DataArray.rank + + +String manipulation +------------------- + +.. autosummary:: + :toctree: generated/ + :template: autosummary/accessor.rst + + DataArray.str + +.. autosummary:: + :toctree: generated/ + :template: autosummary/accessor_method.rst + + DataArray.str.capitalize + DataArray.str.casefold + DataArray.str.cat + DataArray.str.center + DataArray.str.contains + DataArray.str.count + DataArray.str.decode + DataArray.str.encode + DataArray.str.endswith + DataArray.str.extract + DataArray.str.extractall + DataArray.str.find + DataArray.str.findall + DataArray.str.format + DataArray.str.get + DataArray.str.get_dummies + DataArray.str.index + DataArray.str.isalnum + DataArray.str.isalpha + DataArray.str.isdecimal + DataArray.str.isdigit + DataArray.str.islower + DataArray.str.isnumeric + DataArray.str.isspace + DataArray.str.istitle + DataArray.str.isupper + DataArray.str.join + DataArray.str.len + DataArray.str.ljust + DataArray.str.lower + DataArray.str.lstrip + DataArray.str.match + DataArray.str.normalize + DataArray.str.pad + DataArray.str.partition + DataArray.str.repeat + DataArray.str.replace + DataArray.str.rfind + DataArray.str.rindex + DataArray.str.rjust + DataArray.str.rpartition + DataArray.str.rsplit + DataArray.str.rstrip + DataArray.str.slice + DataArray.str.slice_replace + DataArray.str.split + DataArray.str.startswith + DataArray.str.strip + DataArray.str.swapcase + DataArray.str.title + DataArray.str.translate + DataArray.str.upper + DataArray.str.wrap + DataArray.str.zfill + +Datetimelike properties +----------------------- + +**Datetime properties**: + +.. autosummary:: + :toctree: generated/ + :template: autosummary/accessor_attribute.rst + + DataArray.dt.year + DataArray.dt.month + DataArray.dt.day + DataArray.dt.hour + DataArray.dt.minute + DataArray.dt.second + DataArray.dt.microsecond + DataArray.dt.nanosecond + DataArray.dt.dayofweek + DataArray.dt.weekday + DataArray.dt.dayofyear + DataArray.dt.quarter + DataArray.dt.days_in_month + DataArray.dt.daysinmonth + DataArray.dt.days_in_year + DataArray.dt.season + DataArray.dt.time + DataArray.dt.date + DataArray.dt.decimal_year + DataArray.dt.calendar + DataArray.dt.is_month_start + DataArray.dt.is_month_end + DataArray.dt.is_quarter_end + DataArray.dt.is_year_start + DataArray.dt.is_leap_year + +**Datetime methods**: + +.. autosummary:: + :toctree: generated/ + :template: autosummary/accessor_method.rst + + DataArray.dt.floor + DataArray.dt.ceil + DataArray.dt.isocalendar + DataArray.dt.round + DataArray.dt.strftime + +**Timedelta properties**: + +.. autosummary:: + :toctree: generated/ + :template: autosummary/accessor_attribute.rst + + DataArray.dt.days + DataArray.dt.seconds + DataArray.dt.microseconds + DataArray.dt.nanoseconds + DataArray.dt.total_seconds + +**Timedelta methods**: + +.. autosummary:: + :toctree: generated/ + :template: autosummary/accessor_method.rst + + DataArray.dt.floor + DataArray.dt.ceil + DataArray.dt.round + + +Reshaping and reorganizing +-------------------------- + +.. autosummary:: + :toctree: generated/ + + DataArray.transpose + DataArray.stack + DataArray.unstack + DataArray.to_unstacked_dataset + DataArray.shift + DataArray.roll + DataArray.pad + DataArray.sortby + DataArray.broadcast_like diff --git a/doc/api/dataset.rst b/doc/api/dataset.rst new file mode 100644 index 00000000000..e11ef368aad --- /dev/null +++ b/doc/api/dataset.rst @@ -0,0 +1,213 @@ +.. currentmodule:: xarray + +Dataset +======= + +Creating a dataset +------------------ + +.. autosummary:: + :toctree: generated/ + + Dataset + decode_cf + +Attributes +---------- + +.. autosummary:: + :toctree: generated/ + + Dataset.dims + Dataset.sizes + Dataset.dtypes + Dataset.data_vars + Dataset.coords + Dataset.attrs + Dataset.encoding + Dataset.indexes + Dataset.xindexes + Dataset.chunks + Dataset.chunksizes + Dataset.nbytes + +Dictionary interface +-------------------- + +Datasets implement the mapping interface with keys given by variable names +and values given by ``DataArray`` objects. + +.. autosummary:: + :toctree: generated/ + + Dataset.__getitem__ + Dataset.__setitem__ + Dataset.__delitem__ + Dataset.update + Dataset.get + Dataset.items + Dataset.keys + Dataset.values + +Dataset contents +---------------- + +.. autosummary:: + :toctree: generated/ + + Dataset.copy + Dataset.assign + Dataset.assign_coords + Dataset.assign_attrs + Dataset.pipe + Dataset.merge + Dataset.rename + Dataset.rename_vars + Dataset.rename_dims + Dataset.swap_dims + Dataset.expand_dims + Dataset.drop_vars + Dataset.drop_indexes + Dataset.drop_duplicates + Dataset.drop_dims + Dataset.drop_encoding + Dataset.drop_attrs + Dataset.set_coords + Dataset.reset_coords + Dataset.convert_calendar + Dataset.interp_calendar + Dataset.get_index + +Comparisons +----------- + +.. autosummary:: + :toctree: generated/ + + Dataset.equals + Dataset.identical + Dataset.broadcast_equals + +Indexing +-------- + +.. autosummary:: + :toctree: generated/ + + Dataset.loc + Dataset.isel + Dataset.sel + Dataset.drop_sel + Dataset.drop_isel + Dataset.head + Dataset.tail + Dataset.thin + Dataset.squeeze + Dataset.interp + Dataset.interp_like + Dataset.reindex + Dataset.reindex_like + Dataset.set_index + Dataset.reset_index + Dataset.set_xindex + Dataset.reorder_levels + Dataset.query + +Missing value handling +---------------------- + +.. autosummary:: + :toctree: generated/ + + Dataset.isnull + Dataset.notnull + Dataset.combine_first + Dataset.count + Dataset.dropna + Dataset.fillna + Dataset.ffill + Dataset.bfill + Dataset.interpolate_na + Dataset.where + Dataset.isin + +Computation +----------- + +.. autosummary:: + :toctree: generated/ + + Dataset.map + Dataset.reduce + Dataset.groupby + Dataset.groupby_bins + Dataset.rolling + Dataset.rolling_exp + Dataset.cumulative + Dataset.weighted + Dataset.coarsen + Dataset.resample + Dataset.diff + Dataset.quantile + Dataset.differentiate + Dataset.integrate + Dataset.map_blocks + Dataset.polyfit + Dataset.curvefit + Dataset.eval + +Aggregation +----------- + +.. autosummary:: + :toctree: generated/ + + Dataset.all + Dataset.any + Dataset.argmax + Dataset.argmin + Dataset.count + Dataset.idxmax + Dataset.idxmin + Dataset.max + Dataset.min + Dataset.mean + Dataset.median + Dataset.prod + Dataset.sum + Dataset.std + Dataset.var + Dataset.cumsum + Dataset.cumprod + +ndarray methods +--------------- + +.. autosummary:: + :toctree: generated/ + + Dataset.argsort + Dataset.astype + Dataset.clip + Dataset.conj + Dataset.conjugate + Dataset.imag + Dataset.round + Dataset.real + Dataset.rank + +Reshaping and reorganizing +-------------------------- + +.. autosummary:: + :toctree: generated/ + + Dataset.transpose + Dataset.stack + Dataset.unstack + Dataset.to_stacked_array + Dataset.shift + Dataset.roll + Dataset.pad + Dataset.sortby + Dataset.broadcast_like diff --git a/doc/api/datatree.rst b/doc/api/datatree.rst new file mode 100644 index 00000000000..ba57320ebad --- /dev/null +++ b/doc/api/datatree.rst @@ -0,0 +1,307 @@ +.. currentmodule:: xarray + +DataTree +======== + +Creating a DataTree +------------------- + +Methods of creating a ``DataTree``. + +.. autosummary:: + :toctree: generated/ + + DataTree + DataTree.from_dict + +Tree Attributes +--------------- + +Attributes relating to the recursive tree-like structure of a ``DataTree``. + +.. autosummary:: + :toctree: generated/ + + DataTree.parent + DataTree.children + DataTree.name + DataTree.path + DataTree.root + DataTree.is_root + DataTree.is_leaf + DataTree.leaves + DataTree.level + DataTree.depth + DataTree.width + DataTree.subtree + DataTree.subtree_with_keys + DataTree.descendants + DataTree.siblings + DataTree.lineage + DataTree.parents + DataTree.ancestors + DataTree.groups + DataTree.xindexes + +Data Contents +------------- + +Interface to the data objects (optionally) stored inside a single ``DataTree`` node. +This interface echoes that of ``xarray.Dataset``. + +.. autosummary:: + :toctree: generated/ + + DataTree.dims + DataTree.sizes + DataTree.data_vars + DataTree.ds + DataTree.coords + DataTree.attrs + DataTree.encoding + DataTree.indexes + DataTree.nbytes + DataTree.dataset + DataTree.to_dataset + DataTree.has_data + DataTree.has_attrs + DataTree.is_empty + DataTree.is_hollow + DataTree.chunksizes + +Dictionary Interface +-------------------- + +``DataTree`` objects also have a dict-like interface mapping keys to either ``xarray.DataArray``\s or to child ``DataTree`` nodes. + +.. autosummary:: + :toctree: generated/ + + DataTree.__getitem__ + DataTree.__setitem__ + DataTree.__delitem__ + DataTree.update + DataTree.get + DataTree.items + DataTree.keys + DataTree.values + +Tree Manipulation +----------------- + +For manipulating, traversing, navigating, or mapping over the tree structure. + +.. autosummary:: + :toctree: generated/ + + DataTree.orphan + DataTree.same_tree + DataTree.relative_to + DataTree.iter_lineage + DataTree.find_common_ancestor + DataTree.map_over_datasets + DataTree.pipe + DataTree.match + DataTree.filter + DataTree.filter_like + +Pathlib-like Interface +---------------------- + +``DataTree`` objects deliberately echo some of the API of :py:class:`pathlib.PurePath`. + +.. autosummary:: + :toctree: generated/ + + DataTree.name + DataTree.parent + DataTree.parents + DataTree.relative_to + +.. Missing: + +.. .. + +.. ``DataTree.glob`` +.. ``DataTree.joinpath`` +.. ``DataTree.with_name`` +.. ``DataTree.walk`` +.. ``DataTree.rename`` +.. ``DataTree.replace`` + +DataTree Contents +----------------- + +Manipulate the contents of all nodes in a ``DataTree`` simultaneously. + +.. autosummary:: + :toctree: generated/ + + DataTree.copy + + .. DataTree.assign_coords + .. DataTree.merge + .. DataTree.rename + .. DataTree.rename_vars + .. DataTree.rename_dims + .. DataTree.swap_dims + .. DataTree.expand_dims + .. DataTree.drop_vars + .. DataTree.drop_dims + .. DataTree.set_coords + .. DataTree.reset_coords + +DataTree Node Contents +---------------------- + +Manipulate the contents of a single ``DataTree`` node. + +.. autosummary:: + :toctree: generated/ + + DataTree.assign + DataTree.drop_nodes + +DataTree Operations +------------------- + +Apply operations over multiple ``DataTree`` objects. + +.. autosummary:: + :toctree: generated/ + + map_over_datasets + group_subtrees + +Comparisons +----------- + +Compare one ``DataTree`` object to another. + +.. autosummary:: + :toctree: generated/ + + DataTree.isomorphic + DataTree.equals + DataTree.identical + +Indexing +-------- + +Index into all nodes in the subtree simultaneously. + +.. autosummary:: + :toctree: generated/ + + DataTree.isel + DataTree.sel + +.. DataTree.drop_sel +.. DataTree.drop_isel +.. DataTree.head +.. DataTree.tail +.. DataTree.thin +.. DataTree.squeeze +.. DataTree.interp +.. DataTree.interp_like +.. DataTree.reindex +.. DataTree.reindex_like +.. DataTree.set_index +.. DataTree.reset_index +.. DataTree.reorder_levels +.. DataTree.query + +.. .. + +.. Missing: +.. ``DataTree.loc`` + + +.. Missing Value Handling +.. ---------------------- + +.. .. autosummary:: +.. :toctree: generated/ + +.. DataTree.isnull +.. DataTree.notnull +.. DataTree.combine_first +.. DataTree.dropna +.. DataTree.fillna +.. DataTree.ffill +.. DataTree.bfill +.. DataTree.interpolate_na +.. DataTree.where +.. DataTree.isin + +.. Computation +.. ----------- + +.. Apply a computation to the data in all nodes in the subtree simultaneously. + +.. .. autosummary:: +.. :toctree: generated/ + +.. DataTree.map +.. DataTree.reduce +.. DataTree.diff +.. DataTree.quantile +.. DataTree.differentiate +.. DataTree.integrate +.. DataTree.map_blocks +.. DataTree.polyfit +.. DataTree.curvefit + +Aggregation +----------- + +Aggregate data in all nodes in the subtree simultaneously. + +.. autosummary:: + :toctree: generated/ + + DataTree.all + DataTree.any + DataTree.max + DataTree.min + DataTree.mean + DataTree.median + DataTree.prod + DataTree.sum + DataTree.std + DataTree.var + DataTree.cumsum + DataTree.cumprod + +ndarray methods +--------------- + +Methods copied from :py:class:`numpy.ndarray` objects, here applying to the data in all nodes in the subtree. + +.. autosummary:: + :toctree: generated/ + + DataTree.argsort + DataTree.conj + DataTree.conjugate + DataTree.round +.. DataTree.astype +.. DataTree.clip +.. DataTree.rank + +.. Reshaping and reorganising +.. -------------------------- + +.. Reshape or reorganise the data in all nodes in the subtree. + +.. .. autosummary:: +.. :toctree: generated/ + +.. DataTree.transpose +.. DataTree.stack +.. DataTree.unstack +.. DataTree.shift +.. DataTree.roll +.. DataTree.pad +.. DataTree.sortby +.. DataTree.broadcast_like diff --git a/doc/api/deprecated.rst b/doc/api/deprecated.rst new file mode 100644 index 00000000000..9e3b1a8a153 --- /dev/null +++ b/doc/api/deprecated.rst @@ -0,0 +1,20 @@ +.. currentmodule:: xarray + +Deprecated / Pending Deprecation +================================ + +.. autosummary:: + :toctree: generated/ + + Dataset.drop + DataArray.drop + Dataset.apply + core.groupby.DataArrayGroupBy.apply + core.groupby.DatasetGroupBy.apply + +.. autosummary:: + :toctree: generated/ + :template: autosummary/accessor_attribute.rst + + DataArray.dt.weekofyear + DataArray.dt.week diff --git a/doc/api/encoding.rst b/doc/api/encoding.rst new file mode 100644 index 00000000000..2259da2177c --- /dev/null +++ b/doc/api/encoding.rst @@ -0,0 +1,17 @@ +.. currentmodule:: xarray + +Encoding/Decoding +================= + +.. autosummary:: + :toctree: generated/ + + decode_cf + +Coder objects +------------- + +.. autosummary:: + :toctree: generated/ + + coders.CFDatetimeCoder diff --git a/doc/api/exceptions.rst b/doc/api/exceptions.rst new file mode 100644 index 00000000000..19075c1b738 --- /dev/null +++ b/doc/api/exceptions.rst @@ -0,0 +1,24 @@ +.. currentmodule:: xarray + +Exceptions +========== + +.. autosummary:: + :toctree: generated/ + + AlignmentError + CoordinateValidationError + MergeError + SerializationWarning + +DataTree +-------- + +Exceptions raised when manipulating trees. + +.. autosummary:: + :toctree: generated/ + + TreeIsomorphismError + InvalidTreeError + NotFoundInTreeError diff --git a/doc/api/groupby.rst b/doc/api/groupby.rst new file mode 100644 index 00000000000..bb8709f9072 --- /dev/null +++ b/doc/api/groupby.rst @@ -0,0 +1,85 @@ +.. currentmodule:: xarray + +GroupBy objects +=============== + +.. currentmodule:: xarray.core.groupby + +Dataset +------- + +.. autosummary:: + :toctree: generated/ + + DatasetGroupBy + DatasetGroupBy.map + DatasetGroupBy.reduce + DatasetGroupBy.assign + DatasetGroupBy.assign_coords + DatasetGroupBy.first + DatasetGroupBy.last + DatasetGroupBy.fillna + DatasetGroupBy.quantile + DatasetGroupBy.where + DatasetGroupBy.all + DatasetGroupBy.any + DatasetGroupBy.count + DatasetGroupBy.cumsum + DatasetGroupBy.cumprod + DatasetGroupBy.max + DatasetGroupBy.mean + DatasetGroupBy.median + DatasetGroupBy.min + DatasetGroupBy.prod + DatasetGroupBy.std + DatasetGroupBy.sum + DatasetGroupBy.var + DatasetGroupBy.dims + DatasetGroupBy.groups + DatasetGroupBy.shuffle_to_chunks + +DataArray +--------- + +.. autosummary:: + :toctree: generated/ + + DataArrayGroupBy + DataArrayGroupBy.map + DataArrayGroupBy.reduce + DataArrayGroupBy.assign_coords + DataArrayGroupBy.first + DataArrayGroupBy.last + DataArrayGroupBy.fillna + DataArrayGroupBy.quantile + DataArrayGroupBy.where + DataArrayGroupBy.all + DataArrayGroupBy.any + DataArrayGroupBy.count + DataArrayGroupBy.cumsum + DataArrayGroupBy.cumprod + DataArrayGroupBy.max + DataArrayGroupBy.mean + DataArrayGroupBy.median + DataArrayGroupBy.min + DataArrayGroupBy.prod + DataArrayGroupBy.std + DataArrayGroupBy.sum + DataArrayGroupBy.var + DataArrayGroupBy.dims + DataArrayGroupBy.groups + DataArrayGroupBy.shuffle_to_chunks + +Grouper Objects +--------------- + +.. currentmodule:: xarray + +.. autosummary:: + :toctree: generated/ + + groupers.BinGrouper + groupers.UniqueGrouper + groupers.TimeResampler + groupers.SeasonGrouper + groupers.SeasonResampler diff --git a/doc/api/indexes.rst b/doc/api/indexes.rst new file mode 100644 index 00000000000..e7c23068d39 --- /dev/null +++ b/doc/api/indexes.rst @@ -0,0 +1,34 @@ +.. currentmodule:: xarray + +Indexes +======= + +Default, pandas-backed indexes built-in to Xarray: + +.. autosummary:: + :toctree: generated/ + + indexes.PandasIndex + indexes.PandasMultiIndex + + +More complex indexes built-in to Xarray: + +.. autosummary:: + :toctree: generated/ + + CFTimeIndex + indexes.RangeIndex + indexes.NDPointIndex + + +Creating indexes +---------------- +.. autosummary:: + :toctree: generated/ + + cftime_range + date_range + date_range_like + indexes.RangeIndex.arange + indexes.RangeIndex.linspace diff --git a/doc/api/io.rst b/doc/api/io.rst new file mode 100644 index 00000000000..8ff236d6cc7 --- /dev/null +++ b/doc/api/io.rst @@ -0,0 +1,86 @@ +.. currentmodule:: xarray + +IO / Conversion +=============== + +Dataset methods +--------------- + +.. autosummary:: + :toctree: generated/ + + load_dataset + open_dataset + open_mfdataset + open_zarr + save_mfdataset + Dataset.as_numpy + Dataset.from_dataframe + Dataset.from_dict + Dataset.to_dataarray + Dataset.to_dataframe + Dataset.to_dask_dataframe + Dataset.to_dict + Dataset.to_netcdf + Dataset.to_pandas + Dataset.to_zarr + Dataset.chunk + Dataset.close + Dataset.compute + Dataset.filter_by_attrs + Dataset.info + Dataset.load + Dataset.persist + Dataset.unify_chunks + +DataArray methods +----------------- + +.. autosummary:: + :toctree: generated/ + + load_dataarray + open_dataarray + DataArray.as_numpy + DataArray.from_dict + DataArray.from_iris + DataArray.from_series + DataArray.to_dask_dataframe + DataArray.to_dataframe + DataArray.to_dataset + DataArray.to_dict + DataArray.to_index + DataArray.to_iris + DataArray.to_masked_array + DataArray.to_netcdf + DataArray.to_numpy + DataArray.to_pandas + DataArray.to_series + DataArray.to_zarr + DataArray.chunk + DataArray.close + DataArray.compute + DataArray.persist + DataArray.load + DataArray.unify_chunks + +DataTree methods +---------------- + +.. autosummary:: + :toctree: generated/ + + open_datatree + open_groups + DataTree.to_dict + DataTree.to_netcdf + DataTree.to_zarr + DataTree.chunk + DataTree.load + DataTree.compute + DataTree.persist + +.. .. + +.. Missing: +.. ``open_mfdatatree`` diff --git a/doc/api/plotting.rst b/doc/api/plotting.rst new file mode 100644 index 00000000000..df686378558 --- /dev/null +++ b/doc/api/plotting.rst @@ -0,0 +1,59 @@ +.. currentmodule:: xarray + +Plotting +======== + +Dataset +------- + +.. autosummary:: + :toctree: generated/ + :template: autosummary/accessor_method.rst + + Dataset.plot.scatter + Dataset.plot.quiver + Dataset.plot.streamplot + +DataArray +--------- + +.. autosummary:: + :toctree: generated/ + :template: autosummary/accessor_callable.rst + + DataArray.plot + +.. autosummary:: + :toctree: generated/ + :template: autosummary/accessor_method.rst + + DataArray.plot.contourf + DataArray.plot.contour + DataArray.plot.hist + DataArray.plot.imshow + DataArray.plot.line + DataArray.plot.pcolormesh + DataArray.plot.step + DataArray.plot.scatter + DataArray.plot.surface + + +Faceting +-------- +.. autosummary:: + :toctree: generated/ + + plot.FacetGrid + plot.FacetGrid.add_colorbar + plot.FacetGrid.add_legend + plot.FacetGrid.add_quiverkey + plot.FacetGrid.map + plot.FacetGrid.map_dataarray + plot.FacetGrid.map_dataarray_line + plot.FacetGrid.map_dataset + plot.FacetGrid.map_plot1d + plot.FacetGrid.set_axis_labels + plot.FacetGrid.set_ticks + plot.FacetGrid.set_titles + plot.FacetGrid.set_xlabels + plot.FacetGrid.set_ylabels diff --git a/doc/api/resample.rst b/doc/api/resample.rst new file mode 100644 index 00000000000..92c632aef45 --- /dev/null +++ b/doc/api/resample.rst @@ -0,0 +1,82 @@ +.. currentmodule:: xarray + +Resample objects +================ + +.. currentmodule:: xarray.core.resample + +Dataset +------- + +.. autosummary:: + :toctree: generated/ + + DatasetResample + DatasetResample.asfreq + DatasetResample.backfill + DatasetResample.interpolate + DatasetResample.nearest + DatasetResample.pad + DatasetResample.all + DatasetResample.any + DatasetResample.apply + DatasetResample.assign + DatasetResample.assign_coords + DatasetResample.bfill + DatasetResample.count + DatasetResample.ffill + DatasetResample.fillna + DatasetResample.first + DatasetResample.last + DatasetResample.map + DatasetResample.max + DatasetResample.mean + DatasetResample.median + DatasetResample.min + DatasetResample.prod + DatasetResample.quantile + DatasetResample.reduce + DatasetResample.std + DatasetResample.sum + DatasetResample.var + DatasetResample.where + DatasetResample.dims + DatasetResample.groups + + +DataArray +--------- + +.. autosummary:: + :toctree: generated/ + + DataArrayResample + DataArrayResample.asfreq + DataArrayResample.backfill + DataArrayResample.interpolate + DataArrayResample.nearest + DataArrayResample.pad + DataArrayResample.all + DataArrayResample.any + DataArrayResample.apply + DataArrayResample.assign_coords + DataArrayResample.bfill + DataArrayResample.count + DataArrayResample.ffill + DataArrayResample.fillna + DataArrayResample.first + DataArrayResample.last + DataArrayResample.map + DataArrayResample.max + DataArrayResample.mean + DataArrayResample.median + DataArrayResample.min + DataArrayResample.prod + DataArrayResample.quantile + DataArrayResample.reduce + DataArrayResample.std + DataArrayResample.sum + DataArrayResample.var + DataArrayResample.where + DataArrayResample.dims + DataArrayResample.groups diff --git a/doc/api/rolling-exp.rst b/doc/api/rolling-exp.rst new file mode 100644 index 00000000000..fb98a827842 --- /dev/null +++ b/doc/api/rolling-exp.rst @@ -0,0 +1,13 @@ +.. currentmodule:: xarray + +Exponential rolling objects +=========================== + +.. currentmodule:: xarray.computation.rolling_exp + +.. autosummary:: + :toctree: generated/ + + RollingExp + RollingExp.mean + RollingExp.sum diff --git a/doc/api/rolling.rst b/doc/api/rolling.rst new file mode 100644 index 00000000000..349f209d74a --- /dev/null +++ b/doc/api/rolling.rst @@ -0,0 +1,49 @@ +.. currentmodule:: xarray + +Rolling objects +=============== + +.. currentmodule:: xarray.computation.rolling + +Dataset +------- + +.. autosummary:: + :toctree: generated/ + + DatasetRolling + DatasetRolling.construct + DatasetRolling.reduce + DatasetRolling.argmax + DatasetRolling.argmin + DatasetRolling.count + DatasetRolling.max + DatasetRolling.mean + DatasetRolling.median + DatasetRolling.min + DatasetRolling.prod + DatasetRolling.std + DatasetRolling.sum + DatasetRolling.var + +DataArray +--------- + +.. autosummary:: + :toctree: generated/ + + DataArrayRolling + DataArrayRolling.__iter__ + DataArrayRolling.construct + DataArrayRolling.reduce + DataArrayRolling.argmax + DataArrayRolling.argmin + DataArrayRolling.count + DataArrayRolling.max + DataArrayRolling.mean + DataArrayRolling.median + DataArrayRolling.min + DataArrayRolling.prod + DataArrayRolling.std + DataArrayRolling.sum + DataArrayRolling.var diff --git a/doc/api/testing.rst b/doc/api/testing.rst new file mode 100644 index 00000000000..cc2a17a0d53 --- /dev/null +++ b/doc/api/testing.rst @@ -0,0 +1,42 @@ +.. currentmodule:: xarray + +Testing +======= + +.. autosummary:: + :toctree: generated/ + + testing.assert_equal + testing.assert_identical + testing.assert_allclose + testing.assert_chunks_equal + +Test that two ``DataTree`` objects are similar. + +.. autosummary:: + :toctree: generated/ + + testing.assert_isomorphic + testing.assert_equal + testing.assert_identical + +Hypothesis Testing Strategies +============================= + +.. currentmodule:: xarray + +See the :ref:`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. + +.. autosummary:: + :toctree: generated/ + + testing.strategies.supported_dtypes + testing.strategies.names + testing.strategies.dimension_names + testing.strategies.dimension_sizes + testing.strategies.attrs + testing.strategies.variables + testing.strategies.unique_subset_of diff --git a/doc/api/top-level.rst b/doc/api/top-level.rst new file mode 100644 index 00000000000..9f7eec22257 --- /dev/null +++ b/doc/api/top-level.rst @@ -0,0 +1,30 @@ +.. currentmodule:: xarray + +Top-level functions +=================== + +.. autosummary:: + :toctree: generated/ + + apply_ufunc + align + broadcast + concat + merge + combine_by_coords + combine_nested + where + infer_freq + full_like + zeros_like + ones_like + cov + corr + cross + dot + polyval + map_blocks + show_versions + set_options + get_options + unify_chunks diff --git a/doc/api/tutorial.rst b/doc/api/tutorial.rst new file mode 100644 index 00000000000..35e24d9db31 --- /dev/null +++ b/doc/api/tutorial.rst @@ -0,0 +1,12 @@ +.. currentmodule:: xarray + +Tutorial +======== + +.. autosummary:: + :toctree: generated/ + + tutorial.open_dataset + tutorial.load_dataset + tutorial.open_datatree + tutorial.load_datatree diff --git a/doc/api/ufuncs.rst b/doc/api/ufuncs.rst new file mode 100644 index 00000000000..f4a8c0f247c --- /dev/null +++ b/doc/api/ufuncs.rst @@ -0,0 +1,115 @@ +.. currentmodule:: xarray + +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: + +.. autosummary:: + :toctree: generated/ + + ufuncs.abs + ufuncs.absolute + ufuncs.acos + ufuncs.acosh + ufuncs.arccos + ufuncs.arccosh + ufuncs.arcsin + ufuncs.arcsinh + ufuncs.arctan + ufuncs.arctanh + ufuncs.asin + ufuncs.asinh + ufuncs.atan + ufuncs.atanh + ufuncs.bitwise_count + ufuncs.bitwise_invert + ufuncs.bitwise_not + ufuncs.cbrt + ufuncs.ceil + ufuncs.conj + ufuncs.conjugate + ufuncs.cos + ufuncs.cosh + ufuncs.deg2rad + ufuncs.degrees + ufuncs.exp + ufuncs.exp2 + ufuncs.expm1 + ufuncs.fabs + ufuncs.floor + ufuncs.invert + ufuncs.isfinite + ufuncs.isinf + ufuncs.isnan + ufuncs.isnat + ufuncs.log + ufuncs.log10 + ufuncs.log1p + ufuncs.log2 + ufuncs.logical_not + ufuncs.negative + ufuncs.positive + ufuncs.rad2deg + ufuncs.radians + ufuncs.reciprocal + ufuncs.rint + ufuncs.sign + ufuncs.signbit + ufuncs.sin + ufuncs.sinh + ufuncs.spacing + ufuncs.sqrt + ufuncs.square + ufuncs.tan + ufuncs.tanh + ufuncs.trunc + ufuncs.add + ufuncs.arctan2 + ufuncs.atan2 + ufuncs.bitwise_and + ufuncs.bitwise_left_shift + ufuncs.bitwise_or + ufuncs.bitwise_right_shift + ufuncs.bitwise_xor + ufuncs.copysign + ufuncs.divide + ufuncs.equal + ufuncs.float_power + ufuncs.floor_divide + ufuncs.fmax + ufuncs.fmin + ufuncs.fmod + ufuncs.gcd + ufuncs.greater + ufuncs.greater_equal + ufuncs.heaviside + ufuncs.hypot + ufuncs.lcm + ufuncs.ldexp + ufuncs.left_shift + ufuncs.less + ufuncs.less_equal + ufuncs.logaddexp + ufuncs.logaddexp2 + ufuncs.logical_and + ufuncs.logical_or + ufuncs.logical_xor + ufuncs.maximum + ufuncs.minimum + ufuncs.mod + ufuncs.multiply + ufuncs.nextafter + ufuncs.not_equal + ufuncs.pow + ufuncs.power + ufuncs.remainder + ufuncs.right_shift + ufuncs.subtract + ufuncs.true_divide + ufuncs.angle + ufuncs.isreal + ufuncs.iscomplex diff --git a/doc/api/weighted.rst b/doc/api/weighted.rst new file mode 100644 index 00000000000..62ce6062820 --- /dev/null +++ b/doc/api/weighted.rst @@ -0,0 +1,36 @@ +.. currentmodule:: xarray + +Weighted objects +================ + +.. currentmodule:: xarray.computation.weighted + +Dataset +------- + +.. autosummary:: + :toctree: generated/ + + DatasetWeighted + DatasetWeighted.mean + DatasetWeighted.quantile + DatasetWeighted.sum + DatasetWeighted.std + DatasetWeighted.var + DatasetWeighted.sum_of_weights + DatasetWeighted.sum_of_squares + +DataArray +--------- + +.. autosummary:: + :toctree: generated/ + + DataArrayWeighted + DataArrayWeighted.mean + DataArrayWeighted.quantile + DataArrayWeighted.sum + DataArrayWeighted.std + DataArrayWeighted.var + DataArrayWeighted.sum_of_weights + DataArrayWeighted.sum_of_squares From 34db499ba6ba5aa595f582bb5d739076cb579e7e Mon Sep 17 00:00:00 2001 From: Deepak Cherian Date: Thu, 17 Jul 2025 08:17:01 -0600 Subject: [PATCH 2/4] docs: Fix toctree warnings by updating paths to ../generated MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Updated all :toctree: directives in API documentation files to point to ../generated/ instead of generated/, ensuring proper inclusion of autogenerated documentation files in the toctree structure. This fixes 940 "document isn't included in any toctree" warnings. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude --- doc/api/accessors.rst | 2 +- doc/api/advanced.rst | 6 +++--- doc/api/coarsen.rst | 4 ++-- doc/api/coordinates.rst | 12 ++++++------ doc/api/custom-indexes.rst | 4 ++-- doc/api/dataarray.rst | 34 +++++++++++++++++----------------- doc/api/dataset.rst | 22 +++++++++++----------- doc/api/datatree.rst | 32 ++++++++++++++++---------------- doc/api/deprecated.rst | 4 ++-- doc/api/encoding.rst | 4 ++-- doc/api/exceptions.rst | 4 ++-- doc/api/groupby.rst | 6 +++--- doc/api/indexes.rst | 6 +++--- doc/api/io.rst | 6 +++--- doc/api/plotting.rst | 8 ++++---- doc/api/resample.rst | 4 ++-- doc/api/rolling-exp.rst | 2 +- doc/api/rolling.rst | 4 ++-- doc/api/testing.rst | 6 +++--- doc/api/top-level.rst | 2 +- doc/api/tutorial.rst | 2 +- doc/api/ufuncs.rst | 2 +- doc/api/weighted.rst | 4 ++-- 23 files changed, 90 insertions(+), 90 deletions(-) diff --git a/doc/api/accessors.rst b/doc/api/accessors.rst index d9e7fb8d6dd..5b403bdefc9 100644 --- a/doc/api/accessors.rst +++ b/doc/api/accessors.rst @@ -6,7 +6,7 @@ Accessors .. currentmodule:: xarray.core .. autosummary:: - :toctree: generated/ + :toctree: ../generated/ accessor_dt.DatetimeAccessor accessor_dt.TimedeltaAccessor diff --git a/doc/api/advanced.rst b/doc/api/advanced.rst index 5585beb3e52..3c70561cfe8 100644 --- a/doc/api/advanced.rst +++ b/doc/api/advanced.rst @@ -4,7 +4,7 @@ Advanced API ============ .. autosummary:: - :toctree: generated/ + :toctree: ../generated/ Coordinates Dataset.variables @@ -35,7 +35,7 @@ external file-formats or protocols, and can be manually invoked to create arguments for the ``load_store`` and ``dump_to_store`` Dataset methods: .. autosummary:: - :toctree: generated/ + :toctree: ../generated/ backends.NetCDF4DataStore backends.H5NetCDFStore @@ -50,7 +50,7 @@ These BackendEntrypoints provide a basic interface to the most commonly used filetypes in the xarray universe. .. autosummary:: - :toctree: generated/ + :toctree: ../generated/ backends.NetCDF4BackendEntrypoint backends.H5netcdfBackendEntrypoint diff --git a/doc/api/coarsen.rst b/doc/api/coarsen.rst index d3edc722044..08377ae7b0e 100644 --- a/doc/api/coarsen.rst +++ b/doc/api/coarsen.rst @@ -9,7 +9,7 @@ Dataset ------- .. autosummary:: - :toctree: generated/ + :toctree: ../generated/ DatasetCoarsen DatasetCoarsen.all @@ -30,7 +30,7 @@ DataArray --------- .. autosummary:: - :toctree: generated/ + :toctree: ../generated/ DataArrayCoarsen DataArrayCoarsen.all diff --git a/doc/api/coordinates.rst b/doc/api/coordinates.rst index 513a87af895..b8a39db61a5 100644 --- a/doc/api/coordinates.rst +++ b/doc/api/coordinates.rst @@ -7,7 +7,7 @@ Creating coordinates -------------------- .. autosummary:: - :toctree: generated/ + :toctree: ../generated/ Coordinates Coordinates.from_xindex @@ -17,7 +17,7 @@ Attributes ---------- .. autosummary:: - :toctree: generated/ + :toctree: ../generated/ Coordinates.dims Coordinates.sizes @@ -33,7 +33,7 @@ Coordinates implement the mapping interface with keys given by variable names and values given by ``DataArray`` objects. .. autosummary:: - :toctree: generated/ + :toctree: ../generated/ Coordinates.__getitem__ Coordinates.__setitem__ @@ -48,7 +48,7 @@ Coordinates contents -------------------- .. autosummary:: - :toctree: generated/ + :toctree: ../generated/ Coordinates.to_dataset Coordinates.to_index @@ -60,7 +60,7 @@ Comparisons ----------- .. autosummary:: - :toctree: generated/ + :toctree: ../generated/ Coordinates.equals Coordinates.identical @@ -72,7 +72,7 @@ Coordinates that are accessed from the ``coords`` property of Dataset, DataArray and DataTree objects, respectively. .. autosummary:: - :toctree: generated/ + :toctree: ../generated/ core.coordinates.DatasetCoordinates core.coordinates.DataArrayCoordinates diff --git a/doc/api/custom-indexes.rst b/doc/api/custom-indexes.rst index 153f51d1ba6..490e7e07a2b 100644 --- a/doc/api/custom-indexes.rst +++ b/doc/api/custom-indexes.rst @@ -10,7 +10,7 @@ Building custom indexes These classes are building blocks for more complex Indexes: .. autosummary:: - :toctree: generated/ + :toctree: ../generated/ indexes.CoordinateTransform indexes.CoordinateTransformIndex @@ -20,7 +20,7 @@ These classes are building blocks for more complex Indexes: The Index base class for building custom indexes: .. autosummary:: - :toctree: generated/ + :toctree: ../generated/ Index.from_variables Index.concat diff --git a/doc/api/dataarray.rst b/doc/api/dataarray.rst index e21c9d85a0a..9d4e81c8677 100644 --- a/doc/api/dataarray.rst +++ b/doc/api/dataarray.rst @@ -4,7 +4,7 @@ DataArray ========= .. autosummary:: - :toctree: generated/ + :toctree: ../generated/ DataArray @@ -12,7 +12,7 @@ Attributes ---------- .. autosummary:: - :toctree: generated/ + :toctree: ../generated/ DataArray.values DataArray.data @@ -30,7 +30,7 @@ ndarray attributes ------------------ .. autosummary:: - :toctree: generated/ + :toctree: ../generated/ DataArray.ndim DataArray.nbytes @@ -44,7 +44,7 @@ DataArray contents ------------------ .. autosummary:: - :toctree: generated/ + :toctree: ../generated/ DataArray.assign_coords DataArray.assign_attrs @@ -69,7 +69,7 @@ Indexing -------- .. autosummary:: - :toctree: generated/ + :toctree: ../generated/ DataArray.__getitem__ DataArray.__setitem__ @@ -96,7 +96,7 @@ Missing value handling ---------------------- .. autosummary:: - :toctree: generated/ + :toctree: ../generated/ DataArray.isnull DataArray.notnull @@ -114,7 +114,7 @@ Comparisons ----------- .. autosummary:: - :toctree: generated/ + :toctree: ../generated/ DataArray.equals DataArray.identical @@ -124,7 +124,7 @@ Computation ----------- .. autosummary:: - :toctree: generated/ + :toctree: ../generated/ DataArray.reduce DataArray.groupby @@ -149,7 +149,7 @@ Aggregation ----------- .. autosummary:: - :toctree: generated/ + :toctree: ../generated/ DataArray.all DataArray.any @@ -173,7 +173,7 @@ ndarray methods --------------- .. autosummary:: - :toctree: generated/ + :toctree: ../generated/ DataArray.argsort DataArray.clip @@ -191,13 +191,13 @@ String manipulation ------------------- .. autosummary:: - :toctree: generated/ + :toctree: ../generated/ :template: autosummary/accessor.rst DataArray.str .. autosummary:: - :toctree: generated/ + :toctree: ../generated/ :template: autosummary/accessor_method.rst DataArray.str.capitalize @@ -261,7 +261,7 @@ Datetimelike properties **Datetime properties**: .. autosummary:: - :toctree: generated/ + :toctree: ../generated/ :template: autosummary/accessor_attribute.rst DataArray.dt.year @@ -293,7 +293,7 @@ Datetimelike properties **Datetime methods**: .. autosummary:: - :toctree: generated/ + :toctree: ../generated/ :template: autosummary/accessor_method.rst DataArray.dt.floor @@ -305,7 +305,7 @@ Datetimelike properties **Timedelta properties**: .. autosummary:: - :toctree: generated/ + :toctree: ../generated/ :template: autosummary/accessor_attribute.rst DataArray.dt.days @@ -317,7 +317,7 @@ Datetimelike properties **Timedelta methods**: .. autosummary:: - :toctree: generated/ + :toctree: ../generated/ :template: autosummary/accessor_method.rst DataArray.dt.floor @@ -329,7 +329,7 @@ Reshaping and reorganizing -------------------------- .. autosummary:: - :toctree: generated/ + :toctree: ../generated/ DataArray.transpose DataArray.stack diff --git a/doc/api/dataset.rst b/doc/api/dataset.rst index e11ef368aad..739415b6103 100644 --- a/doc/api/dataset.rst +++ b/doc/api/dataset.rst @@ -7,7 +7,7 @@ Creating a dataset ------------------ .. autosummary:: - :toctree: generated/ + :toctree: ../generated/ Dataset decode_cf @@ -16,7 +16,7 @@ Attributes ---------- .. autosummary:: - :toctree: generated/ + :toctree: ../generated/ Dataset.dims Dataset.sizes @@ -38,7 +38,7 @@ Datasets implement the mapping interface with keys given by variable names and values given by ``DataArray`` objects. .. autosummary:: - :toctree: generated/ + :toctree: ../generated/ Dataset.__getitem__ Dataset.__setitem__ @@ -53,7 +53,7 @@ Dataset contents ---------------- .. autosummary:: - :toctree: generated/ + :toctree: ../generated/ Dataset.copy Dataset.assign @@ -82,7 +82,7 @@ Comparisons ----------- .. autosummary:: - :toctree: generated/ + :toctree: ../generated/ Dataset.equals Dataset.identical @@ -92,7 +92,7 @@ Indexing -------- .. autosummary:: - :toctree: generated/ + :toctree: ../generated/ Dataset.loc Dataset.isel @@ -117,7 +117,7 @@ Missing value handling ---------------------- .. autosummary:: - :toctree: generated/ + :toctree: ../generated/ Dataset.isnull Dataset.notnull @@ -135,7 +135,7 @@ Computation ----------- .. autosummary:: - :toctree: generated/ + :toctree: ../generated/ Dataset.map Dataset.reduce @@ -160,7 +160,7 @@ Aggregation ----------- .. autosummary:: - :toctree: generated/ + :toctree: ../generated/ Dataset.all Dataset.any @@ -184,7 +184,7 @@ ndarray methods --------------- .. autosummary:: - :toctree: generated/ + :toctree: ../generated/ Dataset.argsort Dataset.astype @@ -200,7 +200,7 @@ Reshaping and reorganizing -------------------------- .. autosummary:: - :toctree: generated/ + :toctree: ../generated/ Dataset.transpose Dataset.stack diff --git a/doc/api/datatree.rst b/doc/api/datatree.rst index ba57320ebad..8501440b7d7 100644 --- a/doc/api/datatree.rst +++ b/doc/api/datatree.rst @@ -9,7 +9,7 @@ Creating a DataTree Methods of creating a ``DataTree``. .. autosummary:: - :toctree: generated/ + :toctree: ../generated/ DataTree DataTree.from_dict @@ -20,7 +20,7 @@ Tree Attributes Attributes relating to the recursive tree-like structure of a ``DataTree``. .. autosummary:: - :toctree: generated/ + :toctree: ../generated/ DataTree.parent DataTree.children @@ -50,7 +50,7 @@ Interface to the data objects (optionally) stored inside a single ``DataTree`` n This interface echoes that of ``xarray.Dataset``. .. autosummary:: - :toctree: generated/ + :toctree: ../generated/ DataTree.dims DataTree.sizes @@ -75,7 +75,7 @@ Dictionary Interface ``DataTree`` objects also have a dict-like interface mapping keys to either ``xarray.DataArray``\s or to child ``DataTree`` nodes. .. autosummary:: - :toctree: generated/ + :toctree: ../generated/ DataTree.__getitem__ DataTree.__setitem__ @@ -92,7 +92,7 @@ Tree Manipulation For manipulating, traversing, navigating, or mapping over the tree structure. .. autosummary:: - :toctree: generated/ + :toctree: ../generated/ DataTree.orphan DataTree.same_tree @@ -111,7 +111,7 @@ Pathlib-like Interface ``DataTree`` objects deliberately echo some of the API of :py:class:`pathlib.PurePath`. .. autosummary:: - :toctree: generated/ + :toctree: ../generated/ DataTree.name DataTree.parent @@ -135,7 +135,7 @@ DataTree Contents Manipulate the contents of all nodes in a ``DataTree`` simultaneously. .. autosummary:: - :toctree: generated/ + :toctree: ../generated/ DataTree.copy @@ -157,7 +157,7 @@ DataTree Node Contents Manipulate the contents of a single ``DataTree`` node. .. autosummary:: - :toctree: generated/ + :toctree: ../generated/ DataTree.assign DataTree.drop_nodes @@ -168,7 +168,7 @@ DataTree Operations Apply operations over multiple ``DataTree`` objects. .. autosummary:: - :toctree: generated/ + :toctree: ../generated/ map_over_datasets group_subtrees @@ -179,7 +179,7 @@ Comparisons Compare one ``DataTree`` object to another. .. autosummary:: - :toctree: generated/ + :toctree: ../generated/ DataTree.isomorphic DataTree.equals @@ -191,7 +191,7 @@ Indexing Index into all nodes in the subtree simultaneously. .. autosummary:: - :toctree: generated/ + :toctree: ../generated/ DataTree.isel DataTree.sel @@ -221,7 +221,7 @@ Index into all nodes in the subtree simultaneously. .. ---------------------- .. .. autosummary:: -.. :toctree: generated/ +.. :toctree: ../generated/ .. DataTree.isnull .. DataTree.notnull @@ -240,7 +240,7 @@ Index into all nodes in the subtree simultaneously. .. Apply a computation to the data in all nodes in the subtree simultaneously. .. .. autosummary:: -.. :toctree: generated/ +.. :toctree: ../generated/ .. DataTree.map .. DataTree.reduce @@ -258,7 +258,7 @@ Aggregation Aggregate data in all nodes in the subtree simultaneously. .. autosummary:: - :toctree: generated/ + :toctree: ../generated/ DataTree.all DataTree.any @@ -279,7 +279,7 @@ ndarray methods Methods copied from :py:class:`numpy.ndarray` objects, here applying to the data in all nodes in the subtree. .. autosummary:: - :toctree: generated/ + :toctree: ../generated/ DataTree.argsort DataTree.conj @@ -295,7 +295,7 @@ Methods copied from :py:class:`numpy.ndarray` objects, here applying to the data .. Reshape or reorganise the data in all nodes in the subtree. .. .. autosummary:: -.. :toctree: generated/ +.. :toctree: ../generated/ .. DataTree.transpose .. DataTree.stack diff --git a/doc/api/deprecated.rst b/doc/api/deprecated.rst index 9e3b1a8a153..e926b2b84f8 100644 --- a/doc/api/deprecated.rst +++ b/doc/api/deprecated.rst @@ -4,7 +4,7 @@ Deprecated / Pending Deprecation ================================ .. autosummary:: - :toctree: generated/ + :toctree: ../generated/ Dataset.drop DataArray.drop @@ -13,7 +13,7 @@ Deprecated / Pending Deprecation core.groupby.DatasetGroupBy.apply .. autosummary:: - :toctree: generated/ + :toctree: ../generated/ :template: autosummary/accessor_attribute.rst DataArray.dt.weekofyear diff --git a/doc/api/encoding.rst b/doc/api/encoding.rst index 2259da2177c..c1fe18dc5ce 100644 --- a/doc/api/encoding.rst +++ b/doc/api/encoding.rst @@ -4,7 +4,7 @@ Encoding/Decoding ================= .. autosummary:: - :toctree: generated/ + :toctree: ../generated/ decode_cf @@ -12,6 +12,6 @@ Coder objects ------------- .. autosummary:: - :toctree: generated/ + :toctree: ../generated/ coders.CFDatetimeCoder diff --git a/doc/api/exceptions.rst b/doc/api/exceptions.rst index 19075c1b738..d7248f5bd74 100644 --- a/doc/api/exceptions.rst +++ b/doc/api/exceptions.rst @@ -4,7 +4,7 @@ Exceptions ========== .. autosummary:: - :toctree: generated/ + :toctree: ../generated/ AlignmentError CoordinateValidationError @@ -17,7 +17,7 @@ DataTree Exceptions raised when manipulating trees. .. autosummary:: - :toctree: generated/ + :toctree: ../generated/ TreeIsomorphismError InvalidTreeError diff --git a/doc/api/groupby.rst b/doc/api/groupby.rst index bb8709f9072..194d7f9dc72 100644 --- a/doc/api/groupby.rst +++ b/doc/api/groupby.rst @@ -9,7 +9,7 @@ Dataset ------- .. autosummary:: - :toctree: generated/ + :toctree: ../generated/ DatasetGroupBy DatasetGroupBy.map @@ -42,7 +42,7 @@ DataArray --------- .. autosummary:: - :toctree: generated/ + :toctree: ../generated/ DataArrayGroupBy DataArrayGroupBy.map @@ -76,7 +76,7 @@ Grouper Objects .. currentmodule:: xarray .. autosummary:: - :toctree: generated/ + :toctree: ../generated/ groupers.BinGrouper groupers.UniqueGrouper diff --git a/doc/api/indexes.rst b/doc/api/indexes.rst index e7c23068d39..d1be7931f82 100644 --- a/doc/api/indexes.rst +++ b/doc/api/indexes.rst @@ -6,7 +6,7 @@ Indexes Default, pandas-backed indexes built-in to Xarray: .. autosummary:: - :toctree: generated/ + :toctree: ../generated/ indexes.PandasIndex indexes.PandasMultiIndex @@ -15,7 +15,7 @@ Default, pandas-backed indexes built-in to Xarray: More complex indexes built-in to Xarray: .. autosummary:: - :toctree: generated/ + :toctree: ../generated/ CFTimeIndex indexes.RangeIndex @@ -25,7 +25,7 @@ More complex indexes built-in to Xarray: Creating indexes ---------------- .. autosummary:: - :toctree: generated/ + :toctree: ../generated/ cftime_range date_range diff --git a/doc/api/io.rst b/doc/api/io.rst index 8ff236d6cc7..fffc7785800 100644 --- a/doc/api/io.rst +++ b/doc/api/io.rst @@ -7,7 +7,7 @@ Dataset methods --------------- .. autosummary:: - :toctree: generated/ + :toctree: ../generated/ load_dataset open_dataset @@ -37,7 +37,7 @@ DataArray methods ----------------- .. autosummary:: - :toctree: generated/ + :toctree: ../generated/ load_dataarray open_dataarray @@ -68,7 +68,7 @@ DataTree methods ---------------- .. autosummary:: - :toctree: generated/ + :toctree: ../generated/ open_datatree open_groups diff --git a/doc/api/plotting.rst b/doc/api/plotting.rst index df686378558..e2f6068351a 100644 --- a/doc/api/plotting.rst +++ b/doc/api/plotting.rst @@ -7,7 +7,7 @@ Dataset ------- .. autosummary:: - :toctree: generated/ + :toctree: ../generated/ :template: autosummary/accessor_method.rst Dataset.plot.scatter @@ -18,13 +18,13 @@ DataArray --------- .. autosummary:: - :toctree: generated/ + :toctree: ../generated/ :template: autosummary/accessor_callable.rst DataArray.plot .. autosummary:: - :toctree: generated/ + :toctree: ../generated/ :template: autosummary/accessor_method.rst DataArray.plot.contourf @@ -41,7 +41,7 @@ DataArray Faceting -------- .. autosummary:: - :toctree: generated/ + :toctree: ../generated/ plot.FacetGrid plot.FacetGrid.add_colorbar diff --git a/doc/api/resample.rst b/doc/api/resample.rst index 92c632aef45..ed6317b807f 100644 --- a/doc/api/resample.rst +++ b/doc/api/resample.rst @@ -9,7 +9,7 @@ Dataset ------- .. autosummary:: - :toctree: generated/ + :toctree: ../generated/ DatasetResample DatasetResample.asfreq @@ -48,7 +48,7 @@ DataArray --------- .. autosummary:: - :toctree: generated/ + :toctree: ../generated/ DataArrayResample DataArrayResample.asfreq diff --git a/doc/api/rolling-exp.rst b/doc/api/rolling-exp.rst index fb98a827842..59306b2523e 100644 --- a/doc/api/rolling-exp.rst +++ b/doc/api/rolling-exp.rst @@ -6,7 +6,7 @@ Exponential rolling objects .. currentmodule:: xarray.computation.rolling_exp .. autosummary:: - :toctree: generated/ + :toctree: ../generated/ RollingExp RollingExp.mean diff --git a/doc/api/rolling.rst b/doc/api/rolling.rst index 349f209d74a..45dc55f5d5e 100644 --- a/doc/api/rolling.rst +++ b/doc/api/rolling.rst @@ -9,7 +9,7 @@ Dataset ------- .. autosummary:: - :toctree: generated/ + :toctree: ../generated/ DatasetRolling DatasetRolling.construct @@ -30,7 +30,7 @@ DataArray --------- .. autosummary:: - :toctree: generated/ + :toctree: ../generated/ DataArrayRolling DataArrayRolling.__iter__ diff --git a/doc/api/testing.rst b/doc/api/testing.rst index cc2a17a0d53..5fc677c21cf 100644 --- a/doc/api/testing.rst +++ b/doc/api/testing.rst @@ -4,7 +4,7 @@ Testing ======= .. autosummary:: - :toctree: generated/ + :toctree: ../generated/ testing.assert_equal testing.assert_identical @@ -14,7 +14,7 @@ Testing Test that two ``DataTree`` objects are similar. .. autosummary:: - :toctree: generated/ + :toctree: ../generated/ testing.assert_isomorphic testing.assert_equal @@ -31,7 +31,7 @@ See the :ref:`documentation page on testing ` for a guide on These strategies should be considered highly experimental, and liable to change at any time. .. autosummary:: - :toctree: generated/ + :toctree: ../generated/ testing.strategies.supported_dtypes testing.strategies.names diff --git a/doc/api/top-level.rst b/doc/api/top-level.rst index 9f7eec22257..1c79aedd2e7 100644 --- a/doc/api/top-level.rst +++ b/doc/api/top-level.rst @@ -4,7 +4,7 @@ Top-level functions =================== .. autosummary:: - :toctree: generated/ + :toctree: ../generated/ apply_ufunc align diff --git a/doc/api/tutorial.rst b/doc/api/tutorial.rst index 35e24d9db31..9f535684669 100644 --- a/doc/api/tutorial.rst +++ b/doc/api/tutorial.rst @@ -4,7 +4,7 @@ Tutorial ======== .. autosummary:: - :toctree: generated/ + :toctree: ../generated/ tutorial.open_dataset tutorial.load_dataset diff --git a/doc/api/ufuncs.rst b/doc/api/ufuncs.rst index f4a8c0f247c..e5dbb7eadbf 100644 --- a/doc/api/ufuncs.rst +++ b/doc/api/ufuncs.rst @@ -9,7 +9,7 @@ they will ensure that the computation is dispatched to the appropriate backend. You can find them in the ``xarray.ufuncs`` module: .. autosummary:: - :toctree: generated/ + :toctree: ../generated/ ufuncs.abs ufuncs.absolute diff --git a/doc/api/weighted.rst b/doc/api/weighted.rst index 62ce6062820..507e0f5de18 100644 --- a/doc/api/weighted.rst +++ b/doc/api/weighted.rst @@ -9,7 +9,7 @@ Dataset ------- .. autosummary:: - :toctree: generated/ + :toctree: ../generated/ DatasetWeighted DatasetWeighted.mean @@ -24,7 +24,7 @@ DataArray --------- .. autosummary:: - :toctree: generated/ + :toctree: ../generated/ DataArrayWeighted DataArrayWeighted.mean From 2704477cfc7dcbd0644ed5317535ce6f28607e0f Mon Sep 17 00:00:00 2001 From: Deepak Cherian Date: Thu, 17 Jul 2025 13:38:03 -0600 Subject: [PATCH 3/4] Review comments --- doc/api.rst | 2 +- doc/api/advanced.rst | 38 ++--------------------- doc/api/backends.rst | 41 +++++++++++++++++++++++++ doc/api/coordinates.rst | 8 +++-- doc/api/custom-indexes.rst | 39 ----------------------- doc/api/dataset.rst | 4 --- doc/api/indexes.rst | 63 +++++++++++++++++++++++++++++++++----- doc/api/top-level.rst | 45 +++++++++++++++++++++------ 8 files changed, 141 insertions(+), 99 deletions(-) create mode 100644 doc/api/backends.rst delete mode 100644 doc/api/custom-indexes.rst diff --git a/doc/api.rst b/doc/api.rst index 1b161ebe034..fc862c21e4c 100644 --- a/doc/api.rst +++ b/doc/api.rst @@ -32,9 +32,9 @@ See also: :ref:`public-api` and :ref:`api-stability`. api/weighted api/resample api/accessors - api/custom-indexes api/tutorial api/testing + api/backends api/exceptions api/advanced api/deprecated diff --git a/doc/api/advanced.rst b/doc/api/advanced.rst index 3c70561cfe8..9a4bfef3d7f 100644 --- a/doc/api/advanced.rst +++ b/doc/api/advanced.rst @@ -3,58 +3,24 @@ Advanced API ============ +The methods and properties here are advanced API and not recommended for use unless you know what you are doing. + .. autosummary:: :toctree: ../generated/ - Coordinates Dataset.variables DataArray.variable DataTree.variables Variable IndexVariable as_variable - Index - IndexSelResult Context register_dataset_accessor register_dataarray_accessor register_datatree_accessor Dataset.set_close - backends.BackendArray - backends.BackendEntrypoint - backends.list_engines - backends.refresh_engines .. .. .. Missing: .. ``DataTree.set_close`` - -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: - -.. autosummary:: - :toctree: ../generated/ - - backends.NetCDF4DataStore - backends.H5NetCDFStore - backends.PydapDataStore - backends.ScipyDataStore - backends.ZarrStore - backends.FileManager - backends.CachingFileManager - backends.DummyFileManager - -These BackendEntrypoints provide a basic interface to the most commonly -used filetypes in the xarray universe. - -.. autosummary:: - :toctree: ../generated/ - - backends.NetCDF4BackendEntrypoint - backends.H5netcdfBackendEntrypoint - backends.PydapBackendEntrypoint - backends.ScipyBackendEntrypoint - backends.StoreBackendEntrypoint - backends.ZarrBackendEntrypoint diff --git a/doc/api/backends.rst b/doc/api/backends.rst new file mode 100644 index 00000000000..a5673abff7b --- /dev/null +++ b/doc/api/backends.rst @@ -0,0 +1,41 @@ +.. currentmodule:: xarray + +Backends +======== + +.. autosummary:: + :toctree: ../generated/ + + backends.BackendArray + backends.BackendEntrypoint + backends.list_engines + backends.refresh_engines + +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: + +.. autosummary:: + :toctree: ../generated/ + + backends.NetCDF4DataStore + backends.H5NetCDFStore + backends.PydapDataStore + backends.ScipyDataStore + backends.ZarrStore + backends.FileManager + backends.CachingFileManager + backends.DummyFileManager + +These BackendEntrypoints provide a basic interface to the most commonly +used filetypes in the xarray universe. + +.. autosummary:: + :toctree: ../generated/ + + backends.NetCDF4BackendEntrypoint + backends.H5netcdfBackendEntrypoint + backends.PydapBackendEntrypoint + backends.ScipyBackendEntrypoint + backends.StoreBackendEntrypoint + backends.ZarrBackendEntrypoint diff --git a/doc/api/coordinates.rst b/doc/api/coordinates.rst index b8a39db61a5..08a2b9e891d 100644 --- a/doc/api/coordinates.rst +++ b/doc/api/coordinates.rst @@ -68,12 +68,14 @@ Comparisons Proxies ------- +.. currentmodule:: xarray.core.coordinates + Coordinates that are accessed from the ``coords`` property of Dataset, DataArray and DataTree objects, respectively. .. autosummary:: :toctree: ../generated/ - core.coordinates.DatasetCoordinates - core.coordinates.DataArrayCoordinates - core.coordinates.DataTreeCoordinates + DatasetCoordinates + DataArrayCoordinates + DataTreeCoordinates diff --git a/doc/api/custom-indexes.rst b/doc/api/custom-indexes.rst deleted file mode 100644 index 490e7e07a2b..00000000000 --- a/doc/api/custom-indexes.rst +++ /dev/null @@ -1,39 +0,0 @@ -.. currentmodule:: xarray - -Custom Indexes -============== -.. currentmodule:: xarray - -Building custom indexes ------------------------ - -These classes are building blocks for more complex Indexes: - -.. autosummary:: - :toctree: ../generated/ - - indexes.CoordinateTransform - indexes.CoordinateTransformIndex - indexes.NDPointIndex - indexes.TreeAdapter - -The Index base class for building custom indexes: - -.. autosummary:: - :toctree: ../generated/ - - Index.from_variables - Index.concat - Index.stack - Index.unstack - Index.create_variables - Index.should_add_coord_to_array - Index.to_pandas_index - Index.isel - Index.sel - Index.join - Index.reindex_like - Index.equals - Index.roll - Index.rename - Index.copy diff --git a/doc/api/dataset.rst b/doc/api/dataset.rst index 739415b6103..733c9768d2f 100644 --- a/doc/api/dataset.rst +++ b/doc/api/dataset.rst @@ -3,14 +3,10 @@ Dataset ======= -Creating a dataset ------------------- - .. autosummary:: :toctree: ../generated/ Dataset - decode_cf Attributes ---------- diff --git a/doc/api/indexes.rst b/doc/api/indexes.rst index d1be7931f82..a1aef374e08 100644 --- a/doc/api/indexes.rst +++ b/doc/api/indexes.rst @@ -3,6 +3,22 @@ Indexes ======= + +Creating indexes +---------------- +.. autosummary:: + :toctree: ../generated/ + + cftime_range + date_range + date_range_like + indexes.RangeIndex.arange + indexes.RangeIndex.linspace + + +Built-in Indexes +---------------- + Default, pandas-backed indexes built-in to Xarray: .. autosummary:: @@ -20,15 +36,48 @@ More complex indexes built-in to Xarray: CFTimeIndex indexes.RangeIndex indexes.NDPointIndex + indexes.CoordinateTransformIndex -Creating indexes ----------------- +Building custom indexes +----------------------- + +These classes are building blocks for more complex Indexes: + .. autosummary:: :toctree: ../generated/ - cftime_range - date_range - date_range_like - indexes.RangeIndex.arange - indexes.RangeIndex.linspace + indexes.CoordinateTransform + indexes.CoordinateTransformIndex + indexes.NDPointIndex + indexes.TreeAdapter + +The Index base class for building custom indexes: + +.. autosummary:: + :toctree: ../generated/ + + Index + Index.from_variables + Index.concat + Index.stack + Index.unstack + Index.create_variables + Index.should_add_coord_to_array + Index.to_pandas_index + Index.isel + Index.sel + Index.join + Index.reindex_like + Index.equals + Index.roll + Index.rename + Index.copy + + +The following are useful when building custom Indexes + +.. autosummary:: + :toctree: ../generated/ + + IndexSelResult diff --git a/doc/api/top-level.rst b/doc/api/top-level.rst index 1c79aedd2e7..5306a636764 100644 --- a/doc/api/top-level.rst +++ b/doc/api/top-level.rst @@ -3,28 +3,55 @@ Top-level functions =================== +Computation +----------- + .. autosummary:: :toctree: ../generated/ apply_ufunc + cov + corr + cross + dot + map_blocks + polyval + unify_chunks + where + +Combining Data +-------------- + +.. autosummary:: + :toctree: ../generated/ + align broadcast concat merge combine_by_coords combine_nested - where - infer_freq + +Creation +-------- +.. autosummary:: + :toctree: ../generated/ + + DataArray + Dataset + DataTree full_like zeros_like ones_like - cov - corr - cross - dot - polyval - map_blocks + +Miscellaneous +------------- + +.. autosummary:: + :toctree: ../generated/ + + decode_cf + infer_freq show_versions set_options get_options - unify_chunks From 413c347865974232a162b758dc871dfca97d61a8 Mon Sep 17 00:00:00 2001 From: Deepak Cherian Date: Thu, 17 Jul 2025 13:52:51 -0600 Subject: [PATCH 4/4] more tweaks --- doc/api/indexes.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/doc/api/indexes.rst b/doc/api/indexes.rst index a1aef374e08..0d64131d6a2 100644 --- a/doc/api/indexes.rst +++ b/doc/api/indexes.rst @@ -4,6 +4,10 @@ Indexes ======= +.. seealso:: + See the Xarray gallery on `custom indexes `_ for more examples. + + Creating indexes ---------------- .. autosummary::