CLI Examples

You can use IDM CLI to download the included Python example scripts from GitHub to a local folder using the idmtools gitrepo command. To see the list of commands and options for idmtools gitrepo, type the following at a command prompt:

$ idmtools gitrepo --help
INI File Used: /home/docs/checkouts/readthedocs.org/user_builds/institute-for-disease-modeling-idmtools/checkouts/v1.7.1/docs/idmtools.ini
Usage: idmtools gitrepo [OPTIONS] COMMAND [ARGS]...

  Contains command to download examples.

Options:
  --help  Show this message and exit.

Commands:
  download  Download files from GitHub repo to user location.
  peep      Display all current files/dirs of the repo folder (not...
  releases  Display all the releases of the repo.
  repos     Display all public repos of the owner.
  view      Display all idmtools available examples.

or view examples by typing idmtools examples list

$ idmtools examples list
INI File Used: /home/docs/checkouts/readthedocs.org/user_builds/institute-for-disease-modeling-idmtools/checkouts/v1.7.1/docs/idmtools.ini

COMPSPlatform
    - https://github.com/InstituteforDiseaseModeling/idmtools/tree/v1.7.1/examples/ssmt
    - https://github.com/InstituteforDiseaseModeling/idmtools/tree/v1.7.1/examples/workitem
    - https://github.com/InstituteforDiseaseModeling/idmtools/tree/v1.7.1/examples/vistools

SSMTPlatform
    - https://github.com/InstituteforDiseaseModeling/idmtools/tree/v1.7.1/examples/ssmt
    - https://github.com/InstituteforDiseaseModeling/idmtools/tree/v1.7.1/examples/vistools

CommandTask
    - https://github.com/InstituteforDiseaseModeling/corvid-idmtools

JSONConfiguredTask
    - https://github.com/InstituteforDiseaseModeling/idmtools/tree/v1.7.1/examples/python_model
    - https://github.com/InstituteforDiseaseModeling/idmtools/tree/v1.7.1/examples/load_lib

JSONConfiguredRTask
    - https://github.com/InstituteforDiseaseModeling/idmtools/tree/v1.7.1/examples/r_model

PythonTask
    - https://github.com/InstituteforDiseaseModeling/idmtools/tree/v1.7.1/examples/load_lib

To see the list of commands and options for downloading examples, type the following at a command prompt:

$ idmtools gitrepo download --help
INI File Used: /home/docs/checkouts/readthedocs.org/user_builds/institute-for-disease-modeling-idmtools/checkouts/v1.7.1/docs/idmtools.ini
Usage: idmtools gitrepo download [OPTIONS]

  Download files from GitHub repo to user location.

  Args:     type: Object type (COMPSPlatform, PythonTask, etc)     url: GitHub
  repo files url     output: Local folder

  Returns: Files download count

Options:
  --type TEXT    Download examples by type (COMPSPlatform, PythonTask, etc)
  --url TEXT     Repo files url
  --output TEXT  Files download destination
  --help         Show this message and exit.

or

$ idmtools examples download --help
INI File Used: /home/docs/checkouts/readthedocs.org/user_builds/institute-for-disease-modeling-idmtools/checkouts/v1.7.1/docs/idmtools.ini
Usage: idmtools examples download [OPTIONS]

  Download examples from specified location.

  Args:     type: Object type (COMPSPlatform, PythonTask, etc)     url: GitHub
  repo files url     output: Local folder

  Returns: Files download count

Options:
  --type TEXT    Download examples by type (COMPSPlatform, PythonTask, etc)
  --url TEXT     Repo files url
  --output TEXT  Files download destination
  --help         Show this message and exit.