larvaworld.lib.sim.base_run
===========================

.. py:module:: larvaworld.lib.sim.base_run


Classes
-------

.. autoapisummary::

   larvaworld.lib.sim.base_run.BaseRun


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

.. py:class:: BaseRun(screen_kws: dict[str, Any] = {}, **kwargs: Any)

   Bases: :py:obj:`larvaworld.lib.sim.ABM_model.ABModel`


   Basic Class for the Agent-based model
   Extends the agentpy Model class



   .. py:attribute:: agent_class


   .. py:attribute:: is_paused
      :value: False



   .. py:attribute:: datasets
      :value: None



   .. py:attribute:: results
      :value: None



   .. py:attribute:: exp_condition
      :value: None



   .. py:attribute:: figs


   .. py:attribute:: agents
      :value: []



   .. py:attribute:: sources
      :value: []



   .. py:attribute:: obstacles
      :value: []



   .. py:attribute:: screen_kws


   .. py:attribute:: screen_manager


   .. py:property:: end_condition_met
      :type: bool



   .. py:method:: sim_step() -> None

      Proceeds the simulation by one step, incrementing `Model.t` by 1
      and then calling :func:`Model.step` and :func:`Model.update`.



   .. py:method:: step_env() -> None


   .. py:property:: Nticks
      :type: int



   .. py:property:: sensorscapes


   .. py:method:: set_obj_visibility(objs, vis: bool = True) -> None


   .. py:method:: build_env(p: Any) -> None


   .. py:method:: create_odor_layers(odorscape: str, **kwargs: Any)


   .. py:property:: odor_ids


   .. py:method:: place_obstacles(barriers: dict = {}) -> None


   .. py:method:: place_food(p: Any) -> None


   .. py:method:: get_all_objects()


   .. py:method:: place_agents(confs: list[Any]) -> None


   .. py:property:: screen_class


   .. py:method:: delete_agent(a: Any) -> None


   .. py:method:: delete_source(a: Any) -> None


   .. py:method:: delete_agents(agent_list: Any | None = None) -> None


   .. py:method:: set_collectors(cs: Any) -> None


   .. py:property:: configuration_text


   .. py:method:: visualize_Env(envID: Any | None = None, envConf: Any | None = None, id: Any | None = None, duration: int = 1, screen_kws: dict[str, Any] = {}, func: Any | None = None, **kwargs: Any) -> None
      :classmethod: