engineering-calc-report
Installation
SKILL.md
Engineering Calculation Report
Workflow
- Collect the calculations. Gather them from the conversation, attached scripts or spreadsheets, or outputs of other skills (
machine-element-sizing,quick-fea,thermal-fluids-calc). Re-run every number in code. Never copy a figure without recomputing it. - Unit-check everything with
pint, usingscripts/calc_template.pyas the pattern. Each equation's result should carry units, and the script fails on any dimensional mismatch. - Write the report in this structure (see
references/report_structure.md):- Header block: title, document number, revision, project, author, checker (blank), date
- Objective: one paragraph on what is being shown and against what criterion
- Summary of results: a table of each check with its value, allowable, margin, and PASS/FAIL. This is the first thing a reviewer reads.
- Inputs: a table with value, unit, and source (drawing number, datasheet, standard, assumption)
- Assumptions: numbered, each with a justification and a note on whether it's conservative
- Method and calculations: each step gives the equation in symbols (LaTeX), substituted values, result with units, and a reference (textbook eq. number or standard clause)
- Discussion: sensitivity to key assumptions, limitations
- Conclusions and recommendations
- References
- Appendix: the script or code used
- Margins. Report MS = allowable / (applied × FoS) − 1. A negative MS fails. State the factor of safety basis (code, customer, or company standard).
- Format. Use the Docs artifact type by default. If the user wants a file, produce docx (docx skill) or PDF/LaTeX (pdf skill). Equations go in LaTeX.
- Self-check before delivery: every input has a source; every assumption is used somewhere; the summary-table numbers match the body; units appear on every number.