.. _models:

Models
======

.. py:module:: ansys.simai.core.data.models

A collection of classes for building a SimAI model.
Launching a build requires a configuration
(:py:class:`ModelConfiguration<ansys.simai.core.data.model_configuration.ModelConfiguration>`)
which defines the model properties, such as its inputs and outputs,
the Global Coefficients and the Domain of Analysis, and its project. The
:py:class:`ModelConfiguration<ansys.simai.core.data.model_configuration.ModelConfiguration>`
object is, then, parsed to :py:meth:`models.build()<ModelDirectory.build>` for
launching a build.


Directory
---------

.. autoclass:: ModelDirectory()
    :members:
    :exclude-members: get


Model
---------

.. autoclass:: Model()
    :members: