IES-VE Python API documentation (unofficial)

I have written this unofficial documentation to the IES-VE Python API to support my undergraduate and postgraduate teaching.

The offical help guide from IES is here.

I’ve made this website available in case it is useful to others.

Any questions? Please contact me: www.stevenfirth.com/contact

Steven Firth, 2025

Contents:

• Overview
  • What is IES-VE?
  • What is Python?
  • What is an API?
  • What is the IES-VE Python API?
  • Why learn the IES-VE Python API?
• Quick Start
  • Installation
  • Open the VEScript Python Editor
  • Create a IES Python script
  • Run the Python script
  • Next steps
• Code Snippets
  • Working with files
  • Working with projects
  • Working with models
  • Working with bodies
  • Working with room data
  • Working with results
• Example Scripts
  • Plot room air temperatures
  • Plot room heat balance
  • Export room results to Excel
  • Export results to CSV files
  • Parametric analysis with heating setpoint
• API Reference
  • The iesve module