Skip to content

quickstart.md

Latest commit

 

History

History
66 lines (44 loc) · 1.61 KB

quickstart.md

File metadata and controls

66 lines (44 loc) · 1.61 KB
Raw

Quickstart

Use this guide to set up the analytics workspace, inspect the CLI, run the basic local checks, and try the current sample-data workflow without backend or S3 credentials.

Prerequisites

  • Python 3.12 or 3.13
  • uv

Install the workspace

make setup

This installs the locked workspace and local pre-commit Git hooks.

Inspect the CLI

uv run pyro-analytics --help

Run the test suite

uv run pytest

Publish from sample data

The CLI calls this source fixture because it reads a checked-in sample file.

uv run pyro-analytics pyromap publish --source fixture --fixture-path packages/pyromap/tests/fixtures/api-cameras.json --output camera-cells.geojson

This writes camera-cells.geojson, a public GeoJSON artifact that groups cameras into deterministic H3 cells.

Run the Prefect flow locally

uv run pyro-analytics pyromap orchestrate --source fixture --fixture-path packages/pyromap/tests/fixtures/api-cameras.json --output camera-cells.geojson

This runs the same publication behavior through the Pyromap Prefect flow.

Build the documentation

make build-docs

This regenerates the package reference before writing the built site to docs/_build/html.

Where to go next

  • Sources explains the reusable dlt source package.
  • Pyronear API documents the backend camera source contract.
  • Pyromap explains the camera map workflow.
  • Contracts define stable behavior for map consumers.
  • Runbooks cover operational publishing tasks.