Brushline

Brushline is a pre-alpha decision-support prototype for vegetation management along linear infrastructure corridors: powerlines, pipelines, roads, railways, and the rights-of-way that keep them accessible and safe.

It couples a low-vegetation state-transition model, strategic/tactical/operational planning, scenario and recourse experiments, a planning studio, and artifact contracts. It is a working research prototype, not a field-calibrated operational system.

Who this documentation is for

Reader

Start here

What you will learn

New user

Getting started

Install the package, run the synthetic fixture, and read a first study.

Analyst or planner

Concepts and How-to guides

The model, the planning stack, uncertainty/recourse, and the private network workflow.

Reviewer or asset owner

Limitations and boundaries

What the prototype does and does not claim, and which results are private or synthetic.

LLM coding agent

AGENTS.md, Contract index, and API reference

The contracts, invariants, and commands to respect when changing the repository.

Start with the synthetic example

The public path needs no private data:

brushline fixture --out tmp/corridor
brushline prototype --fixture tmp/corridor --out tmp/prototype --years 5
brushline demo build --out build/demo
python -m http.server 8000 --directory build/demo

The private BC network prototype is a separate workflow. It requires the cached network artifacts under runtime/private/ and must not be published before approval. See Build the network prototype and Private and public boundaries.

Documentation map

Section

Contents

Getting started

Installation, quickstart, and a first study.

Concepts

The model, planning stack, uncertainty/recourse, and artifact/privacy model.

How-to guides

Network build, planning brief, studio, and release audit.

Guides

Limitations, private/public boundaries, and troubleshooting.

Reference

Contracts, methods, policy experiments, and artifact records.

Design record

Scope, architecture, optimization, UI, LiDAR, and decision records.

API reference

Public Python API, grouped by domain.

The reference section mixes contracts (which the code validates) with experiment records (which report prototype results). Do not treat a benchmark page as a contract or a contract page as evidence of field performance. The reference index says which is which.

What this documentation is not

  • It is not a public release of BC Hydro, MKRF, or other private network data.

  • It is not a field validation report, safety certification, or asset-owner standard.

  • It does not turn a sampled scenario result into a distributional guarantee.

  • It does not call a heuristic search state a globally optimal plan.

Getting started

Concepts

How-to guides

Guides

Indices and tables