🗒️ Documenting a Run (Notes) - heinsch-fa/behave-app GitHub Wiki

📖 In This Section

  • Core Objective: Document core run assumptions, describe results, and compile structured PDF report appendices.
  • Estimated Reading Time: 3 minutes.
  • Prerequisites: Complete your calculation checks on the 📊 Reviewing, Mapping, & Shading Results dashboard.

🧭 Functional Overview

Documentation is a critical part of any fire behavior run. In Behave7, the traditional comment fields are replaced by a centralized Notes framework. Notes allow you to record operational limitations and environmental assumptions directly within the workflow. They track with your active data file and attach cleanly to your final hardcopy printouts.

[!Note] 💡 Key Workspace Capability: You can add notes to a tab even if you have not selected any outputs or inputs for that specific category yet.

🛠️ Step-by-Step Instructions

1️⃣ Creating and Categorizing a Local Note

Attach a custom observation log to your active workspace module.

  • Action Required: Click the + Show Notes button located at the top of any configuration page
  • Action Required: Click + Add Notes inside the target tab panel.
  • Action Required: Choose a descriptive group from the dropdown list. Available categories dynamically change depending on your active Run Type.
  • Action Required: Type your tracking context into the free-form text box, then click Save.

2️⃣ Modifying or Editing Existing Comments

Correct text errors or add real-time field observations without breaking your calculations.

  • Action Required: Locate your Notes at the top of every active workflow page.
  • Important Detail: Notes are fully editable across any step of the calculation chain, including the Review Inputs, Review Run, and Results pages.

3️⃣ Exporting the Final PDF Documentation Report

Assemble your final data outputs and attached text notes into a clean, sharing-ready summary document.

  • Action Required: From the final Results page, click the global Print button in the upper-right corner of the window.
  • Important Detail: The generated PDF functions as a complete standalone audit trail. It automatically structures your inputs table, output tables, charts, and chronologically appends your saved Notes directly to the top of the appendix layout.

🖼️ User Interface Reference

🔍 Active Results Page Layout

  • + Show Notes Button: Expands the central text module directly above your downloaded CSV file rows, data tables, and active graphics.

🔗 Related Resources