.. _ref_api_docs:

*************
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 :class:`ansys.pyensight.core.Session` class. Thus, an EnSight call like
``ensight.part.select_all()`` is available in PyEnSight as the
:func:`select_all<ansys.api.pyensight.ensight_api.part.select_all>`
method. Most scripts written for the embedded EnSight Python interpreter should work with
PyEnSight using the ``ansys.pyensight.core.Session.ensight`` interface.


.. toctree::
   :hidden:
   :maxdepth: 4

   native_documentation
   object_documentation
   calc_functions
   rest_api/rest_api


.. autosummary::
   :toctree: _autosummary/

   ansys.pyensight.core.enscontext.EnsContext
   ansys.pyensight.core.LocalLauncher
   ansys.pyensight.core.DockerLauncher
   ansys.pyensight.core.renderable.Renderable
   ansys.pyensight.core.Session
   ansys.pyensight.core.utils.export.Export
   ansys.pyensight.core.utils.parts.Parts
   ansys.pyensight.core.utils.query.Query
   ansys.pyensight.core.utils.support.Support
   ansys.pyensight.core.utils.views.Views
   ansys.pyensight.core.utils.variables.Variables
   ansys.pyensight.core.utils.omniverse.Omniverse