aind-vr-foraging
A repository for the VR Foraging task.
📋 General instructions
This repository follows the project structure laid out in the Aind.Behavior.Services repository.
⚙️ Generating settings files
The VR Foraging tasks is instantiated by a set of three settings files that strictly follow a DSL schema. These files are:
task.jsonrig.jsonsession.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 TaskPath=<path-to-task.json>
[> ] CLI tools
The platform exposes a few CLI tools to facilitate various tasks. Tools are available via:
uv run vr-foraging <subcommand>
for a list of all sub commands available:
uv run vr-foraging -h
You may need to install optional dependencies depending on the sub-commands you run.
🔍 Primary data quality-control
Once an experiment is collected, the primary data quality-control script can be run to check the data for issues. This script can be launcher using:
uv run vr-foraging data-qc <path-to-data-dir>
🌉 Mapping to aind-data-schema
Once an experiment is collected, data can be mapped to aind-data-schema using the data-mapper sub-command:
uv run vr-foraging data-mapper
🔄 Regenerating schemas
DSL schemas can be modified in ./src/aind_behavior_vr_foraging/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 vr-foraging regenerate
1 maintainer
Metadata
1 maintainer
Release files for aind-behavior-vr-foraging 1.2.5
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| aind_behavior_vr_foraging-1.2.5.tar.gz | 37.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| aind_behavior_vr_foraging-1.2.5-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 89.1 kB
Release files / aind_behavior_vr_foraging-1.2.5.tar.gz
| Download URL | aind_behavior_vr_foraging-1.2.5.tar.gz |
|---|---|
| Size | 37.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
bb95a5b3248087a2a8354fde980caa68d28d4548c4d5f4f191be2e598fd3c83e
|
|
BLAKE2b-256 checksum How to use checksums |
8d35085679169600b38ca52090bcf6c9dafbd0344de86d30a3f6d92b367af9f3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.12.12 {"installer":{"name":"uv","version":"0.12.12","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / aind_behavior_vr_foraging-1.2.5-py3-none-any.whl
| Download URL | aind_behavior_vr_foraging-1.2.5-py3-none-any.whl |
|---|---|
| Size | 51.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
1cc725a5f3d254a274d9e20dba57777fee3eef9866eb32d9973ccf39587f7f73
|
|
BLAKE2b-256 checksum How to use checksums |
f316965aa7b83d6b00edb9b2cc856f31fcfc864a125849d69bd984ef905ef0aa
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.12.12 {"installer":{"name":"uv","version":"0.12.12","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
