Installation#

Note

Scarabaeus has not been added to PyPi yet. You will need to compile Rust source code in order for it to function correctly, see the developer guide for further instructions.

User Installation#

1. Clone the repository

git clone <https://github.com/CCAR-ORCCA/scarabaeus>
cd scarabaeus

2. Create a virtual environment

 # macOS / Linux
python3 -m venv .venv
source .venv/bin/activate

# Windows
python -m venv .venv
.venv\Scripts\activate

3. Install Scarabaeus

Currently, Scarabaeus can only be installed in developer mode, see the Dev Environment Guide for more on how to do this. Developer mode includes all SCB functionality in addition to tools for developing tests and Rust binding.