0.5.0

AIND Code Ocean dispatch

Launch, monitor, and capture batches of Code Ocean capsule runs

Installation

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-codeocean-dispatch

To develop the code, run:

uv sync

Capturing runs from a post-run automation

A Code Ocean pipeline can name an automation capsule that runs after every run. A capsule whose code/run is

#!/usr/bin/env bash
set -e
python -m aind_codeocean_dispatch.automation

captures each successful run as an internal data asset, named by the results' data_description.json when it declares a derived name and otherwise after the first input asset. It needs only CODEOCEAN_TOKEN; CAPTURE_TAGS, CAPTURE_FAILED and CAPTURE_PERMISSIONS adjust it. It registers nothing in DocDB and writes no external bucket, so pipelines that publish use asset-creation-capsule instead.

Development

Please test your changes using the full linting and testing suite:

./scripts/run_linters_and_checks.sh -c

Or run individual commands:

uv run --frozen ruff format          # Code formatting
uv run --frozen ruff check           # Linting
uv run --frozen mypy                 # Type checking
uv run --frozen interrogate -v src   # Documentation coverage
uv run --frozen codespell --check-filenames  # Spell checking
uv run --frozen pytest --cov aind_codeocean_dispatch # Tests with coverage

License

This project is licensed under the MIT License - see the LICENSE file for details.