Installation instructions#

There are two ways to install this project

Using Conda (recommended for newcomers)
Using a development container (recommended if you are able to install Docker on your machine)

Installation#

Clone the repository:

git clone https://www.github.com/mila-iqia/ResearchTemplate
cd ResearchTemplate

Installing dependencies

You can install the package using pip install -e ., although we recommend using the Rye package manager. This makes it easier to switch python versions and to add or change the dependencies later on.
1. On your machine:
```
curl -sSf https://rye.astral.sh/get | bash
rye sync       # Creates a virtual environment and installs dependencies in it.
```
2. On the Mila cluster:
  
  If you're on the mila cluster, you can run this setup script (on a compute node):
```
# Get a compute node to run an interactive job:
salloc --gres=gpu:1 --cpus-per-task=4 --mem=16G --time=1:00:00
# Run the installation script.
scripts/mila_setup.sh
```

Using a development container#

This repo provides a Devcontainer configuration for Visual Studio Code to use a Docker container as a pre-configured development environment. This avoids struggles setting up a development environment and makes them reproducible and consistent. and make yourself familiar with the container tutorials if you want to use them. In order to use GPUs, you can enable them within the .devcontainer/devcontainer.json file.

Setup Docker on your local machine

On an Linux machine where you have root access, you can install Docker using the following commands:
```
curl -fsSL https://get.docker.com -o get-docker.sh
sudo sh get-docker.sh
```
On Windows or Mac, follow these installation instructions
(optional) Install the nvidia-container-toolkit to use your local machine's GPU(s).
Install the Dev Containers extension for Visual Studio Code.
When opening repository in Visual Studio Code, you should be prompted to reopen the repository in a container:

Alternatively, you can open the command palette (Ctrl+Shift+P) and select Dev Containers: Rebuild and Reopen in Container.