README.md

# PCSWMM Engineering SDK v0.4

Version 0.4 generalizes the SDK so it is not tied to a pond model.

## Architecture

### Generic core

- project metadata
- model inventory
- object tables
- GIS layers
- topology
- scenario paths
- simulation access
- result access
- report assembly

### Capability-based optional modules

- hydrology: activated when subcatchments are present
- hydraulics: activated when conveyance objects are present
- storage/outlet review: activated when storage or outlet structures exist
- future modules: water quality, LID, groundwater, snowmelt, controls

## Model archetypes

The SDK classifies the active project as one of:

- runoff-only model
- urban drainage network
- detention/storage model
- collection system with storage
- general SWMM model

This classification controls which review modules run.

## Pond compatibility

`client.pond` remains available as a backward-compatible alias, but new code
should use:

```python
client.storage
```

## Dashboard

Open:

`examples/PCSWMM_Generic_Engineering_Review_Dashboard_v0_4.ipynb`