8.2. EnSight Object API

Starting in EnSight 9.0, EnSight has added a new Python API based on the intrinsic objects inside of the EnSight core. This API targets applications developers that wish to build more complex applications on top of the EnSight Qt and Python interfaces. This API is utilized by EnSight itself internally. The API is much larger than the previous API and the documentation would not fit easily into these documents. Furthermore, the API is not yet complete and Ansys reserves the right to change anything in the API without warning at this point in time. Many folks have asked for access to this API, even though it is not yet complete. Ansys does not offer formal support for any of the Object API interfaces at this point in time. We will take bug reports, but due to the nature of the API, we are not providing normal support services.

Ansys provides two locations for information on the API. First, in the user-defined tools, there is a tool located under Utilities/Development named "Python Object API attributes". This tool allows the user to browse the various classes available and their attributes/methods. The tool is self-documenting in that all the information it displays is generated from the core objects at runtime. There is also a website https://nexusdemo.ensight.com/docs/python/html/Python.html that contains additional information about the various APIs. The website is dynamically updated and interested parties can subscribe to changes via RSS feeds.