Tutorials¶
These tutorials are the Jupyter notebooks from examples/ in the repository, rendered here with their saved outputs so you can read them without running anything. Each page also has a download link to the raw .ipynb file if you want to run it yourself.
Getting started¶
| Notebook | What it covers |
|---|---|
| Quickstart | Minimal working example — configure an ExpCard, run a scanner, export to CSV |
| Local Models with Ollama | Running experiments against local models with no API key |
| Parameters Reference | A tour of every ExpCard / ExpCardInit parameter |
Parsing responses¶
| Notebook | What it covers |
|---|---|
| Parsers | Overview of the built-in response parsers |
| Parser Modules | Writing and registering custom parser modules |
| Parser System Guide | Deep dive into the parser dispatch system |
Cognitive tasks and feedback¶
| Notebook | What it covers |
|---|---|
| Reality Monitoring Task | Reality monitoring across memory and feedback configurations |
| Feedback API | The trial-by-trial feedback/scoring mechanism |
| Reality Monitoring with Feedback | Combining the RM task with feedback |
Full study walkthrough¶
| Notebook | What it covers |
|---|---|
| VVIQ-16 Study | End-to-end imagery questionnaire study, from run to figure |
Running these yourself¶
git clone https://github.com/saurabhr/psychscanner.git
cd psychscanner
pip install -e ".[dev]"
jupyter lab examples/
For narrative, task-oriented walkthroughs (rather than notebook cell-by-cell tutorials), see the Examples section.