PyHPS documentation |version|
=============================

Ansys HPC Platform Services (HPS) is a set of technology components designed to help you
manage the execution of simulations while making use of your full range of computing assets.

PyHPS brings HPS to your Python app. Wrapping around HPS REST APIs, PyHPS allows you to:

* Create projects and modify existing ones.
* Monitor and manage jobs.
* Run your own design exploration algorithms.
* Retrieve simulation results.


.. grid:: 1 1 2 2
        :gutter: 2

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

            Learn how to install and start using PyHPS.

        .. grid-item-card:: User guide :fa:`book-open-reader`
            :link: user_guide/index
            :link-type: doc

            Understand the basics of how to interact with HPS.

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

            Understand the PyHPS API, its capabilities,
            and how to interact with it programmatically.

        .. grid-item-card:: Examples :fa:`scroll`
            :link: examples/index
            :link-type: doc

            Explore examples that show how to use PyHPS to submit jobs.

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

            Learn how to contribute to the PyHPS codebase
            or documentation.

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

    getting_started/index
    user_guide/index
    api/index
    examples/index
    contribute