tud_lbm.config
==============

.. py:module:: tud_lbm.config

.. autoapi-nested-parse::

   Configuration package for TUD-LBM.

   Public API::

       from config import SimulationConfig, from_toml, from_dict
       from config import TomlAdapter, DictAdapter



Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/tud_lbm/config/adapter_base/index
   /autoapi/tud_lbm/config/adapter_dict/index
   /autoapi/tud_lbm/config/adapter_toml/index
   /autoapi/tud_lbm/config/array_expansion/index
   /autoapi/tud_lbm/config/config_overview/index
   /autoapi/tud_lbm/config/jax_config/index
   /autoapi/tud_lbm/config/simulation_config/index


Functions
---------

.. autoapisummary::

   tud_lbm.config.from_toml
   tud_lbm.config.from_dict


Package Contents
----------------

.. py:function:: from_toml(path: str) -> simulation_config.SimulationConfig

   Load a TOML file and return a validated :class:`SimulationConfig`.

   This is a convenience wrapper that uses :class:`TomlAdapter`
   internally.  The returned object is a *config* — pass it to
   :func:`setup.simulation_setup.build_setup` to obtain the
   JAX-friendly :class:`SimulationSetup`.

   :param path: Filesystem path to a ``.toml`` file.

   :returns: A :class:`SimulationConfig`.


.. py:function:: from_dict(d: dict[str, Any]) -> simulation_config.SimulationConfig

   Build a :class:`SimulationConfig` from a plain dict.

   :param d: Configuration mapping.

   :returns: A validated :class:`SimulationConfig`.