Skip to content

feat: add automated engineering reporting - #12

Merged
savbcar merged 1 commit into
mainfrom
feat/automated-reporting
Aug 15, 2026
Merged

savbcar merged 1 commit into
mainfrom
feat/automated-reporting

Conversation

@savbcar

@savbcar savbcar commented Aug 15, 2026

Copy link
Copy Markdown
Owner

Summary

This PR adds automated engineering and management reporting to BodySimPy.

The new reporting workflow converts existing simulation and analysis results into concise PDF and PowerPoint summaries that can be understood without reading the Python source code.

What this PR adds

  • automated engineering-summary PDF generation
  • automated management-summary PowerPoint generation
  • centralized extraction of reporting metrics from existing validation datasets
  • reporting of:
    • objective
    • methodology
    • baseline configuration
    • key results
    • sensitivity
    • risk and limitations
    • engineering recommendations
  • graceful handling of unavailable result data
  • generated output structure under reports/

Generated artifacts

  • reports/BodySimPy_Engineering_Summary.pdf
  • reports/BodySimPy_Management_Summary.pptx

Reporting inputs

The reporting layer reuses existing BodySimPy analysis outputs, including where available:

  • static FEA mesh-convergence results
  • analytical-vs-FEA validation metrics
  • modal frequencies
  • stochastic stress results
  • ML surrogate validation metrics

Engineering intent

The goal is to separate detailed engineering implementation from decision-oriented communication.

The PDF provides a compact engineering summary, while the PowerPoint presents the same project at a higher management level.

This allows BodySimPy to demonstrate not only simulation automation and data analysis, but also the ability to translate technical results into concise engineering communication.

Limitations

The reports explicitly preserve the limitations of the current BodySimPy model:

  • simplified automotive structural surrogate
  • idealized boundary conditions
  • beam-based structural representation
  • generic material assumptions
  • not representative of proprietary or production vehicle geometry
  • ML results are valid only within the sampled design domain

Validation

Before committing, the project quality gate was run with:

  • ruff format --check .
  • ruff check .
  • mypy src
  • python -m pytest

Next steps

Future reporting improvements may include:

  • automatically embedding validation and sensitivity plots
  • comparison tables between baseline and design variants
  • traffic-light engineering risk indicators
  • automated executive recommendations based on validated thresholds
  • richer presentation styling and architecture diagrams

@savbcar
savbcar merged commit 0477fde into main Aug 15, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant