larvaworld.lib.ipc
==================

.. py:module:: larvaworld.lib.ipc

.. autoapi-nested-parse::

   Interface between a larvaworld simulation and a remote model



Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/larvaworld/lib/ipc/ipc/index


Classes
-------

.. autoapisummary::

   larvaworld.lib.ipc.BrianInterfaceMessage


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

.. py:class:: BrianInterfaceMessage(sim_id: str, model_id: str, step: int, **params: Any)

   Bases: :py:obj:`ipc.Message`


   A base class for serializable messages.


   .. py:attribute:: sim_id
      :type:  str


   .. py:attribute:: model_id
      :type:  str


   .. py:attribute:: step
      :type:  int


   .. py:attribute:: params
      :type:  dict[str, Any]


   .. py:method:: with_params(**params: Any) -> BrianInterfaceMessage


   .. py:method:: param(key: str) -> Any | None