Installation

PRISM is designed to be easy to install on Windows, macOS, and Linux.

Prerequisites

• Python 3.8 or higher: Download Python

• Deno (for BIDS validation): Download Deno (Automatically installed by setup script)

• Git (optional, for cloning the repository): Download Git

Quick Install (Recommended)

macOS / Linux

Open your terminal and run:

git clone https://github.com/MRI-Lab-Graz/prism-studio.git
cd prism-studio
bash scripts/setup/setup.sh

Windows

Open Command Prompt or PowerShell and run:

git clone https://github.com/MRI-Lab-Graz/prism-studio.git
cd prism-studio
scripts\setup\setup-windows.bat

This will:

1. Create a Python virtual environment (.venv).

2. Install all necessary dependencies.

3. Prepare the application for use.

Note: The CLI tools (prism.py, prism_tools.py) intentionally enforce running from the repository-local virtual environment at ./.venv.

Manual Installation

If you prefer to set it up manually:

# 1. Clone the repository
git clone https://github.com/MRI-Lab-Graz/prism-studio.git
cd prism-studio

# 2. Create a virtual environment
python -m venv .venv

# 3. Activate the environment
# macOS/Linux:
source .venv/bin/activate
# Windows:
.venv\Scripts\activate

# 4. Install dependencies
pip install -r requirements.txt

Verifying Installation

To check if everything is installed correctly, try running the help command:

# macOS/Linux
source .venv/bin/activate
python prism.py --help

# Windows
.venv\Scripts\activate
python prism.py --help

If you see the help message, you are ready to go!