Docs Preview - PR #1233  | Production Docs  | View PR
Skip to main content
Ctrl+K
⚠️ Development Version: This documentation was built from a development version (2026.3.10.dev13, commit: e27bd4b). Features described here may be unstable or subject to change. For stable documentation, please visit the latest release.
SUEWS 2026.3.10.dev13 documentation - Home SUEWS 2026.3.10.dev13 documentation - Home

For users

  • 1. Installation
  • 2. Getting Started
  • 3. Tutorials
    • 3.1. SUEWS Quick Start Tutorial
    • 3.2. Set Up SUEWS for Your Own Site
    • 3.3. Preparing Initial Conditions
    • 3.4. Impact Studies Using SuPy
    • 3.5. Analysing Simulation Results
    • 3.6. External Model Coupling
    • 3.7. Temperature Attribution Analysis
  • 4. Input Files
    • 4.1. YAML Configuration Format
    • 4.2. Meteorological Forcing Data
    • 4.3. YAML Configuration Reference
      • 4.3.1. Anthropogenic Emissions
      • 4.3.2. Anthropogenic Heat
      • 4.3.3. Archetype Properties
      • 4.3.4. Buildings
      • 4.3.5. Bare Soil
      • 4.3.6. Building Layer
      • 4.3.7. CO2 Emissions
      • 4.3.8. Conductance
      • 4.3.9. Daily Profile
      • 4.3.10. Deciduous Trees
      • 4.3.11. Evergreen Trees
      • 4.3.12. Grass
      • 4.3.13. Hourly Profile
      • 4.3.14. Buildings Surface Initial State
      • 4.3.15. Bare Soil Surface Initial State
      • 4.3.16. Deciduous Tree Initial State
      • 4.3.17. Evergreen Tree Initial State
      • 4.3.18. Grass Initial State
      • 4.3.19. Paved Surface Initial State
      • 4.3.20. Vegetation Initial State
      • 4.3.21. Water Surface Initial State
      • 4.3.22. Initial States
      • 4.3.23. Irrigation
      • 4.3.24. LAI
      • 4.3.25. LAI Power Coefficients
      • 4.3.26. LUMPS Parameters
      • 4.3.27. Land Cover
      • 4.3.28. Model Configuration
      • 4.3.29. Model Control
      • 4.3.30. Physics Methods
      • 4.3.31. Surface Properties
      • 4.3.32. OHM Coefficients
      • 4.3.33. Seasonal/Wetness OHM Coefficients
      • 4.3.34. Output Configuration
      • 4.3.35. Paved Surfaces
      • 4.3.36. Roof Layer
      • 4.3.37. SPARTACUS
      • 4.3.38. SUEWS Config
      • 4.3.39. Site Configuration
      • 4.3.40. Site Properties
      • 4.3.41. Snow
      • 4.3.42. Soil Observation Configuration
      • 4.3.43. STEBBS
      • 4.3.44. Drainage Parameters
      • 4.3.45. Generic Surface Initial State
      • 4.3.46. Surface Properties
      • 4.3.47. Ten Minute Profile
      • 4.3.48. Thermal Layers
      • 4.3.49. Surface Properties
      • 4.3.50. Vegetation Parameters
      • 4.3.51. Vertical Layers
      • 4.3.52. Wall Layer
      • 4.3.53. Water Distribution
      • 4.3.54. Water Surfaces
      • 4.3.55. Weekly Profile
    • 4.4. SUEWS Format Converter
    • 4.5. Transitioning to YAML-based Configuration
    • 4.6. Validation Tool Reference
    • 4.7. Table-based Input Files (Legacy Format)
      • 4.7.3.1. Meteorological Input File
      • 4.7.3.2. RunControl.nml
        • 4.7.3.2.1. Scheme options
        • 4.7.3.2.2. Time related options
        • 4.7.3.2.3. File related options
        • 4.7.3.2.4. Options related to disaggregation of input data
      • 4.7.3.3. SUEWS_SiteSelect.txt
      • 4.7.3.4. Initial Conditions file
        • 4.7.3.4.1. Soil moisture states
        • 4.7.3.4.2. Vegetation parameters
        • 4.7.3.4.3. Recent meteorology
        • 4.7.3.4.4. Above ground state
        • 4.7.3.4.5. Snow related parameters
  • 5. Output Files
    • 5.1. Text Format Output
    • 5.2. Parquet Format Output
    • 5.3. Output Variable Reference
      • 5.3.1. datetime Output Variables
      • 5.3.2. SUEWS Output Variables
      • 5.3.3. snow Output Variables
      • 5.3.4. ESTM Output Variables
      • 5.3.5. EHC Output Variables
      • 5.3.6. RSL Output Variables
      • 5.3.7. BL Output Variables
      • 5.3.8. debug Output Variables
      • 5.3.9. BEERS Output Variables
      • 5.3.10. DailyState Output Variables
      • 5.3.11. SPARTACUS Output Variables
      • 5.3.12. STEBBS Output Variables
      • 5.3.13. NHood Output Variables
    • 5.4. Legacy Diagnostics
    • 5.5. Legacy Text Column Reference
  • 6. Python API Reference
    • 6.1. SUEWSSimulation Class
    • 6.2. Core Functions
      • 6.2.1.1. supy.init_supy
      • 6.2.1.2. supy.run_supy
      • 6.2.1.3. supy.save_supy
      • 6.2.1.4. supy.load_forcing_grid
      • 6.2.1.5. supy.load_sample_data
      • 6.2.1.6. supy.show_version
    • 6.3. Utility Functions
      • 6.3.1.1. supy.util.gen_forcing_era5
      • 6.3.2.1. supy.util.gen_epw
      • 6.3.2.2. supy.util.read_epw
      • 6.3.2.3. supy.util.fill_gap_all
      • 6.3.3.1. supy.util.derive_ohm_coef
      • 6.3.3.2. supy.util.sim_ohm
      • 6.3.4.1. supy.util.cal_gs_suews
      • 6.3.4.2. supy.util.cal_gs_obs
      • 6.3.4.3. supy.util.calib_g
      • 6.3.5.1. supy.util.plot_comp
      • 6.3.5.2. supy.util.plot_day_clm
      • 6.3.5.3. supy.util.plot_rsl
      • 6.3.6.1. supy.util.cal_z0zd
      • 6.3.6.2. supy.util.cal_neutral
      • 6.3.7.1. supy.util.attribute
      • 6.3.7.2. supy.util.diagnose
      • 6.3.7.3. supy.util.attribute_t2
      • 6.3.7.4. supy.util.attribute_q2
      • 6.3.7.5. supy.util.attribute_u10
      • 6.3.7.6. supy.util.diagnose_t2
      • 6.3.7.7. supy.util.diagnose_q2
      • 6.3.7.8. supy.util.diagnose_u10
      • 6.3.7.9. supy.util.AttributionResult
    • 6.4. Command-Line Tools
    • 6.5. Python API for CLI Users
    • 6.6. Data Structures
    • 6.7. Key IO Data Structures
    • 6.8. Configuration Converter API
  • 7. Integration and Complementary Tools
    • 7.1. Model Coupling and External Interaction
      • 7.1.1.1. Coupling with WRF
    • 7.2. Complementary Interfaces and Tools
      • 7.2.1.1. UMEP Interface
  • 8. Troubleshooting
  • 9. Benchmark Report
  • 10. Notation
  • 11. Version History
    • 11.1. Version 2026.1.28 (released on 28 January 2026)
    • 11.2. Version 2025.11.20 (released on 20 November 2025)
    • 11.3. Version 2025.10.15 (released on 15 October 2025)
    • 11.4. Version 2020a (released on 14 May 2020)
    • 11.5. Version 2019a (released on 15 November 2019)
    • 11.6. Version 2018c (released on 21 February 2019)
    • 11.7. Version 2018b (released on 17 December 2018)
    • 11.8. Version 2018a (released on 2 August 2018)
    • 11.9. Version 2017b (released on 2 August 2017)
    • 11.10. Version 2017a (released on 1 Feb 2017)
    • 11.11. Version 2016a (released on 21 June 2016)
    • 11.12. Version 2014b (released on 8 October 2014)
    • 11.13. Version 2014a.1 (released 26 February 2014)
    • 11.14. Version 2014a (released on 21 February 2014)
    • 11.15. Version 2013a
    • 11.16. Version 2012b
    • 11.17. Version 2012a
    • 11.18. Version 2011b

For developers/contributors

  • 1. Contributing Guide
  • 2. Acknowledgements
  • GitHub repository

Scientific background

  • 1. Parameterisations and sub-models within SUEWS
  • 2. SUEWS-related Publications
  • 3. References

Community

  • 1. Community Publications
  • Community
  • Repository
  • Suggest edit
  • Open issue
  • .rst

Version History

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.

11. Version History#

Note

For the latest development changes, bug fixes, and upcoming features, see CHANGELOG.md on GitHub.

  • 11.1. Version 2026.1.28 (released on 28 January 2026)
  • 11.2. Version 2025.11.20 (released on 20 November 2025)
  • 11.3. Version 2025.10.15 (released on 15 October 2025)
  • 11.4. Version 2020a (released on 14 May 2020)
  • 11.5. Version 2019a (released on 15 November 2019)
  • 11.6. Version 2018c (released on 21 February 2019)
  • 11.7. Version 2018b (released on 17 December 2018)
  • 11.8. Version 2018a (released on 2 August 2018)
  • 11.9. Version 2017b (released on 2 August 2017)
  • 11.10. Version 2017a (released on 1 Feb 2017)
  • 11.11. Version 2016a (released on 21 June 2016)
  • 11.12. Version 2014b (released on 8 October 2014)
  • 11.13. Version 2014a.1 (released 26 February 2014)
  • 11.14. Version 2014a (released on 21 February 2014)
  • 11.15. Version 2013a
  • 11.16. Version 2012b
  • 11.17. Version 2012a
  • 11.18. Version 2011b

previous

10. Notation

next

11.1. Version 2026.1.28 (released on 28 January 2026)

By SUEWS dev team led by Prof Sue Grimmond

© Copyright 2018 – 2026.

Last updated on 2026-01-29.

Version: 2026.3.10.dev13 | Commit: e27bd4b | Brand