This release is a pre-release and may not be stable for production use.
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
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file aind_behavior_vr_foraging-1.2.2rc1.tar.gz.
File metadata
- Download URL: aind_behavior_vr_foraging-1.2.2rc1.tar.gz
- Upload date:
- Size: 37.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
uv/0.12.3 {"installer":{"name":"uv","version":"0.12.3","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}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
3477ce7abc11de13c6ed57bb2793b26eabc20d7c279046acbbd5a070b9d9b162
|
|
| MD5 |
496a6af6fa800197d5572225cb048d32
|
|
| BLAKE2b-256 |
c5cd12ac1b837a5876e4d6b5190125b4ce5135012a12f60c6ebdecb2fcacf217
|
File details
Details for the file aind_behavior_vr_foraging-1.2.2rc1-py3-none-any.whl.
File metadata
- Download URL: aind_behavior_vr_foraging-1.2.2rc1-py3-none-any.whl
- Upload date:
- Size: 51.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
uv/0.12.3 {"installer":{"name":"uv","version":"0.12.3","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}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
19f4715210c25d20c4a0a4e10c6b400800ac64966f6b1365d1b9b9145ab07ec4
|
|
| MD5 |
69f190df3f9449120aac3d17f854307f
|
|
| BLAKE2b-256 |
f31648617e72f980d84323833b9a03f3cc788899713d495185ba4b1935f6977f
|
