razaali10 commited on
Commit
ace3d53
·
verified ·
1 Parent(s): 4388e90

Upload 2 files

Browse files
Files changed (2) hide show
  1. README.md +51 -14
  2. pyproject.toml +14 -0
README.md CHANGED
@@ -1,14 +1,51 @@
1
- ---
2
- title: PCSWMM MCP Server
3
- emoji: 🐠
4
- colorFrom: yellow
5
- colorTo: gray
6
- sdk: gradio
7
- sdk_version: 6.22.0
8
- python_version: '3.13'
9
- app_file: app.py
10
- pinned: false
11
- license: mit
12
- ---
13
-
14
- Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # PCSWMM Engineering SDK v0.4
2
+
3
+ Version 0.4 generalizes the SDK so it is not tied to a pond model.
4
+
5
+ ## Architecture
6
+
7
+ ### Generic core
8
+
9
+ - project metadata
10
+ - model inventory
11
+ - object tables
12
+ - GIS layers
13
+ - topology
14
+ - scenario paths
15
+ - simulation access
16
+ - result access
17
+ - report assembly
18
+
19
+ ### Capability-based optional modules
20
+
21
+ - hydrology: activated when subcatchments are present
22
+ - hydraulics: activated when conveyance objects are present
23
+ - storage/outlet review: activated when storage or outlet structures exist
24
+ - future modules: water quality, LID, groundwater, snowmelt, controls
25
+
26
+ ## Model archetypes
27
+
28
+ The SDK classifies the active project as one of:
29
+
30
+ - runoff-only model
31
+ - urban drainage network
32
+ - detention/storage model
33
+ - collection system with storage
34
+ - general SWMM model
35
+
36
+ This classification controls which review modules run.
37
+
38
+ ## Pond compatibility
39
+
40
+ `client.pond` remains available as a backward-compatible alias, but new code
41
+ should use:
42
+
43
+ ```python
44
+ client.storage
45
+ ```
46
+
47
+ ## Dashboard
48
+
49
+ Open:
50
+
51
+ `examples/PCSWMM_Generic_Engineering_Review_Dashboard_v0_4.ipynb`
pyproject.toml ADDED
@@ -0,0 +1,14 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ [build-system]
2
+ requires = ["setuptools>=68", "wheel"]
3
+ build-backend = "setuptools.build_meta"
4
+
5
+ [project]
6
+ name = "pcswmm-ai-sdk"
7
+ version = "0.4.0"
8
+ description = "Read-only Python SDK for PCSWMM's injected pcpy interface"
9
+ requires-python = ">=3.10"
10
+ authors = [{name = "Raza Ali"}]
11
+
12
+ [tool.setuptools.packages.find]
13
+ where = ["."]
14
+ include = ["pcswmm_ai*"]