PySpeos documentation |version|
===============================

``PySpeos`` is a Python client library that gathers functionalities and tools based on remote API of Ansys software
`Speos <https://www.ansys.com/products/optics/ansys-speos>`_ .

.. grid:: 2

    .. grid-item-card:: Overview :fa:`book-open-reader`
        :padding: 2 2 2 2
        :link: overview/index
        :link-type: doc

        Overview of the PySpeos library.

    .. grid-item-card:: Getting started :fa:`person-running`
        :padding: 2 2 2 2
        :link: getting_started/index
        :link-type: doc

        Learn how to run the Linux Docker container, install the
        PySpeos image, and launch and connect to the Speos
        service.

    .. grid-item-card:: API reference :fa:`book-bookmark`
        :padding: 2 2 2 2
        :link: api/index
        :link-type: doc

        Understand PySpeos API endpoints, their capabilities,
        and how to interact with them programmatically.

    .. grid-item-card:: Examples :fa:`clone`
        :padding: 2 2 2 2
        :link: examples
        :link-type: doc

        Learn how to use PySpeos with examples that demonstrate its capabilities.

    .. grid-item-card:: Contribute :fa:`people-group`
        :link: contributing
        :link-type: doc

        Learn how to contribute to the PySpeos codebase
        or documentation.

.. toctree::
   :hidden:
   :maxdepth: 3

   overview/index
   getting_started/index
   api/index
   examples
   contributing
   changelog