Command-line interface

!etho --help

usage: etho [-h] [--version] {version,init,run,gui} ...

positional arguments:
  {version,init,run,gui}
    version             Displays system, version, and hardware info.
    init                Initializes config files and folders.
    run                 Starts an experiment.
    gui                 Opens the graphical user interface.

options:
  -h, --help            show this help message and exit
  --version             show program's version number and exit

Initialize config file and folders

!etho init --help

usage: etho init [-h]

Initializes config files and folders.

options:
  -h, --help  show this help message and exit

Open the graphical user interface

!etho gui --help

usage: etho gui [-h] [protocol_folder] [playlist_folder]

Opens the graphical user interface.

positional arguments:
  protocol_folder  Folder with protocol files.
                   Defaults to value ['HEAD']['protocolfolder'] from ~/ethoconfig.yml.
  playlist_folder  Folder with playlist files.
                   Defaults to value ['HEAD']['playlistfolder'] from ~/ethoconfig.yml.

options:
  -h, --help       show this help message and exit

Start an experiment

!etho run --help

usage: etho run [-h] [--save-prefix SAVE_PREFIX]
                [--show-progress | --no-show-progress]
                [-d | --debug | --no-debug] [-p | --preview | --no-preview]
                protocolfile [playlistfile]

Starts an experiment.

positional arguments:
  protocolfile          _description_
  playlistfile          _description_.

options:
  -h, --help            show this help message and exit
  --save-prefix SAVE_PREFIX
                        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, --no-show-progress
                        Show a progress bar. Disable if performance is criticial.
  -d, --debug, --no-debug
                        More verbose logs.
  -p, --preview, --no-preview
                        Preview the camera (will disable saving and logging and only open a window with the camera view).

Display system, version, and hardware info

!etho version --help

usage: etho version [-h] [-d | --debug | --no-debug]

Displays system, version, and hardware info.

options:
  -h, --help            show this help message and exit
  -d, --debug, --no-debug
                        Display exception info for failed imports. Defaults to False.

!etho version

INFO:etho.cli:macOS-14.7.1-arm64-arm-64bit
INFO:etho.cli:etho v0.18.0
INFO:etho.cli:
INFO:etho.cli:  LIBRARY VERSIONS
INFO:etho.cli:    python v3.10.16 | packaged by conda-forge | (main, Dec  5 2024, 14:20:01) [Clang 18.1.8 ]
INFO:etho.cli:    pandas v2.2.3
INFO:etho.cli:    numpy v2.2.1
INFO:etho.cli:    h5py v3.12.1
INFO:etho.cli:    scipy v1.15.1
INFO:etho.cli:
INFO:etho.cli:  GUI SUPPORT
INFO:etho.cli:     GUI is available.
INFO:etho.cli:     pyqtgraph v0.13.7
INFO:etho.cli:     PySide6 v6.8.1
INFO:etho.cli:     Qt v6.8.1
INFO:etho.cli:     qtpy v2.4.2
INFO:etho.cli:
INFO:etho.cli:  HARDWARE SUPPORT
WARNING:etho.cli:     Spinnaker camera SDK (PySpin) is NOT available.
WARNING:etho.cli:     FlyCapture camera SDK (PyCapture2) is NOT available.
WARNING:etho.cli:     Ximea camera SDK (ximea) is NOT available.
WARNING:etho.cli:     DCAM (Hamamatsu) camera SDK (pylablib) is NOT available.
WARNING:etho.cli:     NI daqmx (pydaqmx) is NOT available.
WARNING:etho.cli:     Lightcrafter projector (pycrafter4500) is NOT available.