| Name | xarray-einstats JSON |
| Version |
0.8.0
JSON |
| download |
| home_page | None |
| Summary | Stats, linear algebra and einops for xarray |
| upload_time | 2024-09-19 00:07:39 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | None |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# xarray-einstats
[](https://xarray-einstats.readthedocs.io/en/latest/?badge=latest)
[](https://github.com/arviz-devs/xarray-einstats/actions/workflows/test.yml)
[](https://codecov.io/gh/arviz-devs/xarray-einstats)
[](https://pypi.org/project/xarray-einstats)
[](https://anaconda.org/conda-forge/xarray-einstats)
[](https://doi.org/10.5281/zenodo.5895451)
Stats, linear algebra and einops for xarray
## Installation
To install, run
```
(.venv) $ pip install xarray-einstats
```
See the docs for more [extensive install instructions](https://einstats.python.arviz.org/en/latest/installation.html).
## Overview
As stated in their website:
> xarray makes working with multi-dimensional labeled arrays simple, efficient and fun!
The code is often more verbose, but it is generally because it is clearer and thus less error prone
and more intuitive.
Here are some examples of such trade-off where we believe the increased clarity is worth
the extra characters:
| numpy | xarray |
|---------|----------|
| `a[2, 5]` | `da.sel(drug="paracetamol", subject=5)` |
| `a.mean(axis=(0, 1))` | `da.mean(dim=("chain", "draw"))` |
| `a.reshape((-1, 10))` | `da.stack(sample=("chain", "draw"))` |
| `a.transpose(2, 0, 1)` | `da.transpose("drug", "chain", "draw")` |
In some other cases however, using xarray can result in overly verbose code
that often also becomes less clear. `xarray_einstats` provides wrappers
around some numpy and scipy functions (mostly `numpy.linalg` and `scipy.stats`)
and around [einops](https://einops.rocks/) with an api and features adapted to xarray.
Continue at the [getting started page](https://einstats.python.arviz.org/en/latest/getting_started.html).
## Contributing
xarray-einstats is in active development and all types of contributions are welcome!
See the [contributing guide](https://einstats.python.arviz.org/en/latest/contributing/overview.html) for details on how to contribute.
## Relevant links
* Documentation: https://einstats.python.arviz.org/en/latest/
* Contributing guide: https://einstats.python.arviz.org/en/latest/contributing/overview.html
* ArviZ project website: https://www.arviz.org
## Similar projects
Here we list some similar projects we know of. Note that all of
them are complementary and don't overlap:
* [xr-scipy](https://xr-scipy.readthedocs.io/en/latest/index.html)
* [xarray-extras](https://xarray-extras.readthedocs.io/en/latest/)
* [xhistogram](https://xhistogram.readthedocs.io/en/latest/)
* [xrft](https://xrft.readthedocs.io/en/latest/)
## Cite xarray-einstats
If you use this software, please cite it using the following template and the version
specific DOI provided by Zenodo. Click on the badge to go to the Zenodo page
and select the DOI corresponding to the version you used
[](https://doi.org/10.5281/zenodo.5895451)
* Oriol Abril-Pla. (2022). arviz-devs/xarray-einstats `<version>`. Zenodo. `<version_doi>`
or in bibtex format:
```none
@software{xarray_einstats2022,
author = {Abril-Pla, Oriol},
title = {{xarray-einstats}},
year = 2022,
url = {https://github.com/arviz-devs/xarray-einstats}
publisher = {Zenodo},
version = {<version>},
doi = {<version_doi>},
}
```
Raw data
{
"_id": null,
"home_page": null,
"name": "xarray-einstats",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "ArviZ team <arviz.devs@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/ed/5d/654cca0448ad5c1d0333530511bc20eefaab304a4362dcbdc7ea3da12a3d/xarray_einstats-0.8.0.tar.gz",
"platform": null,
"description": "# xarray-einstats\n\n[](https://xarray-einstats.readthedocs.io/en/latest/?badge=latest)\n[](https://github.com/arviz-devs/xarray-einstats/actions/workflows/test.yml)\n[](https://codecov.io/gh/arviz-devs/xarray-einstats)\n[](https://pypi.org/project/xarray-einstats)\n[](https://anaconda.org/conda-forge/xarray-einstats)\n[](https://doi.org/10.5281/zenodo.5895451)\n\n\nStats, linear algebra and einops for xarray\n\n## Installation\n\nTo install, run\n\n```\n(.venv) $ pip install xarray-einstats\n```\n\nSee the docs for more [extensive install instructions](https://einstats.python.arviz.org/en/latest/installation.html).\n\n## Overview\nAs stated in their website:\n\n> xarray makes working with multi-dimensional labeled arrays simple, efficient and fun!\n\nThe code is often more verbose, but it is generally because it is clearer and thus less error prone\nand more intuitive.\nHere are some examples of such trade-off where we believe the increased clarity is worth\nthe extra characters:\n\n\n| numpy | xarray |\n|---------|----------|\n| `a[2, 5]` | `da.sel(drug=\"paracetamol\", subject=5)` |\n| `a.mean(axis=(0, 1))` | `da.mean(dim=(\"chain\", \"draw\"))` |\n| `a.reshape((-1, 10))` | `da.stack(sample=(\"chain\", \"draw\"))` |\n| `a.transpose(2, 0, 1)` | `da.transpose(\"drug\", \"chain\", \"draw\")` |\n\nIn some other cases however, using xarray can result in overly verbose code\nthat often also becomes less clear. `xarray_einstats` provides wrappers\naround some numpy and scipy functions (mostly `numpy.linalg` and `scipy.stats`)\nand around [einops](https://einops.rocks/) with an api and features adapted to xarray.\nContinue at the [getting started page](https://einstats.python.arviz.org/en/latest/getting_started.html).\n\n## Contributing\nxarray-einstats is in active development and all types of contributions are welcome!\nSee the [contributing guide](https://einstats.python.arviz.org/en/latest/contributing/overview.html) for details on how to contribute.\n\n## Relevant links\n* Documentation: https://einstats.python.arviz.org/en/latest/\n* Contributing guide: https://einstats.python.arviz.org/en/latest/contributing/overview.html\n* ArviZ project website: https://www.arviz.org\n\n## Similar projects\nHere we list some similar projects we know of. Note that all of\nthem are complementary and don't overlap:\n* [xr-scipy](https://xr-scipy.readthedocs.io/en/latest/index.html)\n* [xarray-extras](https://xarray-extras.readthedocs.io/en/latest/)\n* [xhistogram](https://xhistogram.readthedocs.io/en/latest/)\n* [xrft](https://xrft.readthedocs.io/en/latest/)\n\n## Cite xarray-einstats\nIf you use this software, please cite it using the following template and the version\nspecific DOI provided by Zenodo. Click on the badge to go to the Zenodo page\nand select the DOI corresponding to the version you used\n[](https://doi.org/10.5281/zenodo.5895451)\n\n* Oriol Abril-Pla. (2022). arviz-devs/xarray-einstats `<version>`. Zenodo. `<version_doi>`\n\nor in bibtex format:\n\n```none\n@software{xarray_einstats2022,\n author = {Abril-Pla, Oriol},\n title = {{xarray-einstats}},\n year = 2022,\n url = {https://github.com/arviz-devs/xarray-einstats}\n publisher = {Zenodo},\n version = {<version>},\n doi = {<version_doi>},\n}\n```\n\n",
"bugtrack_url": null,
"license": null,
"summary": "Stats, linear algebra and einops for xarray",
"version": "0.8.0",
"project_urls": {
"documentation": "https://xarray-einstats.readthedocs.io",
"funding": "https://opencollective.com/arviz",
"source": "https://github.com/arviz-devs/xarray-einstats",
"tracker": "https://github.com/arviz-devs/xarray-einstats/issues"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f80727f0d68989bb1c44a781747e222dda67cf65002834ed35ad91abd1a71802",
"md5": "9828848e07f833ef894bd5ea94a9f5a5",
"sha256": "fd00552c3fb5c859b1ebc7c88a97342d3bb93d14bba904c5a9b94a4f724b76b4"
},
"downloads": -1,
"filename": "xarray_einstats-0.8.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9828848e07f833ef894bd5ea94a9f5a5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 32553,
"upload_time": "2024-09-19T00:07:37",
"upload_time_iso_8601": "2024-09-19T00:07:37.904103Z",
"url": "https://files.pythonhosted.org/packages/f8/07/27f0d68989bb1c44a781747e222dda67cf65002834ed35ad91abd1a71802/xarray_einstats-0.8.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ed5d654cca0448ad5c1d0333530511bc20eefaab304a4362dcbdc7ea3da12a3d",
"md5": "21f67758fb509cb5e77925bcddc5a957",
"sha256": "7f1573f9bd4d60d6e7ed9fd27c4db39da51ec49bf8ba654d4602a139a6309d7f"
},
"downloads": -1,
"filename": "xarray_einstats-0.8.0.tar.gz",
"has_sig": false,
"md5_digest": "21f67758fb509cb5e77925bcddc5a957",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 30225,
"upload_time": "2024-09-19T00:07:39",
"upload_time_iso_8601": "2024-09-19T00:07:39.399306Z",
"url": "https://files.pythonhosted.org/packages/ed/5d/654cca0448ad5c1d0333530511bc20eefaab304a4362dcbdc7ea3da12a3d/xarray_einstats-0.8.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-19 00:07:39",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "arviz-devs",
"github_project": "xarray-einstats",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "xarray-einstats"
}
