Skip to main content

Terragraph Planner Runbook

This document demonstrates how to run a plan using the Terragraph Planner software and provides an introduction to its features.

In order to create a plan, users must gather information about the future (or existing) installation, the neighborhood it is in, and enter this information as input files and plan parameters. The planner will then generate a network topology from which various metrics are computed such as network connectivity, throughput and cost of construction.

Table of Contents

  1. Quick Start
    1. Download
    2. Install
    3. Set up FICO Xpress
    4. Run Tests
    5. Run a Plan
  2. Input Files
    1. Boundary Polygon File
    2. GeoTIFF Files
    3. User Input Site File
    4. Building Outline File
    5. Candidate Topology File
    6. Base Topology File
  3. Output Files
    1. Topology KML File
    2. Reporting CSV Files
    3. Debugging Files
  4. Features
    1. Multi-SKU
    2. Automatic Site Detection
    3. Demand Models
    4. Tiered Service
    5. POP Placement
    6. Maximum Common Bandwidth
    7. Extend Base Topology