Quick Start
1) Install (source checkout)
macOS / Linux: follow INSTALLATION.md (uses
./setup.shand enforces a local.venv).Windows: follow WINDOWS_SETUP.md.
2) Validate a dataset (CLI)
# Basic validation
python prism.py /path/to/dataset
# JSON output for CI/CD
python prism.py /path/to/dataset --json
# Auto-fix common issues
python prism.py /path/to/dataset --fix
# Export as SARIF (GitHub Code Scanning)
python prism.py /path/to/dataset --format sarif -o results.sarif
See USAGE.md for all CLI options.
3) Run the web interface
python prism-studio.py
Open http://localhost:5001 in your browser.
4) Use PRISM tools
# List all commands
python prism_tools.py --help
# Build bilingual survey template
python prism_tools.py survey i18n-build library/survey/survey-phq9.json --lang en
# Generate a manuscript-ready Methods snippet from your libraries
python prism_tools.py library generate-methods-text --output methods_en.md --lang en
# Initialize a plugin
python prism.py --init-plugin my_validator /path/to/dataset
See PRISM_TOOLS.rst and USAGE.md.
5) Error Codes
All errors use structured PRISM codes (PRISM001-PRISM9xx). See ERROR_CODES.md for the complete reference.