Installation#
Installation method 1 (recommended): New environment with conda/mamba#
Make a new Python environment with RiverREM installed:
conda create -n rem_env riverrem
Note
mamba is recommended over conda as it is able to solve environment dependencies quickly and robustly. If you are using mamba, replace conda with mamba in the above command.
The environment can then be activated:
conda activate rem_env
Installation method 2: Existing environment#
Install via conda/mamba
conda install -c conda-forge riverrem
Installation method 3: Repository clone#
Clone the GitHub repository and create a conda environment from the environment.yml
git clone https://github.com/opentopography/RiverREM.git
cd RiverREM
conda env create -n rem_env --file environment.yml
Confirm installation works#
After installing, you should be able to open a Python interpreter and import without errors:
from riverrem.REMMaker import REMMaker
Continue to the Quickstart to start making REMs.