Repository navigation
feat: add automated engineering reporting - #12
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
reports/Generated artifacts
reports/BodySimPy_Engineering_Summary.pdfreports/BodySimPy_Management_Summary.pptxReporting inputs
The reporting layer reuses existing BodySimPy analysis outputs, including where available:
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:
Validation
Before committing, the project quality gate was run with:
ruff format --check .ruff check .mypy srcpython -m pytestNext steps
Future reporting improvements may include: