etho.client

etho.client.cli_progress(services: Dict[str, Any], save_prefix: str, stop_event: Event | None = None, done_event: Event | None = None, show_progress: bool = True)[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 | None, playlistfile: str | None = None, *, protocol: Dict[str, Any] | None = None, save_prefix: str | None = None, show_progress: bool = True, monitor: bool = False, debug: bool = False, preview: bool = False, _stop_event: Event | None = None, _done_event: Event | None = None, _queue: Queue | None = None)[source]

Starts an experiment.

Parameters:

  • protocolfile (Optional[str]) – Path to the protocol file.

  • playlistfile (Optional[str]) – _description_.

  • protocol (Optional[Dict[str, Any]]) – Protocol parameters provided directly by the GUI.

  • 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.

  • monitor (bool) – Keep the run in the progress/cleanup loop even when the progress display is hidden.

  • 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.