PySAM SysML2 documentation (v |version|)
########################################

PySAM SysML2 provides a Python scripting interface for SysML2 models. It loads models from any
SysML2 tool that implements the standard API. The loaded model maps into a Python object, allowing
you to manipulate, browse, and edit it. You can then push modifications back to your modeling tool.

PySAM SysML2 works with the Ansys SysML2 modeling tool,
`Ansys System Architecture Modeler (SAM) <https://www.ansys.com/products/connect/ansys-system-architecture-modeler>`_.

.. only:: html

    .. grid:: 3

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

            Explains how to install PySAM SysML2 and set up a project.

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

            Explains how to connect to PySAM SysML2, work with models and diagrams, and find
            required information.

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

            Describes PySAM SysML2 functions, classes, and methods.

    .. grid:: 3

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

            Provides some examples of how to use PySAM SysML2.

        .. grid-item-card:: Contribute :fa:`users`
            :link: ref_contributing
            :link-type: ref

            Learn how to contribute to the PySAM SysML2 codebase
            or documentation.

        .. grid-item-card:: Useful links :fa:`link`

            - `PyPI release <https://pypi.org/project/ansys-sam-sysml2/>`_
            - `Releases on GitHub release <https://github.com/ansys/pysam-sysml2/releases>`_
            - `Stable documentation <https://sysml2.docs.pyansys.com/version/stable/index.html>`_

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

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