Overview
========

What is IES-VE?
---------------

IES-VE is commercial software for simulating the energy and environmental performance of buildings. The software is available `here <https://www.iesve.com/>`__.

What is Python?
---------------

Python is a general purpose programming language which can be used for automation, data analysis and may other functions. The beginners guide to Python is `here <https://www.python.org/about/gettingstarted/>`__. 

What is an API?
---------------

An Application Programming Interface (API) is where a software application provides an interface for other software.

What is the IES-VE Python API?
------------------------------

The IES-VE software has an interface which allows Python scripts to control and automate the IES-VE project. This interface can be seen in the IES-VE software via the menu items: `Tools/VE Scripts`.

The "IES-VE Python API" is the unique set of Python classes and methods which can be used in this interface to control and automate the IES-VE project.

Why learn the IES-VE Python API?
--------------------------------

Using Python in IES-VE, you can:

- automate making changes to the model, such as changing the properties of all the windows at once. 
- automate simulation runs, such as running 100 simulations as part of a parametric analysis.
- automate the analysis and presentation of results, such as creating unique graphs and tables and exporting these to Word or Excel.