Skip to content

Getting Started

Prerequisites

  • Python 3.13+
  • uv (package manager)
  • Node.js 20+ and pnpm (for the frontend)

Datasets

Before running the framework, you need datasets. See Dataset Setup for download and configuration instructions.

Backend Setup

# Create virtual environment and install dependencies
uv venv && uv sync

# Run the API server
uv run wire-tune

The server starts on http://localhost:8000.

Frontend Setup

In a separate terminal:

cd ui
pnpm install
pnpm dev

The frontend starts on http://localhost:3000 and proxies API requests to the backend.

Docker (Both Services)

docker compose down && docker compose up --build

Verify Installation

# Run tests
uv run pytest wire_detection/tests/ -q

# List available pipeline stages
curl http://localhost:8000/api/stages

# List datasets
curl http://localhost:8000/api/datasets

Next Steps