clabe
██████╗██╗ █████╗ ██████╗ ███████╗ ██╔════╝██║ ██╔══██╗██╔══██╗██╔════╝ ██║ ██║ ███████║██████╔╝█████╗ ██║ ██║ ██╔══██║██╔══██╗██╔══╝ ╚██████╗███████╗██║ ██║██████╔╝███████╗ ╚═════╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚══════╝ Command-line-interface Launcher for AIND Behavior Experiments
CLABE is a Python toolkit for building, running, and operating behavioral-experiment workflows. It provides a launcher for experiment scripts alongside composable utilities for user interaction, external applications, configuration and storage, resource checks, data transfer, remote execution, logging, and repository-state capture.
The library is designed to be useful both in an interactive experiment session and in scripted or remote workflows.
Install
For a project managed with uv:
uv add aind-clabe
Or install with pip:
pip install aind-clabe
To work on this repository locally:
git clone https://github.com/AllenNeuralDynamics/clabe.git
cd clabe
uv sync
What CLABE provides
- Experiment launcher — discover and run functions marked with
@experiment, with console, TUI, and web-served interaction options. - Frontends and forms — collect typed input from Pydantic models, prompt for paths, confirmations, selections, and read-only reviews.
- Applications and executors — describe external commands once and run them locally, asynchronously, detached, or on another rig through XML-RPC.
- Multi-rig experiments — run apps in a matching checkout on another computer (
RemoteRepository), start its server automatically, and transfer both machines' data through one watchdog manifest. See Running on other rigs. - Stores and services — compose local, in-memory, and optional Ficus (confierge) and Dataverse-backed configuration and data services.
- Operational helpers — resource constraints, data transfer, structured logging, OpenTelemetry support, and session construction.
- Repository state — capture a JSON snapshot of a repository and its submodules for dataset or experiment metadata.
Quick start
Define an experiment in a Python module:
from clabe.launcher import Launcher, experiment
@experiment()
async def my_experiment(launcher: Launcher) -> None:
launcher.frontend.notify("Experiment started")
# Configure the session, check resources, and run applications here.
Run the module with the CLABE CLI:
uv run clabe run path/to/my_experiment.py
See examples/behavior_launcher.py for a fuller example that combines sessions, forms, stores, resource checks, applications, and telemetry.
Command line
Show available commands and their options:
uv run clabe --help
Run an experiment interactively:
uv run clabe run path/to/my_experiment.py
Serve an experiment's text UI locally:
uv run clabe serve path/to/my_experiment.py --port 8089
Capture Git state for a repository and all declared submodules:
uv run clabe repository-state path/to/repository > repository-state.json
Each repository entry includes its URL, commit SHA, exact and nearest tags, branch, dirty state, name, cwd-relative path, and nested submodules. The launcher writes this snapshot alongside its temporary output; when logs are copied, it is saved at Behavior/Logs/.launcher/repository-state.json in the session directory.
Optional integrations
Some integrations are optional so a basic installation remains lightweight:
uv add "aind-clabe[aind-services]" # AIND services, data schema, and transfer tooling
uv add "aind-clabe[web]" # Web-served Textual UI
uv add "aind-clabe[otel]" # OpenTelemetry exporters and YAML support
Documentation and development
- Browse the documentation for API references and guides.
- Run tests with
uv run pytest. - Check style with
uv run ruff check. - Build documentation locally with
uv run mkdocs serveafter installing thedocsdependency group.
Contributions are welcome. Please include focused tests for behavior changes and keep the package's cross-platform support in mind.
Metadata
Release files for aind-clabe 0.15.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| aind_clabe-0.15.3.tar.gz | 149.8 kB | Without provenance | Details for aind_clabe-0.15.3.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| aind_clabe-0.15.3-py3-none-any.whl | Python 3 | none | any | Details for aind_clabe-0.15.3-py3-none-any.whl |
Total release size: 331.4 kB
Release files / aind_clabe-0.15.3.tar.gz
| Download URL | aind_clabe-0.15.3.tar.gz |
|---|---|
| Size | 149.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a993b452670f870af4a4f893d3abf96cbd1aa3d17f5a2445758357398e269c1f
|
|
BLAKE2b-256 checksum How to use checksums |
fbba0a08cb2c43f1e87dff3c919b643d10ca559265d1845464e70abdf719ec90
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.13.9 {"installer":{"name":"uv","version":"0.13.9","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"26.04","id":"resolute","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / aind_clabe-0.15.3-py3-none-any.whl
| Download URL | aind_clabe-0.15.3-py3-none-any.whl |
|---|---|
| Size | 181.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
a7d4a7b591ab87fd28ff4b51631d6910397964b45ae61342f61d3df3373a0510
|
|
BLAKE2b-256 checksum How to use checksums |
8712c352e2b6c3fa757a2fe6066197546d483106fd1b17fc5b6359b43b158e28
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.13.9 {"installer":{"name":"uv","version":"0.13.9","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"26.04","id":"resolute","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Security for aind-clabe 0.15.3
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.