aind-behavior-curriculum

A core problem in mice training is accurately keeping track of each mouse's training stage and accurately setting the corresponding rig parameters. As the number of behavior studies, research assistants, and mice increase, manual tracking and parameter input is prone to human error. This library provides a flexible framework for defining mice curriculum enabling mouse training to be automated.

Warning

This library is still in development. Expect breaking changes in future releases.

Installation

pip install aind-behavior-curriculum

Documentation

The full documentation is available at https://aind-behavior-curriculum.readthedocs.io/en/latest/

Contributing

Issues and Bugs

If you find any issues or bugs, please open an issue on GitHub

Suggesting changes and Pull Requests

If you would like to suggest changes or contribute to the project, please open a pull request on GitHub. Attempt to open a pull request that is scoped to a single issue or feature to make the review process easier.

Dependencies and lockfile

This project uses uv for dependency management and lockfile generation.

You can create a new environment with:

uv venv

or run standalone commands with:

uv run <command>

Linting

This project uses:

ruff for linting. To lint the project, run the following commands:

ruff format .
ruff check .

interrogate for documentation analysis:

interrogate --verbose .

and codespell for spell checking:

codespell .

Testing

The project uses unittest for testing and coverage for coverage analysis.

coverage run -m unittest
coverage report