Repository Setup

This repository comes with a pyproject.toml and pixi.lock file that manage the environment. Make sure you have pixi installed (just run curl -fsSL https://pixi.sh/install.sh | bash).

First steps

First of all we have to install the environment and the environment variables. To do this we have to create an .env file with the following variables:

# Local data root path
DATA_DIR="/path/to/local/data/"
# Local remote in the same machine
DVC_REMOTE_DIR="/data/research/maqc_dvc_remote"

If you require a proxy connection, you may define the address here as:

# -- OTHER
HTTPS_PROXY = "http://your.proxy.server:port"
HTTP_PROXY = "http://your.proxy.server:port"

Configuring and installing

To configure the environment, first run the makefile typing:

make

To activate the environment in the shell use:

pixi shell

This is equivalent to run conda activate .venv. To exit the environment just type exit.

To run a comand without entering the environment you can do pixi run <insert-your-commands-here>.

Retrieving the data

To run the pipeline we just need to run the following command:

dvc repro 

This will retrieve the raw data from the local machine into the repository folder.