Installation

Dependencies

The following packages are dependencies of xeofs:

Core Dependencies (Required)

• Python (3.10 or higher)

• numpy

• pandas

• xarray

• dask

• scikit-learn

• typing-extensions

• tqdm

For Specialized Models (Optional)

• numba

• statsmodels

For I/O (Optional)

• h5netcdf

• netCDF4

• zarr

Instructions

The xeofs package can be installed using either the conda package manager

conda install -c conda-forge xeofs

or the Python package installer pip

pip install xeofs

Several optional dependencies are required for certain functionality and are not installed by default:

• zarr, h5netcdf, or netcdf4 are necessary for saving and loading models to disk

• statsmodels is required for all models that inherit from CPCCA including CCA, MCA and RDA

• numba is required for the GWPCA model

These extras can be automatically included when installing with pip:

pip install xeofs[complete]
# or using individual groups
pip install xeofs[io,etc]