etho.client#

etho.client.cli_progress(services: Dict[str, Any], save_prefix: str, stop_event: Optional[threading.Event] = None, done_event: Optional[threading.Event] = None)[source]#

_summary_

Parameters

  • services (_type_) – Dictionary of intialized services.

  • save_prefix (_type_) – Name of the expt.

  • stop_event (_type_, optional) – Used to stop the task from an outside thread. Defaults to None.

  • done_event (_type_, optional) – Set to signal that the task is done/stopped to an outside thread. Defaults to None.

etho.client.client(protocolfile: str, playlistfile: Optional[str] = None, *, save_prefix: Optional[str] = None, show_progress: bool = True, debug: bool = False, preview: bool = False, _stop_event: Optional[threading.Event] = None, _done_event: Optional[threading.Event] = None, _queue: Optional[queue.Queue] = None)[source]#

Starts an experiment.

Parameters

  • protocolfile (str) – _description_

  • playlistfile (Optional[str]) – _description_.

  • save_prefix (Optional[str]) – Specify the stem of the filename for all saved data and logs. Will defaults to HOSTNAME-YYYYMMDD_hhmmss, where HOSTNAME is the computer name the service is run on (typically localhost).

  • show_progress (bool) – Show a progress bar. Disable if performance is criticial.

  • debug (bool) – More verbose logs.

  • preview (bool) – Preview the camera (will disable saving and logging and only open a window with the camera view).

  • _stop_event (threading.Event, optional) – Used to stop the task from an outside thread. Defaults to None.

  • _done_event (threading.Event, optional) – Set to signal that the task is done/stopped to an outside thread. Defaults to None.

  • _queue (queue.Queue, optional) – Signal the expected duration of the task to outside funs. Defaults to None.