Install xoak¶

Required dependencies¶

Python 3.6 or later.
xarray
dask
scipy

Optional dependencies¶

Xoak provides built-in adapters for some indexes implemented in the 3rd-party libraries listed below. Those dependencies are optional: adapters won’t be added in Xoak’s index registry if they are not installed.

Install using conda¶

Xoak can be installed or updated using conda (or mamba):

$ conda install xoak -c conda-forge

This installs Xoak and all its required dependencies. The optional dependencies listed above could be installed separately using conda too:

$ conda install scikit-learn pys2index -c conda-forge

The xoak conda package is maintained on the conda-forge channel.

Install using pip¶

You can also install Xoak and its required dependencies using pip:

$ python -m pip install xoak

Install from source¶

See Section Contributor Guide for instructions on how to setup a development environment for Xoak.

Import xoak¶

To make sure that Xoak is correctly installed, try to import it by running this line:

$ python -c "import xoak"