mus-musculus-tracker 0.1.1

A YOLO-based tool for ROI cropping and movement tracking of Mus musculus.

Mus Musculus Tracker 🐁

A professional YOLO-based tool designed for automated detection, Region of Interest (ROI) cropping, and movement tracking of mice (Mus musculus) in a circular arena.

📋 Features

• Automated Detection: Powered by YOLO (v.12) for robust animal identification.
• Smart ROI Cropping: Automatically crops video borders to focus on the arena/cage.
• Trajectory Tracking: Extracts movement data and tracking coordinates.
• CLI Ready: Easy-to-use Command Line Interface for batch processing.

🚀 Installation

Via Pip (Recommended)

You can install the tracker directly from PyPI:

pip install mus-musculus-tracker

Via Conda (For Development)

To set up a development environment, use the provided environment.yml:

gh repo clone juancolonna/mouse-tracker
cd mouse-tracker
conda env create -f environment.yml
conda activate mouse-tracker
pip install mouse-tracker

🛠 Usage

Once installed, the mouse-track command will be available in your terminal. To start tracking on a video file, simply run:

mouse-track path/to/your/video.mp4

📑 Requirements

Python: >= 3.13

Main Dependencies:

ultralytics (YOLO)

opencv-python

moviepy

tqdm

✍️ Authors

Juan G. Colonna [e-mail]

📄 License

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