Skip to content

Update README.md examples to use xarray_dataclass #16

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 30, 2025
Merged

Update README.md examples to use xarray_dataclass #16

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ xarray-dataclass is a Python package that makes it easy to create [xarray]'s Dat
```python
from dataclasses import dataclass
from typing import Literal
from xarray_dataclasses import AsDataArray, Coord, Data
from xarray_dataclass import AsDataArray, Coord, Data


X = Literal["x"]
Expand Down Expand Up @@ -66,8 +66,8 @@ Note that the following code is supposed in the examples below.
```python
from dataclasses import dataclass
from typing import Literal
from xarray_dataclasses import AsDataArray, AsDataset
from xarray_dataclasses import Attr, Coord, Data, Name
from xarray_dataclass import AsDataArray, AsDataset
from xarray_dataclass import Attr, Coord, Data, Name


X = Literal["x"]
Expand Down Expand Up @@ -203,13 +203,13 @@ Attributes:

### Coordof and Dataof type hints

xarray-dataclasses provides advanced type hints, `Coordof` and `Dataof`.
xarray-dataclass provides advanced type hints, `Coordof` and `Dataof`.
Unlike `Data` and `Coord`, they specify a dataclass that defines a DataArray class.
This is useful when users want to add metadata to dimensions for [plotting].
For example:

```python
from xarray_dataclasses import Coordof
from xarray_dataclass import Coordof


@dataclass
Expand Down Expand Up @@ -294,7 +294,7 @@ A custom factory for DataArray or Dataset creation is only supported in the curr

```python
import xarray as xr
from xarray_dataclasses import DataOptions
from xarray_dataclass import DataOptions


class Custom(xr.DataArray):
Expand Down Expand Up @@ -330,7 +330,7 @@ This is useful when users do not want to inherit the mix-in class (`AsDataArray`
For example:

```python
from xarray_dataclasses import asdataarray
from xarray_dataclass import asdataarray


@dataclass
Expand Down