Skip to main content

Installation

In order to use Arraylake, you have to install the Python client library.

Install the Client Package

info

The Arraylake Client supports Python versions 3.10 - 3.12.

To install the minimal version of the client, run

pip install arraylake

in your Python environment of choice.

There are several optional extras you can install.

  • The virtual extra includes the ability to create virtual datasets
  • The xarray extra includes a compatible version of Xarray and its dependencies
  • The widgets extra includes integrations with Ipywidgets (e.g. repo.tree())

Most users will probably want both, which can be installed via

pip install "arraylake[xarray,virtual]"

The client can also be installed via Conda:

conda install --channel conda-forge arraylake

Dependencies

The table below outlines Arraylake's core and optional dependencies.

PackageVersionsNotes
python>=3.10,<3.13
aiobotocore[boto3]^2.4.0
botocore^1.31
zarr>=2.14,<=2.18
numcodecs!=0.12.0
numpy^1.23
donfig>=0.7,<1.0
pydantic[email]^2.3
httpx>=0.23.0,<1.0
ruamel-yaml>=0.17,<1.0
typer>=0.6.1,<1.0
rich>=12.6,<14.0
cachetools^5.3.2
python-dateutil^2.8
click^8.1
aioitertools^0.11.0
structlog^24.1.0
fsspec>=2023.01.0
gcsfs>=2023.01.0
uvloop>=0.17,<1.0Optional, POSIX only
ipytree>=0.2.2,<1.0Optional, required for Tree widget
xarray>=v2022.12.0Optional, required for Xarray integration
s3fs>=2023.01.0Optional, required for virtual datasets
kerchunk>=0.1,<1.0,!=0.2.1Optional, required for virtual datasets (NetCDF, HDF5, TIFF, and GRIB)
h5py^3.7.0Optional, required for virtual datasets (NetCDF4, HDF5)
tifffile>=2023.2.27Optional, required for virtual datasets (TIFF)
cfgrib^0.9Optional, required for virtual datasets (GRIB)
eccodes^1.6Optional, required for virtual datasets (GRIB)
ecmwflibs>=0.5,<=0.5.1Optional, required for virtual datasets (GRIB)