Skip to content

README.md

Latest commit

 

History

History
29 lines (17 loc) · 1.47 KB

README.md

File metadata and controls

29 lines (17 loc) · 1.47 KB

arkouda-xarray

Interface for using arkouda's Array API module with xarray.

(modeled after: https://github.com/cubed-dev/cubed-xarray)

Dependencies

Installation

Clone this repository, cd into arkouda_xarray and run:

pip install .

With this library installed, XArray's entry point system should automatically recognize that the Arkouda ChunkManager is available. Importing arkouda_xarray in your code is not necessary.

Usage

Xarray objects backed by Arkouda's Array-API compliant arrays can be created in 3 ways:

  • passing the array(s) to the DataArray or DataSet constructors (this method doesn't rely on the chunk manager provided by this package)
  • calling chunk on an existing XArray object, passing chunked_array_type='arkouda'
  • calling open_dataset with chunked_array_type='arkouda'