Examples¶

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

$ idmtools gitrepo --help
INI File Used: /home/runner/work/idmtools/idmtools/idmtools/docs/idmtools.ini
Usage: idmtools gitrepo [OPTIONS] COMMAND [ARGS]...

Options:
  --help  Show this message and exit.

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

or view examples by type through

$ idmtools examples list
INI File Used: /home/runner/work/idmtools/idmtools/idmtools/docs/idmtools.ini

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

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

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

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

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

JSONConfiguredTask
    - https://github.com/InstituteforDiseaseModeling/idmtools/tree/v1.5.1/examples/python_model
    - https://github.com/InstituteforDiseaseModeling/idmtools/tree/v1.5.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/runner/work/idmtools/idmtools/idmtools/docs/idmtools.ini
Usage: idmtools gitrepo download [OPTIONS]

  Download files from GitHub repo to user location
  Args:
      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/runner/work/idmtools/idmtools/idmtools/docs/idmtools.ini
Usage: idmtools examples download [OPTIONS]

  Download examples from specified location
  Args:
      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.

To see a list of IDM examples available for downloading, type idmtools gitrepo download at a command prompt.