Installation

UXarray is built on top of Xarray, so we strongly recommend becoming familiar with Xarray’s installation process and dependencies first.

Installing with Conda (recommended)

UXarray itself is a pure Python package, but its dependencies are not. The easiest way to get everything installed is to use conda. To install UXarray with its recommended dependencies using the conda command line tool:

conda install -c conda-forge uxarray

Note

Conda automatically installs Xarray and every other required dependency (including non‑Python libraries).

Installing with pip

pip install uxarray

This installs the minimal required dependencies. UXarray also provides optional extras:

pip install "uxarray[dev]"       # development tools
pip install "uxarray[complete]"  # all optional features

A complete list of extras lives in the [project.optional-dependencies] section of our pyproject.toml

Installing from source

Installing from source is intended mainly for developers.

1. Clone the repo

   git clone https://github.com/UXARRAY/uxarray.git
   cd uxarray
   

2. Create a dev environment

   A ready-made file is provided at ci/environment.yml:

   conda env create -f ci/environment.yml
   conda activate uxarray_build
   

3. Install UXarray

   pip install .
   

4. Run the test suite

   pytest test
   

Verifying your installation

After installing UXarray, you can verify the installation by running the following in a Python shell or script:

import uxarray as ux

print(ux.__version__)

This should print the installed version of UXarray without errors.