FHOPS

Getting Started

  • Overview
    • Motivation
    • Automation pipeline
    • Installation
    • Quick demo
    • Baseline Workflows
  • Quickstart
    • Bootstrap Environment
    • Workbench: examples/tiny7
    • Regression Fixture (Phase 1 Baseline)
    • Rolling horizon loop (playback + KPIs)
    • Shift-enabled scenarios
  • Tree-Scale Workflow
    • Synthetic fixture
    • Run the complete path
    • Outputs
    • Fail-closed behavior
    • Limits
  • Nemora Tree-Inventory Handoff
    • Fixture
    • Boundary
  • Data Contract Guide
    • Reference dataset generator
    • Core Tables (CSV)
    • Cross References & Validators
    • Optional Extras
    • Timeline Example
    • Shift Calendars & Defaults
    • Schedule Locking
    • Initial State (Resuming Mid-Operation)
    • Compatibility with FHOPS 1.0.0
    • GeoJSON Ingestion & Distances
    • Machine-Rate Defaults & Costing Helper
    • Road Construction Tables & Validation
    • Skyline Stand Profiles
    • Log Hauling Extension
    • LidarBC Products
    • Tree Inventories
    • Authoring Checklist
    • Fixture Gallery
  • Benchmarking Harness
    • Quick Start
    • CLI Options
    • Watching heuristic progress
    • FAQ – Watch Mode
    • Standard Manuscript Pipeline
    • Optional Gurobi backend (Linux)
    • Interpreting Outputs
    • Comparing MIP and heuristic objectives
    • Shared KPI roll-up
    • Operator Telemetry
    • Visual Comparisons
    • Regression Fixture
    • Future Work
  • Heuristic Presets & Registry Guide
    • Shared Solver Cheat Sheet
    • Preset Overview
    • Applying Presets
    • Explicit Overrides
    • Solver-Specific Parameters
    • Parallel & Advanced Features
    • Operator Catalogue
    • Telemetry & Benchmarking
    • Objective Weights, Automatic Overrides, and Hard Violations
    • Next Steps
  • Operational MILP Warm Starts
    • Workflow
    • Solver support
    • Solve outcomes
    • Current limitations
    • Practical guidance
    • Future work
  • Operational MILP Formulation
  • Parallel Heuristic Workflows
    • Multi-start Runs
    • Batched Neighbour Evaluation
    • API Reference
    • Profiling Notes
  • Evaluation Workflows
    • Running deterministic playback
    • Optional flags
    • Reporting templates
      • Parquet and Markdown exports
    • Quickstart example
    • Aggregation helper reference
    • KPI formulas & required signals
      • Empty and partial plans
      • Weather & downtime cost assumptions
      • Stochastic playback toggles
      • Stochastic event semantics
    • Relationship to KPI evaluation
  • Thesis Evaluation Workflow (Chapter 2)
    • Context & Goals
    • Pipeline Overview
    • Worked Example (med42 Template)
    • Tips & References
  • 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
      • history_summary.html ― trend radar
      • latest_history_summary.{html,md,csv} ― current leaderboard
      • latest_tuner_report.{html,md,csv} ― raw per-algorithm stats
      • latest_tuner_comparison & latest_tuner_leaderboard
      • tuner_difficulty*.{html,md,csv}
      • Adding new dashboard assets
      • Release candidate presets
    • Automated Sweeps
      • Parallel execution
      • Benchmark plans
    • Notebook execution cadence
    • Heuristic parameter catalogue
    • Convergence metrics
      • Tuner metadata summary
    • Bundle Aliases
    • CI Automation
    • Downloading CI Reports
  • Telemetry Ops Runbook
    • Weekly Notebook Pipeline
    • Telemetry Store Maintenance
    • Automation Checklist
    • Runbook Template (per week)
    • References
  • Release & Contribution Playbook
    • Release Preparation
    • Contribution Checklist
    • Where to Update Next
  • Synthetic Datasets
    • Reference bundles
    • Fleet roles and harvest systems
    • Block enrichment, crews, and blackouts
    • CLI walkthrough
    • Regenerating bundles
    • Where to go next
  • Harvest System Sequencing How-to
    • Configuring Scenarios
    • Sequencing Semantics
      • Locks and the operational MILP
    • Running the Solvers
      • MIP
      • Simulated Annealing
    • Inspection & KPIs
    • Benchmarking with Sequencing
    • Troubleshooting
  • Iterated Local Search How-to
    • Basic Usage
    • Telemetry
    • Benchmarks
  • Tabu Search How-to
    • Basic Usage
    • Telemetry
    • Benchmarks
  • Rolling-Horizon Planning
    • When to use
    • Key parameters
    • How state carries between windows
    • MILP windows: earliness tie-break
    • Windows without a plan
    • CLI usage
    • Worked example (tiny7)
    • Outputs
    • MILP example with solver options
    • Evaluating rolling plans
      • Empty rolling plans and baselines
    • Rolling comparison helper
    • MASc experiments & plots
    • Sample artefacts
    • Artefact provenance & regeneration
    • Gotchas
    • Notes
    • Limitations
  • 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
  • Salvage Shelf-Life and Wood Degradation
    • Sources and boundaries
      • Retention curve
      • Product windows
    • Quick start
    • Output columns
    • Adding another curve
    • Python API
    • Limits
  • Log Hauling
    • Schema version
    • Minimal example
    • Marine and barge legs
    • Entity rules
    • Contractor eligibility
    • Units and defaults
    • Phase I solve
    • Phase II schedule
    • Phase III simulated annealing
    • CLI
    • Stable artefacts
    • Operational and tactical handoff
    • Scale case
    • Limitations
    • See also
  • Hydrology Quickstart — FEMIC to WS4 to FHOPS
    • Version Matrix
    • Build the Synthetic Workspace
    • WS4 Landscape Screening
    • FHOPS Consumer and Operational Check
    • What This Demonstrates
    • What This Does Not Prove
    • Docs Check
    • Troubleshooting
    • Further Reference
  • FHOPS Web UI
    • Shell and navigation
    • Install and run
    • Run discovery
    • Run manifest
    • Service surface
    • Map and layers
    • Domain panels
    • Live runs
    • Scenario editing
    • Skins
    • Assistant
    • Security and limits
  • FHOPS serious game
    • Levels
    • Prerequisites
    • Start the service
    • How a round works
    • Scoring
    • Optional agent
    • Regenerate assets
    • Caveats

Reference

  • API Reference
    • fhops Package
    • fhops.scenario Package
      • Quickstart
    • fhops.scheduling Package
      • BlackoutWindow
      • ShiftDefinition
      • TimelineConfig
      • BlockDistance
      • MachineMobilisation
      • MobilisationConfig
      • build_distance_lookup()
      • HarvestSystem
      • SystemJob
      • default_system_registry()
      • get_system_road_defaults()
      • system_productivity_overrides()
    • fhops.optimization Package
      • Deprecated legacy MIP (1.0.1, #127)
    • fhops.evaluation Package
      • DaySummary
      • DowntimeEvent
      • DowntimeEventConfig
      • EnsembleResult
      • KPIResult
      • LandingShockConfig
      • LandingShockEvent
      • PlaybackConfig
      • PlaybackEvent
      • PlaybackRecord
      • PlaybackResult
      • PlaybackSample
      • SamplingConfig
      • SamplingContext
      • SamplingEventConfig
      • ShiftSummary
      • WeatherEvent
      • WeatherEventConfig
      • assignments_to_records()
      • compute_kpis()
      • compute_makespan_metrics()
      • compute_utilisation_metrics()
      • day_dataframe()
      • day_dataframe_from_ensemble()
      • export_playback()
      • machine_utilisation_summary()
      • playback_summary_metrics()
      • render_markdown_summary()
      • run_playback()
      • run_stochastic_playback()
      • schedule_to_records()
      • shift_dataframe()
      • shift_dataframe_from_ensemble()
      • summarise_days()
      • summarise_shifts()
    • fhops.planning Package
      • Solver options (MILP)
    • fhops.salvage Package
      • Why this module exists
      • DEFAULT_CURVE_ID
      • DecayCurve
      • DecayCurveLibrary
      • DecayCurvePoint
      • DecayCurveSource
      • ProductWindow
      • get_decay_curve()
      • load_decay_library()
      • REQUIRED_STORAGE_COLUMNS
      • SalvageReport
      • build_salvage_report()
      • write_salvage_report()
    • fhops.hauling Package
    • fhops.web Package
    • fhops.planning.tactical_operational Package
      • BlockRoadAccess
      • Economics
      • ExternalSupply
      • Facility
      • FacilityDemand
      • FleetCapacity
      • FleetOption
      • HarvestSystemOption
      • InitialInventory
      • PeriodLevel
      • PlanningPeriod
      • PlanningUnit
      • Product
      • RoadDependency
      • RoadProject
      • SilvicultureTransition
      • TacticalOperationalScenario
      • TransportArc
      • children_by_parent()
      • four_week_periods()
      • load_tactical_operational_scenario()
      • seasonal_periods()
      • tactical_scenario_dimensions()
      • tactical_scenario_to_dict()
      • validate_period_hierarchy()
    • fhops.model.milp.tactical_operational Module
      • DemandBasis
      • TacticalHarvestMode
      • TacticalOperationalMilpBundle
      • TacticalOperationalMilpConfig
      • build_tactical_operational_bundle()
      • build_tactical_operational_model()
      • solve_tactical_operational_milp()
      • tactical_bundle_from_dict()
      • tactical_bundle_to_dict()
  • CLI Reference
    • solve-mip (deprecated alias) outcomes and exit codes
    • Heuristic configuration reference
    • Dataset command cheat sheet
    • Log-hauling commands
    • Web commands
  • Aggregation Helpers
    • API summary
      • day_dataframe()
      • day_dataframe_from_ensemble()
      • machine_utilisation_summary()
      • shift_dataframe()
      • shift_dataframe_from_ensemble()
  • Harvest System Registry
    • Data Model
    • Default Systems
    • Using the Registry
    • Scenario Cross-Links
    • Extending Systems
    • Preset Usage Cheat Sheet
      • Forwarder Productivity
      • Grapple Skidder & Shovel Logger Productivity
      • Skyline & Helicopter Productivity
    • Forwarder Productivity Models
    • Roadside Processor Productivity Models
      • Landing processor and loader coverage cheat sheet
    • Optional Dataset Cookbook
      • Med42 / Large84 cost overlays
      • Partial-cut / mixed system assignments
      • Road construction add-ons
    • Burned-Timber Salvage Guidance (ADV1N5)
    • Loader-Forwarder Productivity Models
      • Loader harvest-system overrides
      • Coordinating with forwarder / skidder models
    • Grapple Skidder Productivity Models
    • Grapple Yarder Productivity Models
      • Grapple harvest-system presets
    • Shovel Logger (Hoe-Chucker) Productivity
    • Skyline Productivity Models
      • TR-127 predictor ranges
    • Skyline cost matrix
      • TN-258 / FNCY12 support utilisation
      • Partial-cut profile registry
    • Road & Subgrade Construction References
    • Handfalling Cost Reference
    • CTL Harvester Productivity Models
  • fhops.hauling Package
    • Key models
    • Example
  • Log-Hauling Formulation
    • Phase I: monthly daily flows
    • Phase II: daily truck and loader scheduling
    • Phase III: simulated annealing
    • Implementation notes and corrections
  • fhops.web Package
    • Key objects
    • CLI
  • Telemetry Logging
    • Schema
      • Example
      • Solver-specific fields
    • Usage Notes
    • CLI Reporting
    • Historical Trends
  • Live Dashboards
    • Embedded previews
  • Source Bibliography and Document Access
    • Public bibliography
    • Private full-text vault
  • FEMIC LidarBC Products
    • Bundle Contract
    • Python Usage
    • Scenario Pin and Support
    • Operability Report
    • Operator Workflow
    • Shared Parity
    • Phase Close-Out
  • TFL 6 LidarBC Fixture
    • What It Exercises
    • Terrain And Canopy Evidence
    • Files
    • Commands
    • Regeneration
    • Parity And Limits
  • FEMIC Hydrology Response Bundles
    • Bundle Contract
    • Python Usage
    • Readiness
    • Scenario Pin
    • Support Mapping
    • Schedule-Bound Exposure
    • Screening
    • CLI
    • Limits
    • Operational Hazard Windows
    • Road and Culvert Assets
    • Operational Constraint Check
    • End-to-End Path
    • Solver Boundary
    • Operational End-to-End Path
  • Hydrology Contract and Schema Index
    • Contract Layers
    • FEMIC Producer Contracts
    • WS4 Landscape Consumer Contracts
    • FHOPS Operational Consumer Contracts
    • Shared Exposure Contract
    • Failure Matrix
    • What Is Not a Contract
    • Version Compatibility
  • Tree Inventory Contract
    • Inventory Format
    • Scenario Pin and Block Map
    • CLI
    • Fixture
    • Limits
  • Stem Volume and Bucking
    • Reference Model
    • Python API
    • CLI
    • Limits
  • Single-Machine Tree Simulation
    • Model
    • CLI
    • Limits
  • Tree-Scale Schedule Replay
    • Input
    • CLI
    • Limits
  • Tree Scene Export
    • What is exported
    • CLI
    • Limits
  • Ground-Based System Simulation
    • Command
    • Outputs
    • Determinism and invariants
    • Limits
    • Committed example

Examples

  • Stochastic Robustness Walkthrough
    • Prerequisites
    • Code Walkthrough
    • Interpretation
    • Next Steps
  • Analytics Notebooks
    • Playback Walkthrough
      • Production by Day
    • Stochastic Robustness Explorer
      • Production Distribution
    • What-If Scenario Tweaks
      • Adjusted Sampling
    • Landing Congestion Analysis
      • Baseline Ensemble Snapshot
      • Landing Shock Ensemble Snapshot
      • KPI Comparison
      • Production Distributions
    • Harvest System Mix Explorer
      • System Mix Metadata
      • Machine Roles in Scenario
      • Generate Custom Mix
      • Role Comparison
    • KPI Decomposition Deep Dive
      • Scenario Overview
      • Production vs Mobilisation
      • Sequencing & Downtime
      • Visualise Utilisation
    • Ensemble Resilience Comparison
      • Production Distributions
      • Downtime Summary
    • Operator/Benchmark Sweep
      • Objective Comparison
      • Runtime Comparison
    • Telemetry & Solver Diagnostics
      • Objective Trace
      • Acceptance Summary
    • Telemetry Report Comparison
      • Setup
      • Load Reports
      • Visualize Best Objectives
      • Delta Table
      • Machine-Cost Summary Pivot
      • Machine-Cost Trend Chart
      • Compare Against Historical Summary
      • Repair-Usage Alerts
    • Telemetry History Analysis
      • Load History Snapshot
      • Compute Deltas
      • Visualize Trends
      • Next Steps
    • Benchmark Summary Notebook
      • Objective vs Scenario
      • Runtime Overview

Project Processes

  • Contributing
    • Developer onboarding
    • Command cadence (local loop)
    • Common pitfalls
    • Debugging and profiling
    • Re-running published artefacts
  • Roadmap Summary
  • Mobilisation Geospatial Workflow
    • Command Examples
    • Tooling Notes
    • Troubleshooting & Diagnostics
  • Productivity Catalog Gaps
    • Arnvik Appendix 8 scope
    • Implications
    • Forwarder equation stack (BC roll-out)
      • Sources in hand
      • Caveats and pending confirmations
FHOPS
  • Python Module Index

Python Module Index

f
 
f
- fhops
    fhops.evaluation
    fhops.evaluation.playback.aggregates
    fhops.model.milp.tactical_operational
    fhops.optimization
    fhops.planning.tactical_operational
    fhops.salvage.degradation
    fhops.salvage.report
    fhops.scenario.synthetic
    fhops.scheduling.mobilisation
    fhops.scheduling.systems
    fhops.scheduling.timeline

© Copyright 2026, UBC FRESH Lab.

Built with Sphinx using a theme provided by Read the Docs.