A library for a minimal framework that can be used to build experimental interfaces.
Project description
██████╗██╗ █████╗ ██████╗ ███████╗ ██╔════╝██║ ██╔══██╗██╔══██╗██╔════╝ ██║ ██║ ███████║██████╔╝█████╗ ██║ ██║ ██╔══██║██╔══██╗██╔══╝ ╚██████╗███████╗██║ ██║██████╔╝███████╗ ╚═════╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚══════╝ Command-line-interface Launcher for AIND Behavior Experiments
clabe
A library for building workflows for behavior experiments.
⚠️ Caution: This repository is currently under active development and is subject to frequent changes. Features and APIs may evolve without prior notice.
Installing and Upgrading
If you choose to clone the repository, you can install the package by running the following command from the root directory of the repository:
pip install .
Otherwise, you can use pip:
pip install aind-clabe
Getting started and API usage
The library provides a main class "Launcher" that can be used to create a linear workflow for behavior experiments. These workflows rely on modular interfaces that can be used to interact with various components of the experiment and other services. Some of these services are specific for AIND:
We will also try to scope all dependencies of the related to AIND Services to its own optional dependency list in the ./pyproject.toml file of this repository. Therefore, in order to use this module, you will need to install these optional dependencies by running:
uv sync --extra aind-services
A basic example of how to use the Launcher class can be found in the examples directory of this repository.
Contributors
Contributions to this repository are welcome! However, please ensure that your code adheres to the recommended DevOps practices below:
Linting
We use ruff as our primary linting tool.
Testing
Attempt to add tests when new features are added.
To run the currently available tests, run uv run pytest from the root of the repository.
Lock files
We use uv to manage our lock files and therefore encourage everyone to use uv as a package manager as well.
Release history Release notifications | RSS feed
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_clabe-0.9.1.tar.gz.
File metadata
- Download URL: aind_clabe-0.9.1.tar.gz
- Upload date:
- Size: 66.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.9.17 {"installer":{"name":"uv","version":"0.9.17","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":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 |
c6ae4fb781e5b27af044ffcbd413d7c5532e3a272595b74266ab280d86a90217
|
|
| MD5 |
54083b57ce93688dd578aaada91ece57
|
|
| BLAKE2b-256 |
8cab7f27c98f4f2bf7062548b4d076ae2ec9d00f7e77640a1573f7a896c44835
|
File details
Details for the file aind_clabe-0.9.1-py3-none-any.whl.
File metadata
- Download URL: aind_clabe-0.9.1-py3-none-any.whl
- Upload date:
- Size: 88.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.9.17 {"installer":{"name":"uv","version":"0.9.17","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":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 |
d7197635c842acafaf83ad4a6eb686a387a85c9ee51d96e2c200857dc635f95d
|
|
| MD5 |
60dfacc069b01916180f865ac74e045d
|
|
| BLAKE2b-256 |
ab8795a2e9d73c7421bdf37c4d67aa0ebd66d455a6d81cb63acc70053334b162
|
