razaali10 commited on
Commit
9e14867
Β·
verified Β·
1 Parent(s): 76dc0f0

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +32 -4
README.md CHANGED
@@ -36,7 +36,7 @@ engineer.
36
  | **Built-in agent** | `POST /api/agent` and MCP tool `agent_analyze` | One natural-language call; the server's own LLM loop plans and runs the tools |
37
  | **Files** | `GET /files/{session_id}/{filename}` | Generated SWMR docx / audit-zip downloads |
38
 
39
- ## Tools (18)
40
 
41
  `upload_model` β†’ `run_simulation` β†’ then: `get_node_results`, `get_link_results`,
42
  `get_subcatchment_results`, `get_timeseries` (bounded series with authoritative
@@ -44,6 +44,8 @@ engineer.
44
  store incl. the complete tokenized INP), `get_table_catalog`,
45
  `calgary_screening`, `set_report_details` (site description, design objectives,
46
  methodology, project metadata β€” see the swmr-site-details skill),
 
 
47
  `preliminary_design_review` (deterministic findings register incl.
48
  RPT-### reconciliation findings), `get_reconciliation`, `run_scenario` (base never
49
  mutated; deterministic comparison), `attach_figure` (embed client-generated
@@ -64,8 +66,34 @@ audited tables and provenance package. Instead:
64
  illustrative*, and it is archived in the audit zip under `figures/` with a
65
  manifest. The report itself remains the server's verified artifact.
66
 
67
- Typical flow: **upload_model β†’ run_simulation β†’ analysis tools**, reusing the
68
- returned `session_id`. Sessions expire after 6 h of inactivity.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
69
 
70
  ## Connecting from each platform
71
 
@@ -183,4 +211,4 @@ python -m venv /opt/swmm-venv && /opt/swmm-venv/bin/pip install -r worker-requir
183
  SWMM_WORKER_PYTHON=/opt/swmm-venv/bin/python uvicorn server:app --port 7860
184
  ```
185
 
186
- Free and non-commercial, for the water-engineering community.
 
36
  | **Built-in agent** | `POST /api/agent` and MCP tool `agent_analyze` | One natural-language call; the server's own LLM loop plans and runs the tools |
37
  | **Files** | `GET /files/{session_id}/{filename}` | Generated SWMR docx / audit-zip downloads |
38
 
39
+ ## Tools (19)
40
 
41
  `upload_model` β†’ `run_simulation` β†’ then: `get_node_results`, `get_link_results`,
42
  `get_subcatchment_results`, `get_timeseries` (bounded series with authoritative
 
44
  store incl. the complete tokenized INP), `get_table_catalog`,
45
  `calgary_screening`, `set_report_details` (site description, design objectives,
46
  methodology, project metadata β€” see the swmr-site-details skill),
47
+ `set_report_configuration` (project-specific major routes, criteria,
48
+ classifications, drawing inventory, applicable reports and checklist overrides),
49
  `preliminary_design_review` (deterministic findings register incl.
50
  RPT-### reconciliation findings), `get_reconciliation`, `run_scenario` (base never
51
  mutated; deterministic comparison), `attach_figure` (embed client-generated
 
66
  illustrative*, and it is archived in the audit zip under `figures/` with a
67
  manifest. The report itself remains the server's verified artifact.
68
 
69
+ Typical CoC flow: **upload_model β†’ set_report_details β†’
70
+ set_report_configuration β†’ run_simulation β†’ deterministic QA/QC and Calgary
71
+ screening β†’ generate_report**, reusing the returned `session_id`. Sessions
72
+ expire after 6 h of inactivity.
73
+
74
+ Generated Calgary-style SWMR drafts include a deterministic depth-velocity
75
+ criteria figure immediately below Table 9. It plots the tabulated 2011
76
+ Alberta/Calgary envelope, the modeled overland-route depth/velocity pairs, and
77
+ peak flow by marker colour. The figure PNG and its criterion CSV are retained
78
+ in the audit ZIP. The report discloses straight-line interpolation and the need
79
+ to verify current and project-specific requirements.
80
+
81
+ The report also generates Figure 3-1, an automated SWMM model schematic, from
82
+ the tokenized INP. It uses `[COORDINATES]` and `[VERTICES]` when available,
83
+ falls back to a stable topology layout when coordinates are incomplete, shows
84
+ subcatchment runoff routing and hydraulic-link direction, and archives both the
85
+ PNG and a generation manifest. It is a topology aid and remains subject to
86
+ drawing-to-model reconciliation.
87
+
88
+ ### Legacy zero-value solver options
89
+
90
+ For dynamic-wave models, explicit zero values for `MAX_TRIALS`,
91
+ `HEAD_TOLERANCE`, and `MIN_SURFAREA` are treated as legacy/default sentinels.
92
+ The uploaded INP remains immutable. The server creates and runs a derivative
93
+ execution copy with unit-aware EPA SWMM defaults, and records every
94
+ substitution plus the SHA-256 hashes of both files. Negative or non-numeric
95
+ values remain blocking configuration errors. The report audit ZIP retains both
96
+ the original and derivative INP files whenever normalization occurs.
97
 
98
  ## Connecting from each platform
99
 
 
211
  SWMM_WORKER_PYTHON=/opt/swmm-venv/bin/python uvicorn server:app --port 7860
212
  ```
213
 
214
+ Free and non-commercial, for the water-engineering community.