CLI Slurm examples

You can use IDM CLI to get all kind of statuses for SLURM.

To see job directory type the following at command prompt:

$ idmtools slurm <JOB_DIRECTORY> get-path --suite-id <suite_id> --help
INI File Found: /home/docs/checkouts/readthedocs.org/user_builds/institute-for-disease-modeling-idmtools/checkouts/latest/docs/idmtools.ini
Usage: idmtools slurm JOB_DIRECTORY get-path [OPTIONS]

  Get Suite/Experiment/Simulation directory

Options:
  --sim-id TEXT    Idmtools Simulation id
  --exp-id TEXT    Idmtools Experiment id
  --suite-id TEXT  Idmtools Suite id
  --help           Show this message and exit.

To get the latest status of a SLURM, type the following at a command prompt:

$ idmtools slurm <JOB_DIRECTORY> get-latest --help
INI File Found: /home/docs/checkouts/readthedocs.org/user_builds/institute-for-disease-modeling-idmtools/checkouts/latest/docs/idmtools.ini
Usage: idmtools slurm JOB_DIRECTORY get-latest [OPTIONS]

  Get the latest experiment info

Options:
  --help  Show this message and exit.

To get the status for a specific Experiment, type the following at a command prompt:

$ idmtools slurm <JOB_DIRECTORY> get-status --exp-id <exp_id> --help
INI File Found: /home/docs/checkouts/readthedocs.org/user_builds/institute-for-disease-modeling-idmtools/checkouts/latest/docs/idmtools.ini
Usage: idmtools slurm JOB_DIRECTORY get-status [OPTIONS]

  Get status of Experiment/Simulation

Options:
  --sim-id TEXT  Idmtools Simulation id
  --exp-id TEXT  Idmtools Experiment id
  --help         Show this message and exit.

To get the status report for a specific Suite, Experiment or Simulation, type the following at a command prompt:

$ idmtools slurm <JOB_DIRECTORY> status-report --exp-id <exp_id> --help
INI File Found: /home/docs/checkouts/readthedocs.org/user_builds/institute-for-disease-modeling-idmtools/checkouts/latest/docs/idmtools.ini
Usage: idmtools slurm JOB_DIRECTORY status-report [OPTIONS]

  Get simulation's report

Options:
  --suite-id TEXT             Idmtools Suite id
  --exp-id TEXT               Idmtools Experiment id
  --status-filter [0|-1|100]  list of status
  --sim-filter TEXT           list of simulations
  --job-filter TEXT           list of slurm jobs
  --root [job|sim]            Dictionary root key
  --verbose / --no-verbose    Enable verbose output in results
  --display / --no-display    Display with working directory or not
  --display-count INTEGER     Display Count
  --help                      Show this message and exit.