Python API Reference

Tip

Need help? Please let us know in the SUEWS Community.
Please report issues with the manual on GitHub Issues (or use Report Issue for This Page for page-specific feedback).
Please cite SUEWS with proper information from our Zenodo page.

6. Python API Reference#

The Python interface provides the complete API for SUEWS with comprehensive functionality for urban climate modelling, data analysis, and integration with the scientific Python ecosystem.

Object-Oriented Interface: The SUEWSSimulation class provides a modern interface for running simulations. See SUEWSSimulation Class.

Core Functions: Functional API for SUEWS simulations (init, run, save). See Core Functions.
Utility Functions: Data processing, analysis, and visualisation functions. See Utility Functions.
Command-Line Tools: CLI tools for running simulations and converting configurations. See Command-Line Tools.
Python API for CLI Users: Python equivalents for all command-line operations. See Python API for CLI Users.
Data Structures: DataFrame structures for model inputs and outputs. See Data Structures.
Configuration Converter: Python functions for converting between SUEWS formats and versions. See Configuration Converter API.