pyemu.utils.get_pestpp

Download and install the PEST++ software suite.

This script originates from pyemu: https://github.com/pypest/pyemu This file can be downloaded and run independently outside pyemu. It requires Python 3.6 or later, and has no dependencies.

See https://developer.github.com/v3/repos/releases/ for GitHub Releases API.

Module Contents

Functions

run_main(bindir[, owner, repo, release_id, ostag, ...])

Run main method to get the PEST++ software suite.
pyemu.utils.get_pestpp.run_main(bindir, owner=default_owner, repo=default_repo, release_id='latest', ostag=None, subset=None, downloads_dir=None, force=False, quiet=False, _is_cli=False)

Run main method to get the PEST++ software suite.

Parameters:

  • bindir (str or Path) – Writable path to extract executables. Auto-select options start with a colon character. See error message or other documentation for further information on auto-select options.

  • owner (str, default "usgs") – Name of GitHub repository owner (user or organization).

  • repo (str, default "pestpp") – Name of GitHub PEST++ repository.

  • release_id (str, default "latest") – GitHub release ID.

  • ostag (str, optional) – Operating system tag; default is to automatically choose.

  • subset (list, set or str, optional) – Optional subset of executables to extract, specified as a list (e.g.) ["pestpp-glm", "pestpp-ies"] or a comma-separated string “pestpp-glm,pestpp-ies”.

  • downloads_dir (str or Path, optional) – Manually specify directory to download archives. Default is to use home Downloads, if available, otherwise a temporary directory.

  • force (bool, default False) – If True, always download archive. Default False will use archive if previously downloaded in downloads_dir.

  • quiet (bool, default False) – If True, show fewer messages.

  • _is_cli (bool, default False) – Control behavior of method if this is run as a command-line interface or as a Python function.