Skip to content

minor changes to readme #15

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 2 commits into from
Jul 30, 2025
Merged

minor changes to readme #15

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dac6da5
minor changes to readme
melonora Jul 30, 2025
045f032
change install instructions for now
melonora Jul 30, 2025
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
30 changes: 12 additions & 18 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,20 +1,16 @@
# Important Note
This repository was a fork from [here](https://github.com/astropenguin/xarray-dataclasses). We are grateful for the
work of the developer on this repo. That being said, sadly the state on main has been the case that the code was
deleted and there has been no development for a while. Therefore, we intially decided to fork the repository and
continue development here, where the community is better able to contribute to and maintain the project. We now changed
it into a standalone repository.

Note, the repository is not yet released. We are making some additional changes before release.
This repository is adapted from [here](https://github.com/astropenguin/xarray-dataclasses). We are grateful for the
work of the developer on this repo. Sadly, that repository is inactive. Thus, a fork was moved here in order to allow
for more visibility and community maintenance.

# xarray-dataclasses

[![Release](https://img.shields.io/pypi/v/xarray-dataclasses?label=Release&color=cornflowerblue&style=flat-square)](https://pypi.org/project/xarray-dataclasses/)
[![Python](https://img.shields.io/pypi/pyversions/xarray-dataclasses?label=Python&color=cornflowerblue&style=flat-square)](https://pypi.org/project/xarray-dataclasses/)
[![Downloads](https://img.shields.io/pypi/dm/xarray-dataclasses?label=Downloads&color=cornflowerblue&style=flat-square)](https://pepy.tech/project/xarray-dataclasses)
[![Release](https://img.shields.io/pypi/v/xarray-dataclass?label=Release&color=cornflowerblue&style=flat-square)](https://pypi.org/project/xarray-dataclass/)
[![Python](https://img.shields.io/pypi/pyversions/xarray-dataclass?label=Python&color=cornflowerblue&style=flat-square)](https://pypi.org/project/xarray-dataclass/)
[![Downloads](https://img.shields.io/pypi/dm/xarray-dataclass?label=Downloads&color=cornflowerblue&style=flat-square)](https://pepy.tech/project/xarray-dataclass)
[![DOI](https://img.shields.io/badge/DOI-10.5281/zenodo.4624819-cornflowerblue?style=flat-square)](https://doi.org/10.5281/zenodo.4624819)
[![Tests](https://img.shields.io/github/actions/workflow/status/astropenguin/xarray-dataclasses/tests.yml?label=Tests&style=flat-square)](https://github.com/astropenguin/xarray-dataclasses/actions/workflows/tests.yaml)
[![Release](https://github.com/melonora/xarray-dataclasses/actions/workflows/pypi.yaml/badge.svg?event=release)](https://github.com/melonora/xarray-dataclasses/actions/workflows/pypi.yaml)
[![Tests](https://img.shields.io/github/actions/workflow/status/xarray-contrib/xarray-dataclass/tests.yml?label=Tests&style=flat-square)](https://github.com/xarray-contrib/xarray-dataclass/actions/workflows/tests.yaml)
[![Release](https://img.shields.io/pypi/v/xarray-dataclass?label=Release&color=cornflowerblue&style=flat-square)](https://pypi.org/project/xarray-dataclass/)

xarray data creation by data classes

Expand Down Expand Up @@ -59,10 +55,8 @@ class Image(AsDataArray):
There are multiple ways you can install xarray-dataclasses, dependent on what kind of dependency manager you use.

```shell
pip install xarray-dataclasses
conda install -c conda-forge xarray-dataclasses
pixi add xarray-dataclasses
pixi add --pypi xarray-dataclasses
pip install xarray-dataclass
pixi add --pypi xarray-dataclass
```

## Basic usage
Expand Down Expand Up @@ -374,7 +368,7 @@ First install [pixi](https://pixi.sh/latest/installation/). Then, install projec

```shell
pixi install -a
pixi run pre-commit-install
pixi run -e dev pre-commit-install
```

### Testing, linting, and formatting
Expand All @@ -386,7 +380,7 @@ in that case.

```
pixi run tests
pixi run -e dev pre-commit run --all-files
pixi run precommit # This runs pre-commit on all files.
```

### Creating documentation
Expand Down
2 changes: 1 addition & 1 deletion pixi.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,7 @@ dev = { features = ["dev"], solve-group = "default" }
tests = "pytest"
doc_build = { cmd = "sphinx-apidoc -efT -o docs/_apidoc src/xarray_dataclasses && sphinx-build -a docs docs/_build" }
doc_serve = { cmd = "sphinx-build -a docs docs/_build && python -m http.server --directory docs/_build 8000" }
precommit = { cmd = "pre-commit run --all-files"}

[tool.pyright]
reportMissingImports = "none"
Expand Down