44.. :height: 100px
55.. :align: center
66
7- Welcome to psyflow’s documentation!
7+ Welcome to psyflow
88===================================
99
1010**psyflow ** is a modular framework for building cognitive and behavioral tasks using PsychoPy and Python code.
1111
12- - 🚀 Easy to compose trials and blocks
13- - 🧠 EEG/MEG-friendly trigger sending
14- - 🎯 Perfect for cognitive experiments in research
12+ Features
13+ --------
14+ - Modular classes for each experiment phase (GUI, stimuli, trials, blocks)
15+ - Declarative configuration with lifecycle hooks
16+ - Audio support including text-to-speech and hardware triggers
17+ - LLM integration and CLI scaffolding tools
18+
19+ Core Components
20+ ---------------
21+ - **SubInfo **: GUI-based subject metadata collection with localization
22+ - **TaskSettings **: Loads `config.yaml `, initializes window/keyboard, manages logging
23+ - **StimBank **: Registry for stimuli (decorators or YAML), lazy loading, preview, dynamic formatting, TTS
24+ - **StimUnit **: Presents stimuli, captures responses, sends triggers, logs events
25+ - **BlockUnit **: Generates and runs trial sequences; supports pre/post hooks
26+ - **TriggerSender **: Hardware trigger output with debug and timing control
27+ - **LLMClient **: Automates config translation and README generation
28+ - **CLI (`psyflow task`) **: Scaffolds a ready-to-use task directory
1529
1630Start with one of the tutorials below or explore the API reference.
1731
@@ -23,8 +37,8 @@ Start with one of the tutorials below or explore the API reference.
2337 tutorials/get_subinfo
2438 tutorials/task_settings
2539 tutorials/build_blocks
26- tutorials/build_stimunit
2740 tutorials/build_stimulus
41+ tutorials/build_stimunit
2842 tutorials/send_trigger
2943 tutorials/cli_usage
3044 tutorials/utilities
0 commit comments