Installation

This installation guide includes only the UXarray installation instructions. Please refer to UXarray Contributor’s Guide for detailed information about how to contribute to the UXarray project.

Installing UXarray via Conda

The easiest way to install UXarray along with its dependencies is via Conda:

conda install -c conda-forge uxarray

Note that the Conda package manager automatically installs all required dependencies of UXarray, meaning it is not necessary to explicitly install Xarray or other required packages when installing UXarray.

If you are interested in learning more about how Conda environments work, please visit the managing environments page of the Conda documentation.

Installing UXarray via PyPI

An alternative to Conda is using pip:

pip install uxarray

Installing UXarray from source (Github)

Installing UXarray from source code is a fairly straightforward task, but doing so should not be necessary for most users. If you are interested in installing UXarray from source, you will first need to get the latest version of the code:

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

Required dependencies for installing and testing UXarray

The following packages should be installed (in your active conda environment):

- Python 3.9+
- `pytest <https://docs.pytest.org/en/stable/>`_  (For tests only)
- `xarray <http://xarray.pydata.org/en/stable/>`_

If you don’t have these packages installed, the next section describes how to setup a conda environment with them.

Creating a Conda environment

The UXarray source code includes a conda environment definition file (environment.yml) in the /ci folder under the root directory that can be used to create a development environment containing all of the packages required to build UXarray. The following commands should work on Windows, Linux, and macOS to create and activate a new conda environment from that file:

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

Installing from source

Once the dependencies listed above are installed, you can install UXarray with running the following command from the root-directory:

pip install .

For compatibility purposes, we strongly recommend using Conda to configure your build environment as described above.

Testing UXarray source

A UXarray code base can be tested from the root directory of the source code repository using the following command (Explicit installation of the pytest package may be required, please see above):

pytest test