Installation Guide

Requirements

rojak currently only supports Python >=3.12. This is mainly due to the type hinting syntax that has been used

    "crick", # necessary for dask.percentile method
    "dask",
    "distributed",
    "h5netcdf",
    "pydantic",
    "pyproj",
    "pyyaml",
    "scipy",
    "typer",
    "xarray",

Installation

There are a few way which rojak can be installed. The easiest is through pip

$ pip install rojak-cat
$ uv add rojak # if you use uv as your package manager

If you’d like the latest changes, rojak can be installed from source

$ git clone git@github.com:ImperialCollegeLondon/rojak.git
$ cd rojak
$ pip install -e

If you use uv as your package manager and have cloned the repo, the core dependencies can be installed through,

$ uv sync

If you’d like all the dependencies,

$ uv sync --all-groups

If you do not require the docs, dev and test dependencies,

$ uv sync --all-groups --no-group test --no-group dev --no-group docs