Skip to content

Commit 5afddf1

Browse files
authored
Update README.md
1 parent bc9886e commit 5afddf1

File tree

1 file changed

+34
-1
lines changed

1 file changed

+34
-1
lines changed

README.md

Lines changed: 34 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,35 @@
1+
Note: this is a proof-of-concept, and many things are incomplete, untested, or don't work.
2+
13
# cubed-xarray
2-
Interface for using cubed with xarray
4+
5+
Interface for using [cubed](https://github.com/tomwhite/cubed) with [xarray](https://github.com/pydata/xarray).
6+
7+
## Requirements
8+
9+
Cubed version >v0.6.0
10+
11+
[Xarray pull request #7019](https://github.com/pydata/xarray/pull/7019)
12+
13+
## Installation
14+
15+
Install via pip.
16+
17+
## Importing
18+
19+
You don't need to import this package in user code. Once `pip install`-ed, xarray should automatically become aware of this package via the magic of entrypoints.
20+
21+
## Usage
22+
23+
Xarray objects backed by cubed arrays can be created either by:
24+
25+
1. Passing existing `cubed.Array` objects to the `data` argument of xarray constructors,
26+
2. Calling `.chunk` on xarray objects,
27+
3. Passing a `chunks` argument to `xarray.open_dataset`.
28+
29+
In (2) and (3) the choice to use `cubed.Array` instead of `dask.array.Array` is made by passing the keyword argument `manager='cubed'`.
30+
31+
If cubed and cubed-xarray are installed but dask is not, then specifying the parallel array type to use is not necessary.
32+
33+
## Tests
34+
35+
Integration tests for wrapping cubed with xarray also live in this repository.

0 commit comments

Comments
 (0)