FHOPS Documentation
Welcome to the Forest Harvesting Operations Planning System (FHOPS) docs. These pages explain the platform architecture, data contract, optimisation stack, heuristics, and evaluation workflows. The structure mirrors our roadmap so that implementation status stays transparent.
The executed analytics notebook suite (Analytics Notebooks) demonstrates end-to-end
playback, stochastic robustness, and benchmarking stories. The notebooks run in CI with the
FHOPS_ANALYTICS_LIGHT=1 flag to keep stochastic samples lightweight; unset it locally for full
ensembles.
Getting Started
- Overview
- Quickstart
- Data Contract Guide
- Reference dataset generator
- Core Tables (CSV)
- Cross References & Validators
- Optional Extras
- Timeline Example
- Shift Calendars & Defaults
- Schedule Locking
- GeoJSON Ingestion & Distances
- Machine-Rate Defaults & Costing Helper
- Road Construction Tables & Validation
- Skyline Stand Profiles
- Authoring Checklist
- Fixture Gallery
- Benchmarking Harness
- Heuristic Presets & Registry Guide
- Operational MILP Warm Starts
- Operational Optimization Formulation
- Parallel Heuristic Workflows
- Evaluation Workflows
- Thesis Evaluation Workflow (Chapter 2)
- Telemetry-Driven Tuning
- Prerequisites
- Step 1 – Collect Telemetry
- Step 2 – Generate a Comparison Report
- Sample Output
- Step 3 – Iterate
- Step 4 – Compare Multiple Reports
- Historical Trends
- Delta Snapshot Summary
- Interpreting Dashboards
- Automated Sweeps
- Notebook execution cadence
- Heuristic parameter catalogue
- Convergence metrics
- Bundle Aliases
- CI Automation
- Downloading CI Reports
- Telemetry Ops Runbook
- Release & Contribution Playbook
- Synthetic Datasets
- Harvest System Sequencing How-to
- Iterated Local Search How-to
- Tabu Search How-to
- Rolling-Horizon Planning
- Tactical–Operational Scenario Contract
- Canonical formulation
- Loading and validation
- Period templates
- Core MILP formulation
- Optional infrastructure modules
- Scenario overlays, diffs, and batch reports
- Tactical-to-operational handoff
- Scale benchmarks and uncertainty envelopes
- Practitioner-scale validation case
- Guided tactical planner notebook
- topm-mini acceptance fixture
Reference
- API Reference
- CLI Reference
- Aggregation Helpers
- Harvest System Registry
- Data Model
- Default Systems
- Using the Registry
- Scenario Cross-Links
- Extending Systems
- Preset Usage Cheat Sheet
- Forwarder Productivity Models
- Roadside Processor Productivity Models
- Optional Dataset Cookbook
- Burned-Timber Salvage Guidance (ADV1N5)
- Loader-Forwarder Productivity Models
- Grapple Skidder Productivity Models
- Grapple Yarder Productivity Models
- Shovel Logger (Hoe-Chucker) Productivity
- Skyline Productivity Models
- Skyline cost matrix
- Road & Subgrade Construction References
- Handfalling Cost Reference
- CTL Harvester Productivity Models
- Telemetry Logging
- Live Dashboards
- Source Bibliography and Document Access
Project Processes