Skip to content

Development Setup

Set up Flux for local development.

Prerequisites

  • Python 3.10+
  • CUDA 12.0+ (optional for GPU development)
  • Git

Clone Repository

git clone https://github.com/flux-team/flux.git
cd flux

Create Environment

python -m venv .venv
source .venv/bin/activate  # Linux/macOS
# or .venv\Scripts\activate  # Windows

Install Dependencies

# Dev dependencies
pip install -e ".[dev,test,docs]"

# Pre-commit hooks
pre-commit install

Verify Installation

# Run tests
pytest tests/unit/ -v

# Run linting
ruff check .

# Type checking
mypy flux/

Development Workflow

  1. Create a branch: git checkout -b feature/my-feature
  2. Make changes
  3. Run checks: ruff check . && pytest
  4. Commit: git commit -m "feat: add feature"
  5. Push and create PR

See Also