larvaworld
==========

.. py:module:: larvaworld

.. autoapi-nested-parse::

   Larvaworld : A Drosophila larva behavioral analysis and simulation platform



Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/larvaworld/cli/index
   /autoapi/larvaworld/dashboards/index
   /autoapi/larvaworld/gui_v2/index
   /autoapi/larvaworld/lib/index
   /autoapi/larvaworld/portal/index


Attributes
----------

.. autoapisummary::

   larvaworld.ROOT_DIR
   larvaworld.DATA_DIR
   larvaworld.SIM_DIR
   larvaworld.BATCH_DIR
   larvaworld.CONF_DIR
   larvaworld.TEST_DIR
   larvaworld.SIMTYPES
   larvaworld.CONFTYPES


Functions
---------

.. autoapisummary::

   larvaworld.vprint


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

.. py:function:: vprint(text: str = '', verbose: int = 0) -> None

   Print text if the verbosity level is greater than or equal to the global VERBOSE level.

   Parameters
   ----------
   text (str): The text to print.
   verbose (int): The verbosity level of the message.



.. py:data:: ROOT_DIR
   :type:  str

   Root directory of the larvaworld package.


.. py:data:: DATA_DIR
   :type:  str
   :value: 'Uninferable/data'


   Path to the data directory (data/ relative to package root).


.. py:data:: SIM_DIR
   :type:  str
   :value: 'Uninferable/data/SimGroup'


   Path to the simulation data directory (data/SimGroup/ relative to package root).


.. py:data:: BATCH_DIR
   :type:  str
   :value: 'Uninferable/data/SimGroup/batch_runs'


   Path to the batch runs directory (data/SimGroup/batch_runs/ relative to package root).


.. py:data:: CONF_DIR
   :type:  str
   :value: 'Uninferable/lib/reg/confDicts'


   Path to the configuration dictionaries directory (lib/reg/confDicts/ relative to package root).


.. py:data:: TEST_DIR
   :type:  str
   :value: 'Uninferable/../../tests'


   Path to the tests directory (../../tests relative to package root).


.. py:data:: SIMTYPES
   :type:  list[str]
   :value: ['Exp', 'Batch', 'Ga', 'Eval', 'Replay']


   List of available simulation types for CLI and API usage.


.. py:data:: CONFTYPES
   :type:  list[str]
   :value: ['Env', 'LabFormat', 'Ref', 'Model', 'Trial', 'Exp', 'Batch', 'Ga']


   List of available configuration types in the registry.