Installation

Requirements

Nereus requires Python 3.10 or later and depends on the following packages:

NumPy (>=1.22)
SciPy (>=1.9)
xarray (>=2022.6)
netCDF4 (>=1.6)
Matplotlib (>=3.5)
Cartopy (>=0.21)
Dask (>=2022.6) - for parallel and out-of-core computation

The simplest way to install Nereus is using pip:

pip install nereus

You can also install Nereus using conda or mamba from conda-forge:

conda install -c conda-forge nereus

# or with mamba (faster)
mamba install -c conda-forge nereus

For the latest development version, you can install directly from GitHub:

pip install git+https://github.com/koldunovn/nereus.git

Or clone the repository and install in editable mode:

git clone https://github.com/koldunovn/nereus.git
cd nereus
pip install -e ".[dev]"

This installs Nereus in editable mode along with development dependencies (pytest, ruff, mypy).

Nereus has several optional dependency groups:

Dask support (included by default):

pip install nereus[dask]

Development tools:

pip install nereus[dev]

All optional dependencies:

pip install nereus[all]

To verify that Nereus is installed correctly, run:

import nereus as nr
print(nr.__version__)

You should see the version number printed (e.g., 0.4.0).

Cartopy requires GEOS and PROJ libraries. If you encounter installation issues with Cartopy, we recommend installing it via conda:

conda install -c conda-forge cartopy

Then install Nereus with pip:

pip install nereus --no-deps
pip install numpy scipy xarray netCDF4 matplotlib dask

For reproducible environments, we recommend using conda/mamba with an environment file:

# environment.yml
name: nereus-env
channels:
  - conda-forge
dependencies:
  - python>=3.10
  - nereus
  - jupyterlab  # for interactive analysis

Create and activate the environment:

mamba env create -f environment.yml
mamba activate nereus-env