Data classes for custom xarray creation
Project description
xarray-custom
:zap: Data classes for custom xarray creation
TL;DR
xarray-custom is a third-party Python package which helps to create custom DataArray classes in the same manner as the Python's native dataclass. Here is an introduction code of what the package provides:
from xarray_custom import coord, dataarrayclass
@dataarrayclass
class Image:
"""DataArray class to represent images."""
dims = 'x', 'y'
dtype = float
accessor = 'img'
x: coord('x', int) = 0
y: coord('y', int) = 0
def normalize(self):
return self / self.max()
The key features are:
# create a custom DataArray
image = Image([[0, 1], [2, 3]], x=[0, 1], y=[0, 1])
# use a custom method via an accessor
normalized = image.img.normalize()
# create a custom DataArray filled with ones
ones = Image.ones((2, 2), x=[0, 1], y=[0, 1])
- Custom DataArray instances with fixed dimensions, datatype, and coordinates can easily be created.
- NumPy-like special functions like
ones()
are provided as class methods. - Custom DataArray methods can be available via a custom accessor.
Requirements
- Python: 3.6, 3.7, or 3.8 (tested by the author)
- Dependencies: See pyproject.toml
Installation
$ pip install xarray-custom
License
Copyright (c) 2020 Akio Taniguchi
- xarray-custom is distributed under the MIT License
- xarray-custom uses an icon of xarray distributed under the Apache 2.0 license
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
xarray-custom-0.6.2.tar.gz
(10.7 kB
view hashes)
Built Distribution
Close
Hashes for xarray_custom-0.6.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e78ddf961a8780d6bc8747be03682fe98c30ee64bc80a0c835997b0d0456cf10 |
|
MD5 | 1f9c17e490a5820f631f81e0efcb0e03 |
|
BLAKE2b-256 | fa9a3ce731deee2ce6afbb43985bcee14ac3b459d59d2e2cd0e2df175c608867 |