Command-line interface

!etho --help

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

positional arguments:
  {call,version,gui}
    call              Starts an experiment.
    version           Displays system, version, and hardware info.
    gui               Opens the graphical user interface.

optional arguments:
  -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.

optional arguments:
  -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.

optional arguments:
  -h, --help       show this help message and exit

Start an experiment

!etho call --help

usage: etho call [-h] [--host HOST] [--save-prefix SAVE_PREFIX]
                 [--show-test-image | --no-show-test-image]
                 [--show-progress | --no-show-progress]
                 [-d | --debug | --no-debug] [-p | --preview | --no-preview]
                 protocolfile [playlistfile]

Starts an experiment.

positional arguments:
  protocolfile          _description_
  playlistfile          _description_.

optional arguments:
  -h, --help            show this help message and exit
  --host HOST           _description_
  --save-prefix SAVE_PREFIX
                        _description_.
  --show-test-image, --no-show-test-image
                        _description_.
  --show-progress, --no-show-progress
                        _description_.
  -d, --debug, --no-debug
                        _description_.
  -p, --preview, --no-preview
                        _description_.

Display system, version, and hardware info

!etho version --help

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

Displays system, version, and hardware info.

optional arguments:
  -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-13.2-arm64-arm-64bit
INFO:etho.cli:etho v0.11.0
INFO:etho.cli:  GUI SUPPORT
INFO:etho.cli:     GUI is available.
INFO:etho.cli:     pyqtgraph v0.13.3
INFO:etho.cli:     PySide2 v5.15.8
INFO:etho.cli:     Qt v5.15.8
INFO:etho.cli:     qtpy v2.3.1
INFO:etho.cli:  LIBRARY VERSIONS
INFO:etho.cli:    python v3.9.16 | packaged by conda-forge | (main, Feb  1 2023, 21:38:11) 
[Clang 14.0.6 ]
INFO:etho.cli:    pandas v2.0.3
INFO:etho.cli:    numpy v1.25.2
INFO:etho.cli:    h5py v3.9.0
INFO:etho.cli:    scipy v1.11.2
INFO:etho.cli:
INFO:etho.cli:  HARDWARE SUPPORT
WARNING:etho.cli:     Spinnaker SDK is NOT available.
WARNING:etho.cli:     NI daqmx is NOT available.
WARNING:etho.cli:     FlyCapture SDK is NOT available.