Installation¶

Prerequisites¶

Python 3.11 or higher
uv package manager (recommended) or pip
git-lfs (for accessing dummy datasets)

Quick Install¶

Using uv (Recommended)¶

# Clone the repository
git clone https://github.com/yourusername/cobrabox.git
cd cobrabox

# Install git-lfs and pull large files
git lfs install
git lfs pull

# Install dependencies and set up the environment
uv sync

Using pip¶

pip install -e .

Development Setup¶

For development, install with dev dependencies:

uv sync --group dev

Install pre-commit hooks:

uv run pre-commit install

Verify Installation¶

Run the test suite:

uv run pytest -q

Try a quick example:

uv run python examples/feature_pipeline_demo.py

Optional: Documentation Dependencies¶

To build the documentation locally:

uv sync --group docs

Then serve the docs:

uv run mkdocs serve

Troubleshooting¶

git-lfs issues¶

If you see placeholder files instead of actual data:

git lfs install
git lfs pull

Python version¶

Check your Python version:

python --version

CobraBox requires Python 3.11+.