emmi.schemas.data.data_specs
============================

.. py:module:: emmi.schemas.data.data_specs


Classes
-------

.. autoapisummary::

   emmi.schemas.data.data_specs.FieldDimSpec
   emmi.schemas.data.data_specs.AeroDataSpecs


Module Contents
---------------

.. py:class:: FieldDimSpec

   Bases: :py:obj:`pydantic.RootModel`\ [\ :py:obj:`dict`\ [\ :py:obj:`str`\ , :py:obj:`int`\ ]\ ]


   A specification for a group of named data fields and their dimensions.


   .. py:property:: field_slices
      :type: dict[str, slice]


      Calculates slice indices for each field in concatenation order.


   .. py:property:: total_dim
      :type: int


      Calculates the total dimension of all fields combined.


   .. py:method:: keys()


   .. py:method:: values()


   .. py:method:: items()


.. py:class:: AeroDataSpecs(/, **data)

   Bases: :py:obj:`pydantic.BaseModel`


   Defines the complete data specification for a surrogate model.

   Create a new model by parsing and validating input data from keyword arguments.

   Raises [`ValidationError`][pydantic_core.ValidationError] if the input data cannot be
   validated to form a valid model.

   `self` is explicitly positional-only to allow `self` as a field name.


   .. py:attribute:: position_dim
      :type:  int
      :value: None


      Dimension of the input position vectors.


   .. py:attribute:: surface_output_dims
      :type:  FieldDimSpec


   .. py:attribute:: volume_output_dims
      :type:  FieldDimSpec | None
      :value: None



   .. py:attribute:: conditioning_dims
      :type:  FieldDimSpec | None
      :value: None



   .. py:property:: physics_dim
      :type: int


      Calculates the total physics dimension from conditioning dimensions.


   .. py:property:: use_physics_features
      :type: bool


      Determines if physics features are used based on conditioning dimensions.


   .. py:property:: total_output_dim
      :type: int


      Calculates the total output dimension by summing surface and volume output dimensions.