Skip to content

Commit

Permalink
update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
b8raoult committed Apr 1, 2024
1 parent 3118e07 commit 429e159
Showing 1 changed file with 47 additions and 2 deletions.
49 changes: 47 additions & 2 deletions docs/using/methods.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,60 @@ returned by ``open_dataset``:
Methods
*********

__len__
__len__()
The number of rows (dates) in the dataset.

__getitem__
__getitem__(key)
Access the dataset's data values.

provenance()
Return the dataset's provenance information.

source(index):
Return the source of the dataset's data.

tree():
Return the dataset's tree.

************
Attributes
************

shape:
A tuple of the dataset's dimensions.

dtype:
The dataset's data type.

field_shape:
The dataset's field shape.

dates:
The dataset's dates.

latitudes:
The dataset's latitudes.

longitudes:
The dataset's longitudes.

statistics:
The dataset's statistics.

resolution:
The dataset's resolution.

frequency:
The dataset's frequency.

name_to_index:
A dictionary mapping variable names to their indices.

variables:
A list of the dataset's variable names.

missing:
The index of the missing dates.

grids:
The dataset's grids.

0 comments on commit 429e159

Please sign in to comment.