website dev

Author: zh1peng

docs/.doctrees/environment.pickle

@@ -1,3 +1,5 @@
+
+
 TaskBeacon
 ----------
 
@@ -6,7 +8,12 @@ Our mission is to improve reproducibility and efficiency in psychological and br
 
 TaskBeacon offers a suite of tools and resources:
 
-- `TAPS <https://taskbeacon.github.io/taps>`_ – A standardized format for structuring cognitive tasks 
+.. image:: _static/flowchart.png
+   :alt: Illustration of TaskBeacon
+   :align: left
+   :width: 100%
+
+- :doc:`TAPS </taps>` – A standardized format for structuring cognitive tasks 
 - `psyflow <https://taskbeacon.github.io/psyflow/>`_ – A Python library for programming cognitive experiments 
 - `Task Library <https://taskbeacon.github.io/task_index/>`_ – A curated collection of well-documented experimental templates 
 

docs/.doctrees/index.doctree

@@ -0,0 +1,11 @@
+```mermaid
+flowchart LR
+    A[YAML<br>Subinfo:<br>- field<br>- mapping] --> B[SubInfo<br>Subinfo Collection]
+    C[YAML<br>Task:<br>- trial n<br>- block n<br>- key<br>- condition] --> D[BlockUnit]
+    D --> E[run_trial (GO)]
+    D --> F[run_trial (Stop)]
+    G[YAML<br>Timing:<br>- duration<br>- Controller:<br>- ssd<br>- min/max] --> E
+    G --> F
+    H[YAML<br>Stimuli:<br>- type<br>- color<br>- text<br>- pos] --> I[StimBank]
+    E --> I
+    F --> I

docs/.doctrees/psyflow.doctree

@@ -1,5 +1,52 @@
 # TAPS
 
-The Task Archive and Protocol Specification (TAPS) defines a consistent format for describing cognitive tasks. By capturing stimuli, procedures and timing, TAPS makes tasks reproducible and easier to share.
+The Task and Paradigm Structure (TAPS) provides a standardized folder layout for organizing cognitive tasks in a modular and reproducible way. This structure promotes clarity, cross-task consistency, and ease of reuse—whether in individual research projects or shared task libraries.
 
-Researchers can write tasks once and deploy them across different platforms without manual rewriting.
+Each task organized under TAPS typically contains the following components:
+
+`assets/`
+Contains all multimedia stimuli used in the task, such as images (.bmp), audio files (.mp3), or videos (.mp4). These files are referenced by the configuration and code but stored independently for clarity.
+
+`config/`
+Includes YAML configuration files (e.g., config.yaml) that define task parameters, stimuli mappings, timing settings, and localization content. This enables flexible task customization without modifying the source code.
+
+`data/`
+Stores participant outputs including raw logs, structured .csv data, and optionally serialized formats like .json. Each session is typically timestamped for easy tracking and reproducibility.
+
+`src/`
+Contains the core Python scripts implementing the task logic and runtime flow (e.g., run_trial.py, controller.py). This code defines how trials are executed, how input is handled, and how responses are recorded.
+
+`analysis/`
+(Optional) Includes scripts to analyze the collected data. Useful for quick validation, pilot analysis, or standardized data summaries.
+
+`main.py`
+A runnable Python entry point that initializes the task using the configuration and source logic. This is typically the file users execute to start the experiment.
+
+`README.md`
+Provides human-readable documentation describing the task’s purpose, structure, configuration, and usage.
+
+A sample directory tree might look like this:
+```
+Task/
+├── assets/             # Multimedia stimuli (images, sounds, videos, etc.)
+│ ├── instruction.mp3
+│ ├── stim1.bmp
+│ ├── stim2.bmp
+│ └── stim3.bmp
+├── config/
+│ └── config.yaml       # YAML-based configuration files for task logic and settings
+├── data/               # Collected participant data and logs
+│ ├── sub-001_task_sst_20250603_143742.json
+│ ├── sub-001_task_sst_20250603_143742.log
+│ └── sub-001_task_sst_20250603_143742.csv
+├── src/                # Source code implementing task flow and logic
+│ ├── __init__.py
+│ ├── run_trial.py
+│ └── controller.py
+├── analysis/            # Optional scripts for analyzing collected data
+│ └── analysis.py
+├── main.py              # Entry point for running the task   
+└── README.md            # Documentation
+```
+
+This structure cleanly separates task components—stimuli, configuration, logic, data, and metadata—enabling better task reuse, localization, and version control.