API reference
=============

The ``pyansys`` metapackage on its own does not have a specific API. The only information specific-only
to this package that can be provided is its version. This can be looked up as follows:

.. code-block:: pycon

    >>> from pyansys import __version__
    >>> __version__

    '2023.1.0'

However, each of the PyAnsys packages that shape the ``pyansys`` metapackage have their own specific API
reference section. In order to navigate through them, please refer to their documentation.

******************************
PyAnsys packages API reference
******************************

.. grid:: 3

    .. grid-item-card:: PyAEDT
      :img-top: _static/thumbnails/pyaedt.png
      :link: https://aedt.docs.pyansys.com/dev/API/index.html
      :text-align: center
      :class-title: pyansys-card-title

    .. grid-item-card:: PyAnsys Math
      :img-top: _static/thumbnails/pyansys-math.png
      :link: https://math.docs.pyansys.com/version/stable/api_ref/index.html
      :text-align: center
      :class-title: pyansys-card-title

    .. grid-item-card:: PyDPF-Core
      :img-top: _static/thumbnails/pydpf-core.png
      :link: https://dpf.docs.pyansys.com/version/stable/api/index.html
      :text-align: center
      :class-title: pyansys-card-title

    .. grid-item-card:: PyDPF-Post
      :img-top: _static/thumbnails/pydpf-core.png
      :link: https://post.docs.pyansys.com/version/stable/api/index.html
      :text-align: center
      :class-title: pyansys-card-title

    .. grid-item-card:: PyDPF Composites
      :img-top: _static/thumbnails/pydpf-composites.png
      :link: https://composites.dpf.docs.pyansys.com/version/stable/api/index.html
      :text-align: center
      :class-title: pyansys-card-title

    .. grid-item-card:: PyFluent
      :img-top: _static/thumbnails/pyfluent.png
      :link: https://fluent.docs.pyansys.com/api/index.html
      :text-align: center
      :class-title: pyansys-card-title

    .. grid-item-card:: PyFluent-Parametric
      :img-top: _static/thumbnails/pyfluent-parametric.png
      :link: https://parametric.fluent.docs.pyansys.com/api/index.html
      :text-align: center
      :class-title: pyansys-card-title

    .. grid-item-card:: PyFluent-Visualization
      :img-top: _static/thumbnails/pyfluent-visualization.png
      :link: https://visualization.fluent.docs.pyansys.com/api/index.html
      :text-align: center
      :class-title: pyansys-card-title

    .. grid-item-card:: PyMAPDL
      :img-top: _static/thumbnails/pymapdl.png
      :link: https://mapdl.docs.pyansys.com/dev/api/index.html
      :text-align: center
      :class-title: pyansys-card-title

    .. grid-item-card:: PyMAPDL Reader
      :img-top: _static/thumbnails/pymapdl.png
      :link: https://reader.docs.pyansys.com/api/index.html
      :text-align: center
      :class-title: pyansys-card-title

    .. grid-item-card:: PyMotorCAD
      :img-top: _static/thumbnails/pymotorcad.png
      :link: https://motorcad.docs.pyansys.com/version/stable/methods/index.html
      :text-align: center
      :class-title: pyansys-card-title

    .. grid-item-card:: PyPIM
      :img-top: _static/thumbnails/intro.png
      :link: https://pypim.docs.pyansys.com/api/index.html
      :text-align: center
      :class-title: pyansys-card-title

    .. grid-item-card:: PyPrimeMesh
      :img-top: _static/thumbnails/intro.png
      :link: https://prime.docs.pyansys.com/dev/api/index.html
      :text-align: center
      :class-title: pyansys-card-title

    .. grid-item-card:: PySeascape
      :img-top: _static/thumbnails/intro.png
      :link: https://seascape.docs.pyansys.com/version/dev/#usage
      :text-align: center
      :class-title: pyansys-card-title

    .. grid-item-card:: PySystemCoupling
      :img-top: _static/thumbnails/pysystem-coupling.png
      :link: https://systemcoupling.docs.pyansys.com/dev/api/index.html
      :text-align: center
      :class-title: pyansys-card-title

    .. grid-item-card:: PyTwin
      :img-top: _static/thumbnails/pytwin.png
      :link: https://twin.docs.pyansys.com/dev/api/index.html
      :text-align: center
      :class-title: pyansys-card-title

    .. grid-item-card:: Granta MI BoM Analytics
      :img-top: _static/thumbnails/intro.png
      :link: https://bomanalytics.grantami.docs.pyansys.com/version/stable/index.html
      :text-align: center
      :class-title: pyansys-card-title

    .. grid-item-card:: Shared Components - OpenAPI Common
      :img-top: _static/thumbnails/intro.png
      :link: https://openapi.docs.pyansys.com/api/index.html
      :text-align: center
      :class-title: pyansys-card-title