API Guidance

Text in boxes or blue

• These are internal links to classes and python definitions with the documentation

• Click on them to navigate to the definitions

The “API Reference” is a big list of all the Classes, Enums, and Functions that are available to use

There are some sections below that group these together.

Many classes (especially HVAC) will inherit from another class.

• this is noted with “Bases: ClassName”

This means the child classes will also contain the variables, methods and properties of the parent class (base)

• The child class may override the methods of the parent class

• Please see the parent classes to find out additional methods available

Units

• All API methods return their data in Metric units, regardless of the VE Units display setting.

• The VE Python includes a unit conversion library, Pint, that can be used to assist with unit conversions to IP units where desired.

• The VEProject class exports an API to retrieve the VE display settings, facilitating conversion to the VE display convention.