Installation
Follow these steps to set up the CLI and start the Docker image.
Prerequisites
- Git and Python 3.9+
- Docker running locally (Docker Desktop on Windows, Docker Engine on Linux)
- (Optional) SSH key configured for GitHub if using the SSH clone URL
Cloning over SSH
The command below uses the SSH URL. Ensure your GitHub SSH key is set up and loaded (e.g., ssh -T git@github.com).
Prefer HTTPS? Replace the URL accordingly.
1) Clone the repository
git clone --recursive git@github.com:parsa-epfl/qflex.gitcd qflex
2) Install requirements for the CLI
pip install -r requirements.txt
Use a virtual environment (recommended)
python -m venv .venv
# macOS/Linux
source .venv/bin/activate
# Windows (PowerShell)
.\.venv\Scripts\Activate.ps1
pip install -r requirements.txt
3) Start the Docker image
python dep start-docker --worm --mounting-folder <mounting_folder>
./dep start-docker --worm --mounting-folder <mounting_folder>
Verify
After the container starts, run:
./qflex --help
You should see qflex command-line options.
Need more on Docker or dependencies?
Where to look next
- Read the Docker guide for container usage, mounts, and troubleshooting: Docker
- Use the dep helper to explore commands and manage dependencies:
# Linux/macOS ./dep --help # Windows (PowerShell) python dep --help - To (re)start the container with your workspace mounted:
# Linux/macOS ./dep start-docker --worm --mounting-folder <mounting_folder> # Windows (PowerShell) python dep start-docker --worm --mounting-folder <mounting_folder>
Troubleshooting
Common issues
Permission denied on ./dep (Linux)
Make it executable:
chmod +x dep
Docker not found / not running
Start Docker Desktop (Windows) or the Docker daemon (Linux):
systemctl status docker
SSH clone fails
Test your SSH setup:
ssh -T git@github.com