Skip to main content

aind-vr-foraging

CI PyPI - Version License ruff uv

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.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 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 launched using:

uv run vr-foraging data-qc <path-to-data-dir>

🔄 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

Metadata

Release files for aind-behavior-vr-foraging 1.3.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for aind-behavior-vr-foraging 1.3.2
File Size Uploaded Provenance Actions
aind_behavior_vr_foraging-1.3.2.tar.gz 25.7 kB Without provenance Details for aind_behavior_vr_foraging-1.3.2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for aind-behavior-vr-foraging 1.3.2
File Interpreter ABI Platform Actions
aind_behavior_vr_foraging-1.3.2-py3-none-any.whl Python 3 none any Details for aind_behavior_vr_foraging-1.3.2-py3-none-any.whl

Total release size: 63.0 kB

Release files / aind_behavior_vr_foraging-1.3.2.tar.gz

Download URL aind_behavior_vr_foraging-1.3.2.tar.gz
Size 25.7 kB
Tags Source
SHA-256 checksum
How to use checksums
0047b6f75c82c616f8e07a07426799a8f989c8b4de02b4cc2da2e79bb2b944fa
BLAKE2b-256 checksum
How to use checksums
33f532e80e921c5876a07a2ef76fc4d209b3148c472c53c99e68ebe4fbf3f12f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.13.5 {"installer":{"name":"uv","version":"0.13.5","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.3.2-py3-none-any.whl

Download URL aind_behavior_vr_foraging-1.3.2-py3-none-any.whl
Size 37.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
b1f01bdbcdd91ac79a44900c40cceb6dcdaad2b073834a634df73f97542cc802
BLAKE2b-256 checksum
How to use checksums
05fff649e03f93e46a3cbd5eb98effff8997df6558825bb3f7c488032fd7dd9f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.13.5 {"installer":{"name":"uv","version":"0.13.5","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}

Security for aind-behavior-vr-foraging 1.3.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

1.3.2 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page