Command Line Tools

PyMedPhys exposes a range of its library functions to the command line as a command line interface (CLI). This provides the benefit of being able to call PyMedPhys functions from a range of locations such as:

  • Other programming languages

  • Windows scheduler

  • .bat and .sh files

In this section of the documentation the help texts from each of the CLI commands are presented.

At the beginning of each of the CLI docs something like the following will display:

usage: pymedphys [-h] [-v] [-d]
                 {dicom,experimental,trf,dev,zenodo,icom,gui} ...

Named Arguments

-v, --verbose

Be verbose

Default: False

-d, --debug

Print debugging statements

Default: False

This presents what to write into the command prompt to use that CLI command.