pasys report¶

Generate HTML or Markdown reports from results.

Synopsis¶

pasys report <results> [options]

Description¶

The report command generates formatted reports summarizing trade study results, including statistics, requirement verification, and top designs.

Arguments¶

Argument	Required	Description
`results`	Yes	Path to results file (Parquet or CSV)

Options¶

Option	Short	Default	Description
`--output`	`-o`	Auto	Output file path
`--format`		`html`	Report format: `html`, `markdown`, `md`
`--title`		Auto	Report title

Report Formats¶

HTML¶

Standalone HTML with embedded styling:

pasys report results.parquet --format html -o report.html

Markdown¶

Plain Markdown for documentation:

pasys report results.parquet --format markdown -o report.md
# or
pasys report results.parquet --format md -o report.md

Report Contents¶

Generated reports include:

Executive Summary
Total cases evaluated
Feasible design count
Pareto-optimal count
Requirements Verification
Pass/fail by requirement
Overall compliance rate
Statistics
Metric distributions
Variable ranges
Top Designs
Ranked recommendations
Key metrics

Examples¶

Basic Report¶

pasys report results.parquet
# Creates results.html (HTML by default)

Custom Output¶

pasys report results.parquet -o analysis_report.html --title "Q4 Array Analysis"

Markdown for Documentation¶

pasys report results.parquet --format md -o RESULTS.md

From CSV¶

pasys report results.csv --format html

Auto-Generated Output Path¶

If --output is not specified:

pasys report results.parquet
# Creates: results.html

pasys report results.parquet --format md
# Creates: results.md

Example Output¶

HTML Report Structure¶

<!DOCTYPE html>
<html>
<head>
    <title>Trade Study Report</title>
    <style>/* Embedded CSS */</style>
</head>
<body>
    <header>
        <h1>Trade Study Report: results</h1>
        <p>Generated: 2024-01-15 10:30:00</p>
    </header>

    <section id="summary">
        <h2>Executive Summary</h2>
        <ul>
            <li>Total Cases: 100</li>
            <li>Feasible: 73 (73.0%)</li>
            <li>Pareto-optimal: 12</li>
        </ul>
    </section>

    <section id="requirements">
        <h2>Requirements Verification</h2>
        <table>...</table>
    </section>

    <section id="statistics">
        <h2>Statistics</h2>
        <table>...</table>
    </section>

    <footer>
        <p>Generated by phased-array-systems</p>
    </footer>
</body>
</html>

Markdown Report Structure¶

# Trade Study Report: results

Generated: 2024-01-15 10:30:00

## Executive Summary

- Total Cases: 100
- Feasible: 73 (73.0%)
- Pareto-optimal: 12

## Requirements Verification

| ID | Name | Pass Rate |
|----|------|-----------|
| REQ-001 | Min EIRP | 85% |
| REQ-002 | Max Cost | 92% |

## Statistics

| Metric | Min | Max | Mean |
|--------|-----|-----|------|
| cost_usd | 15,000 | 85,000 | 45,000 |
| eirp_dbw | 32.1 | 52.3 | 42.5 |

---
*Generated by phased-array-systems*

Workflow Example¶

# Complete workflow
pasys doe config.yaml -n 100 -o ./study

# Extract Pareto
pasys pareto study/results.parquet -x cost_usd -y eirp_dbw -o study/pareto.csv

# Generate report
pasys report study/results.parquet --title "Array Trade Study" -o study/report.html

# Open report (macOS)
open study/report.html

Error Handling¶

# File not found
pasys report missing.parquet
# Error: Results file not found: missing.parquet

# Unsupported format
pasys report results.xlsx
# Error: Unsupported format: .xlsx