Tip

1. Need help? Please let us know in the SUEWS Community.

2. Please report issues with the manual on GitHub Issues (or use Report Issue for This Page for page-specific feedback).

3. Please cite SUEWS with proper information from our Zenodo page.

7.1. Model Coupling and External Interaction

SUEWS can be coupled with external models through SuPy’s low-level API functions, enabling two-way data exchange at each timestep.

Key Integration Capabilities:

• Timestep-level coupling: Exchange forcing data and model outputs at each simulation timestep

• Low-level API access: Direct access to SUEWS computation kernel through suews_cal_tstep

• External model integration: Couple with building energy models, traffic emissions, atmospheric models

• Custom forcing: Inject external data sources into SUEWS simulations

7.1.1. Coupling Examples

• 7.1.1.1. Coupling with WRF

Note

API Status: The external model coupling examples currently require API updates due to recent changes in SuPy’s internal interface. The integration patterns and concepts remain valid, but code updates are needed for compatibility with current SuPy versions.

7.1.2. Additional Integration Examples

Beyond the documented coupling examples above, SUEWS supports integration with:

• Building Energy Models: Exchange building heat fluxes with detailed energy simulation tools

• Traffic Emission Models: Couple dynamic traffic emissions with urban energy balance

• Climate Scenario Analysis: Integrate climate model outputs as SUEWS forcing data