The ``ansys.rocky.core`` library
================================

.. py:module:: ansys.rocky.core


Summary
-------








.. py:currentmodule:: core
.. tab-set::


    .. tab-item:: Submodules

        .. list-table::
          :header-rows: 0
          :widths: auto


          * - :py:obj:`~ansys.rocky.core.client`
            - Module that defines the ``RockyClient`` class, which acts as a proxy for a Rocky


          * - :py:obj:`~ansys.rocky.core.examples`
            - Helper module to download project code examples.


          * - :py:obj:`~ansys.rocky.core.exceptions`
            - Module where the exception classes of the project are contained.


          * - :py:obj:`~ansys.rocky.core.launcher`
            - Module that exposes functions to launch a Rocky application session.


          * - :py:obj:`~ansys.rocky.core.retry`
            - 


          * - :py:obj:`~ansys.rocky.core.rocky_api_proxies`
            - Module that defines the ``ApiElementProxy`` classes, which acts as a proxy for a


          * - :py:obj:`~ansys.rocky.core.serializers`
            - Module that defines the ``ApiElementProxy`` classes, which acts as a proxy for a






    .. tab-item:: Exceptions

        .. list-table::
          :header-rows: 0
          :widths: auto


          * - :py:obj:`~ansys.rocky.core.ApiClientError`
            - Provides the generic exception for the PyRocky API.


          * - :py:obj:`~ansys.rocky.core.ApiServerError`
            - Provides the ``Exception`` class for an error generated within the API layer.


          * - :py:obj:`~ansys.rocky.core.LaunchError`
            - Provides the error raised when problems occurs during launch of the Rocky app.



    .. tab-item:: Functions

        .. list-table::
          :header-rows: 0
          :widths: auto


          * - :py:obj:`~connect`
            - Connect to a Rocky/Freeflow app instance.


          * - :py:obj:`~connect_to_rocky`
            - This function is deprecated.


          * - :py:obj:`~launch_container`
            - Launch a Rocky or FreeFlow container with the PyRocky server enabled.


          * - :py:obj:`~launch_freeflow`
            - Launch the FreeFlow executable with the PyRocky server enabled.


          * - :py:obj:`~launch_rocky`
            - Launch the Rocky executable with the PyRocky server enabled.







.. toctree::
   :titlesonly:
   :maxdepth: 1
   :hidden:

    <span class="nf nf-fa-file"></span> client</api/ansys/rocky/core/client/index>
    <span class="nf nf-fa-file"></span> examples</api/ansys/rocky/core/examples/index>
    <span class="nf nf-fa-file"></span> exceptions</api/ansys/rocky/core/exceptions/index>
    <span class="nf nf-fa-file"></span> launcher</api/ansys/rocky/core/launcher/index>
    <span class="nf nf-fa-file"></span> retry</api/ansys/rocky/core/retry/index>
    <span class="nf nf-fa-file"></span> rocky_api_proxies</api/ansys/rocky/core/rocky_api_proxies/index>
    <span class="nf nf-fa-file"></span> serializers</api/ansys/rocky/core/serializers/index>





.. toctree::
   :titlesonly:
   :maxdepth: 1
   :hidden:

    <span class="nf nf-md-lightning_bolt"></span> ApiClientError</api/ansys/rocky/core/ApiClientError>
    <span class="nf nf-md-lightning_bolt"></span> ApiServerError</api/ansys/rocky/core/ApiServerError>
    <span class="nf nf-md-lightning_bolt"></span> LaunchError</api/ansys/rocky/core/LaunchError>







Description
-----------


PyRocky is a Python client for Ansys Rocky application.
















..
    !! processed by numpydoc !!






Module detail
-------------