You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -14,9 +9,13 @@ for more visibility and community maintenance.
14
9
15
10
xarray data creation by data classes
16
11
12
+
This repository is adapted from [here](https://github.com/astropenguin/xarray-dataclasses). We are grateful for the
13
+
work of the developer on this repo. Sadly, that repository is inactive. Thus, a fork was moved here in order to allow
14
+
for more visibility and community maintenance.
15
+
17
16
## Overview
18
17
19
-
xarray-dataclasses is a Python package that makes it easy to create [xarray]'s DataArray and Dataset objects that are "typed" (i.e. fixed dimensions, data type, coordinates, attributes, and name) using [the Python's dataclass]:
18
+
xarray-dataclass is a Python package that makes it easy to create [xarray]'s DataArray and Dataset objects that are "typed" (i.e. fixed dimensions, data type, coordinates, attributes, and name) using [the Python's dataclass]:
20
19
21
20
```python
22
21
from dataclasses import dataclass
@@ -52,7 +51,7 @@ class Image(AsDataArray):
52
51
53
52
### Installation
54
53
55
-
There are multiple ways you can install xarray-dataclasses, dependent on what kind of dependency manager you use.
54
+
There are multiple ways you can install xarray-dataclass, dependent on what kind of dependency manager you use.
56
55
57
56
```shell
58
57
pip install xarray-dataclass
@@ -327,7 +326,7 @@ image.custom_method() # True
327
326
328
327
### DataArray and Dataset creation without shorthands
329
328
330
-
xarray-dataclasses provides functions, `asdataarray` and `asdataset`.
329
+
xarray-dataclass provides functions, `asdataarray` and `asdataset`.
331
330
This is useful when users do not want to inherit the mix-in class (`AsDataArray` or `AsDataset`) in a DataArray or Dataset dataclass.
Thank you for being willing to contribute! If you have some ideas to propose, please open an [issue](https://github.com/xarray-contrib/xarray-dataclasses/issues).
351
+
Thank you for being willing to contribute! If you have some ideas to propose, please open an [issue](https://github.com/xarray-contrib/xarray-dataclass/issues).
353
352
We use [GitHub flow](https://docs.github.com/en/get-started/using-github/github-flow) for developing and managing the project.
354
353
The first section describes how to contribute with it.
355
354
The second and third sections explain how to prepare a local development environment and our automated workflows in GitHub Actions, respectively.
@@ -358,8 +357,8 @@ The second and third sections explain how to prepare a local development environ
0 commit comments