larvaworld.lib.reg
==================

.. py:module:: larvaworld.lib.reg

.. autoapi-nested-parse::

   This module sets up the larvaworld registry where most functions, classes, and configurations are registered.
   It is initialized automatically when importing the package and serves as an accessible database for all functionalities.



Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/larvaworld/lib/reg/config/index
   /autoapi/larvaworld/lib/reg/data_aux/index
   /autoapi/larvaworld/lib/reg/distro/index
   /autoapi/larvaworld/lib/reg/generators/index
   /autoapi/larvaworld/lib/reg/graph/index
   /autoapi/larvaworld/lib/reg/keymap/index
   /autoapi/larvaworld/lib/reg/larvagroup/index
   /autoapi/larvaworld/lib/reg/parDB/index
   /autoapi/larvaworld/lib/reg/parFunc/index
   /autoapi/larvaworld/lib/reg/stored_confs/index


Attributes
----------

.. autoapisummary::

   larvaworld.lib.reg.units
   larvaworld.lib.reg.controls
   larvaworld.lib.reg.par
   larvaworld.lib.reg.default_modelID


Functions
---------

.. autoapisummary::

   larvaworld.lib.reg.getPar
   larvaworld.lib.reg.loadRef
   larvaworld.lib.reg.default_ref
   larvaworld.lib.reg.default_model


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

.. py:data:: units
   :type:  pint.UnitRegistry

.. py:data:: controls
   :type:  keymap.ControlRegistry

.. py:data:: par
   :type:  parDB.ParamRegistry

.. py:function:: getPar(k: Any | None = None, p: Any | None = None, d: Any | None = None, to_return: str = 'd') -> Any

   Shortcut function for easy use directly via the registry.
   See 'par.getPar' for more information.


.. py:function:: loadRef(id: str, **kwargs: Any) -> Any

   Shortcut function for easy use directly via the registry.
   See 'conf.Ref.loadRef' for more information.


.. py:function:: default_ref() -> Any

.. py:data:: default_modelID
   :type:  str
   :value: 'explorer'


.. py:function:: default_model() -> Any