How kwr-water/pysimdeum works
PYSIMDEUM models residential water use and linked wastewater discharge. The main workflow builds a statistically populated house, simulates user/end-use events into labelled time-series results, then supports aggregation, plotting, and serialization. Population-level spatial aggregation is a separate capability. Some connections—especially in unsampled tools and population code—are shown only where the source index or README supports them; no external service wiring is inferred.
Main entry points: house.py House model · statistics.py Regional statistics · api.py Public API · helper.py Usage summaries
Components 17
Household model
- Public API
pysimdeum/api.py - Regional statistics
pysimdeum/core/statistics.py - Regional TOML data
pysimdeum/data - House model
pysimdeum/core/house.py - User presence
pysimdeum/core/user.py
Simulation engine
- End-use devices
pysimdeum/core/end_use.py - Pattern shaping
pysimdeum/utils/patterns.py - Probability sampling
pysimdeum/utils/probability.py - Simulation arrays
pysimdeum/core/house.py
Population workflows
- Spatial population
pysimdeum/core/population.py - Population utilities
pysimdeum/utils/misc.py - Wastewater quality
pysimdeum/utils/wastewater_quality.py
Analysis and outputs
- Usage summaries
pysimdeum/tools/helper.py - Plotting
pysimdeum/tools/plot.py - Serialization
pysimdeum/tools/write.py - InfoWorks tools
pysimdeum/tools/infoworks.py
Other components
- Python user
Connections 23
- Python user → Public API: builds house
README.md - Public API → Regional statistics: loads statistics
pysimdeum/api.py - Public API → House model: builds and simulates
pysimdeum/api.py - Regional statistics → Regional TOML data: loads regional config
pysimdeum/core/statistics.py - Regional statistics → Pattern shaping: builds patterns
pysimdeum/core/statistics.py - House model → Regional statistics: uses statistics
pysimdeum/core/house.py - House model → User presence: creates users
pysimdeum/core/house.py - House model → End-use devices: creates devices
pysimdeum/core/house.py - House model → Simulation arrays: produces arrays
README.md - End-use devices → Probability sampling: samples events
pysimdeum/core/end_use.py - End-use devices → Pattern shaping: uses event patterns
pysimdeum/core/end_use.py - User presence → Regional statistics: uses diurnal data
pysimdeum/core/user.py - Spatial population → Public API: simulates households
pysimdeum/core/population.py - Spatial population → Population utilities: uses utilities
pysimdeum/core/population.py - Spatial population → Wastewater quality: computes wastewater
pysimdeum/core/population.py - Wastewater quality → Probability sampling: samples concentrations
pysimdeum/utils/wastewater_quality.py - Wastewater quality → Regional TOML data: loads nutrient data
pysimdeum/utils/wastewater_quality.py - Usage summaries → House model: summarizes usage
pysimdeum/tools/helper.py - Usage summaries → Regional statistics: builds patterns
pysimdeum/tools/helper.py - Plotting → Usage summaries: uses summaries
pysimdeum/tools/plot.py - Plotting → House model: plots results
pysimdeum/tools/plot.py - Serialization → Usage summaries: uses summaries
pysimdeum/tools/write.py - Serialization → House model: serializes results
pysimdeum/tools/write.py