Skip to content

Commit d2c4ab5

Browse files
committed
change to xarray-dataclass
1 parent 1944f22 commit d2c4ab5

File tree

1 file changed

+11
-12
lines changed

1 file changed

+11
-12
lines changed

README.md

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,4 @@
1-
2-
This repository is adapted from [here](https://github.com/astropenguin/xarray-dataclasses). We are grateful for the
3-
work of the developer on this repo. Sadly, that repository is inactive. Thus, a fork was moved here in order to allow
4-
for more visibility and community maintenance.
5-
6-
# xarray-dataclasses
1+
# xarray-dataclass
72

83
[![Release](https://img.shields.io/pypi/v/xarray-dataclass?label=Release&color=cornflowerblue&style=flat-square)](https://pypi.org/project/xarray-dataclass/)
94
[![Python](https://img.shields.io/pypi/pyversions/xarray-dataclass?label=Python&color=cornflowerblue&style=flat-square)](https://pypi.org/project/xarray-dataclass/)
@@ -14,9 +9,13 @@ for more visibility and community maintenance.
149

1510
xarray data creation by data classes
1611

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+
1716
## Overview
1817

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]:
2019

2120
```python
2221
from dataclasses import dataclass
@@ -52,7 +51,7 @@ class Image(AsDataArray):
5251

5352
### Installation
5453

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.
5655

5756
```shell
5857
pip install xarray-dataclass
@@ -327,7 +326,7 @@ image.custom_method() # True
327326

328327
### DataArray and Dataset creation without shorthands
329328

330-
xarray-dataclasses provides functions, `asdataarray` and `asdataset`.
329+
xarray-dataclass provides functions, `asdataarray` and `asdataset`.
331330
This is useful when users do not want to inherit the mix-in class (`AsDataArray` or `AsDataset`) in a DataArray or Dataset dataclass.
332331
For example:
333332

@@ -349,7 +348,7 @@ image = asdataarray(Image([[0, 1], [2, 3]], [0, 1], [0, 1]))
349348

350349
## How to contribute
351350

352-
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).
353352
We use [GitHub flow](https://docs.github.com/en/get-started/using-github/github-flow) for developing and managing the project.
354353
The first section describes how to contribute with it.
355354
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
358357
### Get the source code
359358

360359
```shell
361-
git clone https://github.com/xarray-contrib/xarray-dataclasses
362-
cd xarray-dataclasses
360+
git clone https://github.com/xarray-contrib/xarray-dataclass
361+
cd xarray-dataclass
363362
```
364363

365364
### Install dependencies

0 commit comments

Comments
 (0)