Installation

Requirements

• Python 3.8 or higher
• pip

Install from Source

1. Clone the repository:

git clone https://github.com/sdhutchins/labrat.git
cd labrat

1. Install the package:

pip install .

For development mode:

pip install -e .

Install Dependencies

Install all required dependencies:

pip install -r requirements.txt

Install Documentation Dependencies

To build and serve the documentation locally:

pip install -e ".[docs]"

Or install manually:

pip install mkdocs-material mkdocs-click mkdocstrings[python] pymdown-extensions

Verify Installation

Run the tests to verify everything is working:

pytest tests/