aind-behavior-telekinesis

Task implementation of brain-computer interface experiments.

---

📋 General instructions

This repository follows the project structure laid out in the Aind.Behavior.Services repository.

---

🔧 Prerequisites

Pre-requisites for running the project can be found here.

---

🚀 Deployment

For convenience, once third-party dependencies are installed, Bonsai and python virtual environments can be bootstrapped by running:

./scripts/deploy.ps1

from the root of the repository.

⚙️ Generating settings files

The Telekinesis tasks is instantiated by a set of three settings files that strictly follow a DSL schema. These files are:

• task_logic.json
• rig.json
• session.json

Examples on how to generate these files can be found in the ./Examples directory of the repository. Once generated, these are the the only required inputs to run the Bonsai workflow in ./src/main.bonsai.

The workflow can thus be executed using the Bonsai CLI:

"./bonsai/bonsai.exe" "./src/main.bonsai" -p SessionPath=<path-to-session.json> -p RigPath=<path-to-rig.json> -p TaskLogicPath=<path-to-task_logic.json>

🔄 Regenerating schemas

DSL schemas can be modified in ./src/aind_behavior_telekinesis/rig.py (or (...)/task_logic.py`).

Once modified, changes to the DSL must be propagated to json-schema and csharp API. This can be done by running:

uv run ./src/aind_behavior_telekinesis/regenerate.py