.. title:: PySherlock

.. figure:: _static/logo/logo.png
   :align: center
   :width: 640px

Python API to interact with `Ansys Sherlock`_ (Reliability Engineering software) from **2022R2** and later versions.

.. grid:: 1 1 3 3

    .. grid-item-card:: Getting started :fa:`person-running`
        :padding: 2 2 2 2
        :link: ref_getting_started
        :link-type: ref

        Learn how to install and use PySherlock. Explains architecture
        and background.

        :bdg-primary-line:`Install` :bdg-primary-line:`Architecture`

    .. grid-item-card:: User guide :fa:`list-alt`
      :link: ref_user_guide
      :link-type: ref
      :padding: 2 2 2 2

      Understand how to use PySherlock to perform various tasks.

      :bdg-primary-line:`Prerequisites` :bdg-primary-line:`Architecture`

    .. grid-item-card:: API reference :fa:`book-bookmark`
        :padding: 2 2 2 2
        :link: ref_api_ref
        :link-type: ref

        Understand PySherlock API endpoints and their capabilities.

        :bdg-primary-line:`Classes` :bdg-primary-line:`Methods` :bdg-primary-line:`Error handling`

    .. grid-item-card:: Examples :fa:`scroll`
        :padding: 2 2 2 2
        :link: ref_examples
        :link-type: ref

        Dive into examples created using PySherlock.

        :bdg-primary-line:`Basic` :bdg-primary-line:`Technology-showcase` :bdg-primary-line:`Tips`

    .. grid-item-card:: Contribute :fa:`people-group`
        :padding: 2 2 2 2
        :link: ref_contributing
        :link-type: ref

        Learn how to contribute to the PySherlock codebase
        or documentation.

        :bdg-primary-line:`Test` :bdg-primary-line:`Documentation` :bdg-primary-line:`Issues`

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

   getting_started/index
   user_guide/index
   api/index
   examples/index
   contributing
   changelog