Troubleshooting#
You can use troubleshooting commands to get information about plugins (CLI, Platform, and Task) and to get detailed system information. To see the list of troubleshooting commands, type the following at a command prompt:
$ idmtools info --help
INI File Found: /home/docs/checkouts/readthedocs.org/user_builds/institute-for-disease-modeling-idmtools/checkouts/latest/docs/idmtools.ini
Usage: idmtools info [OPTIONS] COMMAND [ARGS]...
Troubleshooting and debugging information.
Options:
--help Show this message and exit.
Commands:
plugins Commands to get information about installed IDM-Tools plugins
system Provide an output with details about your current execution...
To see the list of troubleshooting commands and options for the plugins command, type the following at a command prompt:
$ idmtools info plugins --help
INI File Found: /home/docs/checkouts/readthedocs.org/user_builds/institute-for-disease-modeling-idmtools/checkouts/latest/docs/idmtools.ini
Usage: idmtools info plugins [OPTIONS] COMMAND [ARGS]...
Commands to get information about installed IDM-Tools plugins
Options:
--help Show this message and exit.
Commands:
cli List CLI plugins
platform List Platform plugins
platform-aliases List Platform plugins configuration aliases
task List Task plugins
To see the list of troubleshooting options for the system command, type the following at a command prompt:
$ idmtools info system --help
INI File Found: /home/docs/checkouts/readthedocs.org/user_builds/institute-for-disease-modeling-idmtools/checkouts/latest/docs/idmtools.ini
Usage: idmtools info system [OPTIONS]
Provide an output with details about your current execution platform and
IDM-Tools install
Options:
--copy-to-clipboard / --no-copy-to-clipboard
Copy output to clipboard
--no-format-for-gh / --format-for-gh
When copying to clipboard, do we want to
formatted for Github
--issue / --no-issue Copy data and format for github alias
--output-filename TEXT Output filename
--help Show this message and exit.
To see the versions of idmtools and related modules, along with the plugins they provide, you can use the version command. Here is an example of the output:
$ idmtools version
INI File Found: /home/docs/checkouts/readthedocs.org/user_builds/institute-for-disease-modeling-idmtools/checkouts/latest/docs/idmtools.ini
idmtools Version: 2.0.1+nightly
Plugins:
CommandTask
idmtools-cli Version: 2.0.1+nightly
idmtools-models Version: 2.0.1+nightly
Plugins:
JSONConfiguredPythonTask
JSONConfiguredRTask
JSONConfiguredTask
PythonTask
RTask
ScriptWrapperTask
TemplatedScriptTask
idmtools-platform-comps Version: 2.0.1+nightly
Plugins:
COMPSPlatform
SSMTPlatform
idmtools-platform-container Version: 2.0.1+nightly
Plugins:
ContainerPlatform
idmtools-platform-file Version: 2.0.1+nightly
Plugins:
FilePlatform
idmtools-platform-process Version: 2.0.1+nightly
Plugins:
ProcessPlatform
idmtools-platform-slurm Version: 2.0.1+nightly
Plugins:
SlurmPlatform
To see a list of the predefined configurations from platform plugins, use the command:
$ idmtools info plugins platform-aliases
INI File Found: /home/docs/checkouts/readthedocs.org/user_builds/institute-for-disease-modeling-idmtools/checkouts/latest/docs/idmtools.ini
+---------------------------+-------------------------------------------------------------------------+
| Platform Plugin Aliases | Configuration Options |
|---------------------------+-------------------------------------------------------------------------|
| CONTAINER | {'job_directory': '/home/docs'} |
| SLURM_LOCAL | {'mode': 'local', 'job_directory': '/home/docs'} |
| SLURM_BRIDGED | {'mode': 'bridged', 'job_directory': '/home/docs'} |
| CALCULON | {'endpoint': 'https://comps.idmod.org', 'environment': 'Calculon'} |
| IDMCLOUD | {'endpoint': 'https://comps.idmod.org', 'environment': 'IDMcloud'} |
| NDCLOUD | {'endpoint': 'https://comps.idmod.org', 'environment': 'NDcloud'} |
| BMGF_IPMCLOUD | {'endpoint': 'https://comps.idmod.org', 'environment': 'BMGF_IPMcloud'} |
| QSTART | {'endpoint': 'https://comps.idmod.org', 'environment': 'Qstart'} |
| NIBBLER | {'endpoint': 'https://comps.idmod.org', 'environment': 'Nibbler'} |
| SLURMSTAGE | {'endpoint': 'https://comps2.idmod.org', 'environment': 'SlurmStage'} |
| CUMULUS | {'endpoint': 'https://comps2.idmod.org', 'environment': 'Cumulus'} |
| SLURM | {'endpoint': 'https://comps.idmod.org', 'environment': 'Calculon'} |
| SLURM2 | {'endpoint': 'https://comps2.idmod.org', 'environment': 'SlurmStage'} |
| BOXY | {'endpoint': 'https://comps2.idmod.org', 'environment': 'SlurmStage'} |
| FILE | {'job_directory': '/home/docs'} |
| CALCULON_SSMT | {'endpoint': 'https://comps.idmod.org', 'environment': 'Calculon'} |
| IDMCLOUD_SSMT | {'endpoint': 'https://comps.idmod.org', 'environment': 'IDMcloud'} |
| NDCLOUD_SSMT | {'endpoint': 'https://comps.idmod.org', 'environment': 'NDcloud'} |
| BMGF_IPMCLOUD_SSMT | {'endpoint': 'https://comps.idmod.org', 'environment': 'BMGF_IPMcloud'} |
| QSTART_SSMT | {'endpoint': 'https://comps.idmod.org', 'environment': 'Qstart'} |
| NIBBLER_SSMT | {'endpoint': 'https://comps.idmod.org', 'environment': 'Nibbler'} |
| SLURMSTAGE_SSMT | {'endpoint': 'https://comps2.idmod.org', 'environment': 'SlurmStage'} |
| CUMULUS_SSMT | {'endpoint': 'https://comps2.idmod.org', 'environment': 'Cumulus'} |
| SLURM_SSMT | {'endpoint': 'https://comps.idmod.org', 'environment': 'Calculon'} |
| SLURM2_SSMT | {'endpoint': 'https://comps2.idmod.org', 'environment': 'SlurmStage'} |
| BOXY_SSMT | {'endpoint': 'https://comps2.idmod.org', 'environment': 'SlurmStage'} |
| PROCESS | {'job_directory': '/home/docs'} |
+---------------------------+-------------------------------------------------------------------------+