Installation

Official Sources

Because of some packages being absent from PyPI (such as xESMF), we strongly recommend installing xscen in an Anaconda Python environment.

xscen can be installed directly from conda-forge:

$ conda install -c conda-forge xscen

Note

If you are unable to install the package due to missing dependencies, ensure that conda-forge is listed as a source in your conda configuration: $ conda config –add channels conda-forge!

If for some reason you wish to install the PyPI version of xscen into an existing Anaconda environment (not recommended), this can be performed with:

$ python -m pip install xscen

Development Installation (Anaconda + pip)

For development purposes, we provide the means for generating a conda environment with the latest dependencies in an environment.yml file at the top-level of the Github repo.

In order to get started, first clone the repo locally:

$ git clone git@github.com:Ouranosinc/xscen.git

Then you can create the environment and install the package:

$ cd xscen
$ conda env create -f environment.yml

Finally, perform an –editable install of xscen and compile the translation catalogs:

$ python -m pip install -e .
$ make translate