Installation

RUBEM depends on PCRaster and GDAL, which are distributed through conda-forge. Create the runtime environment first and install RUBEM into it with pip.

Requirements

  • Python 3.12 or later

  • A conda-compatible package manager (Miniconda, Miniforge or micromamba)

From the repository

  1. Get the source code, either by cloning the repository:

    git clone https://github.com/LabSid-USP/RUBEM.git
    cd RUBEM
    

    or by downloading the archive of the latest release from the releases page and entering the extracted directory, which is named after the release:

    tar -xzf RUBEM-<version>.tar.gz
    cd RUBEM-<version>
    
  2. Create and activate the runtime environment, with conda:

    conda env create -f environment.yml
    conda activate rubem
    

    or with micromamba, which has no conda command:

    micromamba create -f environment.yml -y
    micromamba activate rubem
    
  3. Install RUBEM into the environment:

    pip install .
    

Running the model

With the environment active, the rubem command is available anywhere:

rubem -h
rubem run -c config.json

Development installs

For working on RUBEM itself, install in editable mode with the development extras:

pip install -e '.[dev]'