swmm-report

Solid

Generate a client-deliverable Word (.docx) report from an audited SWMM run directory. Reads manifest.json, experiment_provenance.json, model_diagnostics.json, comparison.json, and any PNG figures — SWMM is never re-run. Supports custom YAML/JSON section templates.

Data & Documents 21 stars 9 forks Updated 3 days ago MIT

Install

View on GitHub

Quality Score: 78/100

Stars 20%
45
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# SWMM Report Export Skill ## Purpose Assemble a reproducible, client-deliverable Word (.docx) report from the artifacts produced by `swmm-experiment-audit` and `swmm-plot`. The script reads only existing files; it never re-runs SWMM or modifies the run directory. **Prerequisite:** the run directory must contain a `09_audit/` subdirectory with at least `experiment_provenance.json`. Run `aiswmm audit --run-dir <path>` first if that directory is absent. --- ## CLI usage ```bash # Standalone script python3 skills/swmm-report/scripts/generate_report.py \ --run-dir <path> # required: audited run directory [--out <path.docx>] # default: <run-dir>/report.docx [--template <path>] # YAML or JSON template (default: built-in) # CLI verb (registered in aiswmm CLI) aiswmm report --run-dir <path> [--out <path.docx>] [--template <template.yaml>] ``` Exit codes: `0` = success; `1` = missing dependency, missing audit dir, or template error; `2` = argument error. **python-docx dependency:** install with `pip install 'aiswmm[report]'`. The script exits immediately with a clear message if python-docx is absent. --- ## Agent tool: `generate_report` Registered in `AgentToolRegistry`. Direct handler (not MCP-routed) — shells out to `generate_report.py`, writes `<run-dir>/report.docx` (or the path supplied via `out`). ``` generate_report(run_dir="runs/my_run/") generate_report(run_dir="runs/my_run/", out="deliverables/run_report.docx") generate_report(ru...

Details

Author
Zhonghao1995
Repository
Zhonghao1995/agentic-swmm-workflow
Created
5 months ago
Last Updated
3 days ago
Language
Python
License
MIT

Similar Skills

Semantically similar based on skill content — not just same category

AI & Automation Solid

swmm-experiment-audit

Consolidate Agentic SWMM run artifacts into auditable provenance, comparison records, and local Obsidian audit notes. Use after any SWMM build/run/QA attempt, successful or failed, when an agent or CLI workflow needs a traceable record of inputs, commands, artifacts, metrics, QA checks, run-to-run differences, and first-user-friendly Obsidian visualization.

21 Updated 3 days ago
Zhonghao1995
AI & Automation Solid

swmm-design-review

Score a completed SWMM run against a configurable YAML rulebook of design checks — GB50014-style standards for real catchments, or the reference-free physical-plausibility rulebook for synthesized networks. Reads the run's existing manifest.json / model.rpt / model.inp and never re-runs SWMM. Use it post-run for compliance or plausibility review; continuity gating stays with postflight.

21 Updated 3 days ago
Zhonghao1995
Data & Documents Listed

report

Generate a CUBRID-house-style Korean analysis report as a Word (.docx): error analyses, code analyses, issue write-ups, before/after comparisons, and status/investigation reports. Builds the .docx with docx-js (the engine behind Anthropic's docx skill) from a JSON spec, embedding matplotlib charts, reproducing the exact design: centered cover (navy 23pt title), auto table of contents, navy/blue numbered headings, and bordered tables with row-level color coding (sky-blue header, green pass rows, red fail rows). Use when the user wants a Word report or structured document summarizing analysis, findings, comparisons, or current status of Hibernate/JDBC/CUBRID work. Triggers on phrases like 'write a report', '보고서 만들어', 'Word 문서로 정리', 'docx로 작성', 'analysis report', '검증 보고서', '비교 분석 문서'.

0 Updated 3 days ago
Srltas