API reference

Note

This is a work in progress and should be considered Beta.

The PyEnSight API is described in this section. Much of it is autogenerated and shared with EnSight.

ensight_api class

The ensight_api class should never be used directly. An instance is available via the ensight property on the ansys.pyensight.core.Session class. Thus, an EnSight call like ensight.part.select_all() is available in PyEnSight as the select_all method. Most scripts written for the embedded EnSight Python interpreter should work with PyEnSight using the ansys.pyensight.core.Session.ensight interface.

ansys.pyensight.core.enscontext.EnsContext([...])	A saved EnSight session state
ansys.pyensight.core.LocalLauncher([...])	Creates a Session instance by launching a local copy of EnSight.
ansys.pyensight.core.DockerLauncher([...])	Creates a Session instance using a copy of EnSight hosted in a Docker container.
ansys.pyensight.core.renderable.Renderable(session)	Generates HTML pages for renderable entities.
ansys.pyensight.core.Session([host, ...])	Provides for accessing an EnSight Session instance.
ansys.pyensight.core.utils.export.Export(...)	Provides the ensight.utils.export interface.
ansys.pyensight.core.utils.parts.Parts(ensight)	Controls the parts in the current EnSight Session instance.
ansys.pyensight.core.utils.query.Query(interface)	Provides the ensight.utils.query interface.
ansys.pyensight.core.utils.support.Support(...)	Provides the ensight.utils.support interface.
ansys.pyensight.core.utils.views.Views(ensight)	Controls the view in the current EnSight Session instance.
ansys.pyensight.core.utils.variables.Variables(ensight)	Controls the variables in the current EnSight Session instance.
ansys.pyensight.core.utils.omniverse.Omniverse(...)	Provides the ensight.utils.omniverse interface.
ansys.pyensight.core.utils.readers.Readers(...)	A namespace to access the interfaces of specific readers
ansys.pyensight.core.utils.readers.DVS(interface)	A namespace to access specific DVS interfaces