Setup Guide

Prerequisites

• Python 3.10+
• Git
• rclone
• Wasabi S3 credentials (access key + secret key)

macOS

# Install Homebrew (if not installed)
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

# Install dependencies
brew install python@3.12 git rclone

# Clone the repo
git clone git@github.com:eserie/MaQI.git
cd MaQI

# Run setup
./setup.sh

Linux (Ubuntu/Debian)

# Install dependencies
sudo apt-get update
sudo apt-get install -y python3 python3-venv git curl

# Install rclone
curl https://rclone.org/install.sh | sudo bash

# Clone the repo
git clone git@github.com:eserie/MaQI.git
cd MaQI

# Run setup
./setup.sh

Windows

Option A: WSL (recommended)

# Install WSL
wsl --install

# Then follow Linux instructions inside WSL

Option B: Native

# Install Python: https://www.python.org/downloads/
# Install Git: https://git-scm.com/download/win
# Install rclone: https://rclone.org/downloads/

# Clone the repo
git clone git@github.com:eserie/MaQI.git
cd MaQI

# Run setup
python -m venv .venv
.venv\Scripts\activate
pip install -r requirements.txt

Configure Wasabi S3

1. Copy the config template:

mkdir -p ~/.config/rclone
cp rclone.conf.example ~/.config/rclone/rclone.conf

1. Edit ~/.config/rclone/rclone.conf and replace:

   • YOUR_ACCESS_KEY with your access key
   • YOUR_SECRET_KEY with your secret key
2. Test:

./test-connection.sh

Verify

# Activate the environment
source .venv/bin/activate

# Check Python
python -c "import polars; print('polars OK')"

# Check S3
rclone ls maqi:maqi/test-data/