00. Getting Started

Prerequisites

Account Requirements

Before you begin, ensure you have:

• An account with Digital Research Alliance of Canada
• An account with Arbutus
• The ability to login to Arbutus

Software Requirements

To recreate the computational environment, you will need ONE of the following:

Option A: Docker (Recommended)

• Docker installed on your computer
• Works on all operating systems (Windows, macOS, Linux)

Option B: Conda

• Miniforge installed
• conda-lock installed (run conda install conda-lock if not installed)
• Only available for: linux-64, osx-64, osx-arm64

Installation

Step 1: Clone the Repository

git clone https://github.com/skysheng7/awp-arbutus-login.git
cd awp-arbutus-login

Step 2: Set Up Your Environment

Choose the method that matches your prerequisites:

NoteOption 1: Using Docker (Recommended)

Advantages: Works on all operating systems, consistent environment across platforms

1. Start the Docker container:

docker compose run --rm arbutus_python

Or use the Make shortcut:

make docker

2. You will enter a bash shell inside the container. Your prompt will look like:

   (arbutus) root@e5d14c9ca3cc:/#

3. When finished, exit the container:

   • Type exit + press Enter to leave the bash shell
   • Run docker compose down to remove the container, network and volumes

NoteOption 2: Using conda-lock

Platforms: linux-64, osx-64, osx-arm64 only

Advantages: Reproducible environment with locked dependencies

conda-lock install -n arbutus conda-lock.yml
conda activate arbutus

NoteOption 3: Using environment.yml

Platforms: linux-64, osx-64, osx-arm64 only

Advantages: Simpler setup

conda env create -f environment.yml
conda activate arbutus

Next Steps

Once your environment is set up, proceed to:

• Arbutus Authentication - Set up OpenStack authentication