Skip to content

Commit 7c6c049

Browse files
authored
Conda install instructions
1 parent eca5ad4 commit 7c6c049

File tree

1 file changed

+12
-4
lines changed

1 file changed

+12
-4
lines changed

README.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,17 @@ Interface for using [cubed](https://github.com/tomwhite/cubed) with [xarray](htt
1111

1212
## Installation
1313

14-
Install via pip.
14+
Install via pip
15+
16+
`pip install cubed-xarray`
17+
18+
or conda
19+
20+
`conda install -c conda-forge cubed-xarray`
1521

1622
## Importing
1723

18-
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.
24+
You don't need to import this package in user code. Once poperly installed, xarray should automatically become aware of this package via the magic of entrypoints.
1925

2026
## Usage
2127

@@ -26,9 +32,9 @@ Xarray objects backed by cubed arrays can be created either by:
2632
3. Passing a `chunks` argument to `xarray.open_dataset`.
2733

2834
In (2) and (3) the choice to use `cubed.Array` instead of `dask.array.Array` is made by passing the keyword argument `chunked_array_type='cubed'`.
29-
To pass arguments to the constructor of `cubed.Array` then pass them via the dictionary `from_array_kwargs`, e.g. `from_array_kwargs={'spec': cubed.Spec(max_mem=2_000_000)}`.
35+
To pass arguments to the constructor of `cubed.Array` you should pass them via the dictionary `from_array_kwargs`, e.g. `from_array_kwargs={'spec': cubed.Spec(allowed_mem='2GB')}`.
3036

31-
If cubed and cubed-xarray are installed but dask is not, then specifying the parallel array type to use is not necessary,
37+
If cubed and cubed-xarray are installed but dask is not, then specifying `chunked_array_type` is not necessary,
3238
as the entrypoints system will then default to the only chunked parallel backend available (i.e. cubed).
3339

3440
## Sharp Edges 🔪
@@ -42,6 +48,8 @@ and some other things _might_ work but have not yet been tried:
4248
- Groupby
4349
- Saving to formats other than zarr
4450

51+
In general a bug could take the form of an error, or of a silent attempt to coerce the array type to numpy by immediately computing the underlying array.
52+
4553
## Tests
4654

4755
Integration tests for wrapping cubed with xarray also live in this repository.

0 commit comments

Comments
 (0)