Documentation
This page collects the buyer-facing and user-facing documentation that describes what the current Clear Path release does, how results are exposed, and where follow-on review is still required.
ProductClear Path
Versionv0.1.2
Last updated2026-05-09
Calculation Capabilities
Object top elevation
- Ground elevation MSL plus object height AGL, with a direct object-top-elevation override when the evaluator chooses to use one.
Runway-relative location
- Longitudinal distance from the selected threshold.
- Lateral distance from runway centerline or extended centerline.
- Runway-end orientation tied to the selected threshold for directional surfaces and overlays.
- Inside/outside runway-related footprints where the current rule pack supports a footprint test.
Supported surface evaluations
- Part 77 primary, approach, transitional, horizontal, and conical surfaces as encoded in the active Part 77 rule packs.
- FAA AC approach, departure, and OFZ/ROFA entries where currently encoded; some FAA design criteria remain partial.
- UFC Air Force fixed-wing primary, clear zone, APZ, approach-departure clearance, transitional, inner horizontal, conical, and outer horizontal entries where encoded.
Clearance / penetration outputs
- Allowable elevation at the object location where encoded geometry permits evaluation.
- Object top elevation used by the calculation.
- Clearance amount or penetration amount in feet.
- Geometry notes describing the controlling distance mode used by the surface logic.
Visualization and reporting
- Engineering map view with selected overlays and object marker when geometry is available.
- 3D angled and 3D overhead engineering graphics generated from active evaluator geometry.
- PDF export with project information, input summary, results, source references, and preliminary-use disclaimer.
- Current displayed result states are Violation, Clear, Not Applicable, and Not Evaluated.
- Violation output emphasizes penetration amount, and clear output emphasizes remaining clearance before violation.
- Not Applicable and Not Evaluated remain separate supporting states where geometry or encoded rule coverage does not support a direct yes/no obstruction determination.
Audit Trail and Calculation Transparency
- Project information, airport/runway selection, runway end, and object inputs are preserved in the evaluation state and exported report.
- Each evaluated surface carries geometry notes, input rows, output rows, and source references where the active rule pack provides them.
- Distance mode is exposed through geometry notes such as longitudinal from threshold, lateral from controlling edge, radial from boundary, or footprint-only checks.
- Manual overrides remain visible in the input summary rather than being hidden by auto-filled values.
- Where the code does not expose a formula as literal algebra, the methodology is documented as encoded rule logic rather than reverse-engineered text.
Calculation Transparency
- Each evaluated surface exposes source, applicability, distance method, distance used, slope, formula, and result status.
- Displayed formulas include `D = H × S`, `H = D / S`, object-top-elevation math, allowable-surface-elevation math, and clearance/penetration math when applicable.
- Positive clearance indicates clear conditions, zero clearance is treated as a boundary condition requiring review, and negative clearance indicates penetration/violation.
- Distance methods are surface-specific. Approach logic uses threshold-relative longitudinal distance, transitional logic uses controlling-edge lateral distance, and horizontal/conical logic uses fixed-elevation or radial boundary methods where encoded.
- These calculations remain preliminary and do not replace FAA, DoD, airport-sponsor, local-authority, or licensed engineering determinations.
Integration Readiness
| Topic | Current capability |
|---|---|
| Frontend framework | Next.js 15 with React 19 client/server components. |
| Backend/API | No dedicated backend API layer is included in the current repository. Evaluation runs in-app. |
| State model | Evaluation state is JSON-serializable and can be exported without secrets or environment variables. |
| Current export formats | Known-location evaluations and placement-limit calculations can both be exported as PDF reports and structured JSON, with mode-specific audit content. |
| Deployment patterns | Suitable for web-app deployment, local/internal network hosting, or wrapping in a controlled desktop shell. API-backed deployment would require an added service layer. |
| Embedding | The evaluation flow is component-based and can be integrated into a broader internal web application with additional engineering work. |
Ownership and Licensing
Software ownership, licensing rights, resale rights, and transfer terms are controlled by the applicable development, employment, contract, and licensing agreements. This section should be reviewed and finalized by the owner's legal counsel before commercial sale, licensing, or transfer.
| Field | Placeholder value |
|---|---|
| Product owner | [Owner / Company Name] |
| Company / entity | [Legal Entity Name] |
| Copyright notice | © [Year] [Owner/Company]. All rights reserved. |
| Version | v0.1.2 |
| License model | [Internal use / Commercial license / Enterprise license / Other] |
| Contact email | [contact@example.com] |
| Confidentiality notice | [Confidential / Internal use only / Public release pending legal review] |
Documentation Library
- Quick Start Workflow
- Validation Scenarios
- Definitions / Assumptions
- Source Notes
- Known Limitations
- Commercial Readiness
Change Log
v0.1.2 - 2026-05-09
- Added an internal validation-scenario system with eight structured sample cases.
- Added scenario loading into the evaluator, validation comparison, and JSON validation-summary export.
- Added validation-scenario documentation and local persistence for run results.
v0.1.1 - 2026-05-09
- Added project information fields and report metadata export support.
- Added grouped collapsible result panels to reduce vertical sprawl.
- Added source notes, known limitations, documentation, and commercial-readiness content.
- Added evaluation JSON export and optional PDF technical appendix toggle.
- Corrected surface-specific distance mode logic for non-approach surfaces.
v0.1.0 - 2026-05-01
- Initial packaged Clear Path workflow with evaluator, criteria comparison, engineering views, and PDF export.