CLI & Script Reference

This page is the detailed reference for PRISM’s command-line tools and scripts.

0) Environment requirement (.venv)

Both prism.py and prism_tools.py enforce running from the repo-local virtual environment at ./.venv.

macOS / Linux:

source .venv/bin/activate

Windows:

.venv\Scripts\activate

If you see:

❌ Error: You are not running inside the prism virtual environment!

activate the environment and retry.

1) prism.py — the dataset validator

Purpose

  • Validate a dataset against BIDS rules (optional) and PRISM schemas.

  • Produce machine-readable reports (JSON, SARIF, JUnit, Markdown, CSV).

  • Optionally apply safe auto-fixes (--fix).

Usage

python prism.py /path/to/dataset

Options (complete)

Option

Meaning

-v, --verbose

Print detailed progress / scanning info.

--schema-version VERSION

Choose schema version (e.g. stable, 0.1). Default is stable.

--schema-info MODALITY

Show schema details for a modality (currently a minimal stub).

--list-versions

List schema versions available in schemas/.

--bids

Run the standard BIDS validator in addition to PRISM validation.

--bids-warnings

Include warnings from BIDS validator output (default hidden).

--no-prism

Skip PRISM-specific checks (only BIDS if --bids is set).

--json

Output a JSON report to stdout (compact).

--json-pretty

Output a JSON report to stdout (pretty).

--format {json,sarif,junit,markdown,csv}

Set an explicit output format.

-o FILE, --output FILE

Write report to a file.

--fix

Apply auto-fixes for common issues (e.g., missing sidecars, .bidsignore).

--dry-run

Show what --fix would change without applying it.

--list-fixes

List which issue types are auto-fixable.

--init-plugin NAME

Create a validator plugin template at <dataset>/validators/<NAME>.py.

--list-plugins

List plugins loaded for a dataset.

--no-plugins

Disable plugin loading.

--version

Print PRISM version and exit.

Common examples

# Validate
python prism.py /data/study-01

# Validate with BIDS validator too
python prism.py /data/study-01 --bids

# Produce SARIF for GitHub Code Scanning
python prism.py /data/study-01 --format sarif -o prism.sarif

# Auto-fix (preview)
python prism.py /data/study-01 --fix --dry-run

# Auto-fix (apply)
python prism.py /data/study-01 --fix

2) prism_tools.py — conversions, libraries, and helpers

Purpose

prism_tools.py is the “Swiss Army Knife” for creating and managing PRISM-compatible content:

  • Import Survey and Biometrics libraries from Excel

  • Convert wide survey exports into a PRISM/BIDS-like dataset

  • Create survey derivatives (scores, reverse-coding) from an already valid dataset

  • Convert Varioport .raw physio data into BIDS-like output

  • Generate manuscript-ready Methods boilerplate from your libraries

Usage

python prism_tools.py --help
python prism_tools.py <command> --help

Command overview

convert physio

Convert Varioport physiological recordings (.raw) into BIDS-like outputs.

python prism_tools.py convert physio \
  --input ./sourcedata \
  --output ./rawdata \
  --task rest \
  --suffix ecg \
  --sampling-rate 256

demo create

Create a demo dataset for testing.

python prism_tools.py demo create --output prism_demo_copy

survey import-excel

Import survey templates from an Excel codebook into a JSON library.

python prism_tools.py survey import-excel --excel surveys.xlsx --library-root library

survey validate

Validate survey library JSONs and enforce uniqueness constraints.

python prism_tools.py survey validate --library library/survey

survey convert

Convert a wide survey export (.xlsx or LimeSurvey .lsa) into a PRISM/BIDS-like dataset.

python prism_tools.py survey convert \
  --input survey_export.xlsx \
  --output /tmp/my_prism_dataset

Key options:

  • --library: select template folder

  • --lang: language selection for i18n templates (de default; auto for .lsa)

  • --unknown {error,warn,ignore}: how to handle unmapped columns

  • --dry-run: print mapping only

  • --force: allow writing into non-empty output directory

survey import-limesurvey / survey import-limesurvey-batch

Import LimeSurvey instruments into PRISM templates/datasets.

python prism_tools.py survey import-limesurvey --input instrument.lsa --output survey-ads.json

python prism_tools.py survey import-limesurvey-batch \
  --input-dir ./limesurvey_exports \
  --output-dir ./my_dataset \
  --session-map t1:ses-1,t2:ses-2,t3:ses-3

survey i18n-migrate / survey i18n-build

Create and compile i18n-capable survey templates.

# Create i18n source templates (no translation added automatically)
python prism_tools.py survey i18n-migrate --src library/survey --dst library/survey_i18n --languages de,en

# Compile i18n templates for one target language
python prism_tools.py survey i18n-build --src library/survey_i18n --out library/survey_de --lang de --fallback de

biometrics import-excel

Import biometrics templates from an Excel codebook.

python prism_tools.py biometrics import-excel \
  --excel biometrics_codebook.xlsx \
  --sheet 0 \
  --library-root library

Key options:

  • --equipment: default Technical.Equipment

  • --supervisor: default Technical.Supervisor

dataset build-biometrics-smoketest

Generate a small biometrics dataset (templates + dummy data) for testing.

python prism_tools.py dataset build-biometrics-smoketest --output /tmp/prism_biometrics_smoketest

derivatives surveys / derivatives biometrics

Compute derived scores from TSVs in an already valid PRISM dataset.

# Survey derivatives
python prism_tools.py derivatives surveys --prism /path/to/dataset --format prism

# Biometric derivatives (supports xlsx, csv, save, r)
python prism_tools.py derivatives biometrics --prism /path/to/dataset --format xlsx

See DERIVATIVES.md for details on how to write scoring recipes.

library generate-methods-text

Generate manuscript-ready methods text from libraries.

python prism_tools.py library generate-methods-text --output methods_en.md --lang en
python prism_tools.py library generate-methods-text --output methods_de.md --lang de

3) “Scripts” in scripts/

Most files under scripts/ are implementation details called by the CLIs.

If you’re a new user, prefer:

  • python prism.py ... (validation)

  • python prism_tools.py ... (imports/conversion/derivatives)

  • python prism-studio.py (web interface)

If you’re developing PRISM, see IMPLEMENTATION_SUMMARY.md.