isofit.data.cli.examples

Downloads the ISOFIT examples from the repository https://github.com/isofit/isofit-tutorials

Attributes

CMD
NEON_URL

Functions

download_neon(examples)	Downloads the NEON dataset from https://avng.jpl.nasa.gov/pub/PBrodrick/isofit/tutorials/subset_data.zip.
download([path, tag, overwrite])	Downloads the ISOFIT examples from the repository https://github.com/isofit/isofit-tutorials.
validate([path, checkForUpdate, debug, error])	Validates an ISOFIT examples installation
isUpToDate([path, tag, debug, error])	Checks the installed version against the latest release
update([check])	Checks for an update and executes a new download if it is needed
download_cli(**kwargs)	Downloads the ISOFIT examples from the repository https://github.com/isofit/isofit-tutorials.
validate_cli(**kwargs)	Validates the installation of the ISOFIT examples as well as checks for updates

Module Contents

CMD = 'examples'

NEON_URL = 'https://avng.jpl.nasa.gov/pub/PBrodrick/isofit/tutorials/subset_data.zip'

download_neon(examples)

Downloads the NEON dataset from https://avng.jpl.nasa.gov/pub/PBrodrick/isofit/tutorials/subset_data.zip.

Parameters:

examples (Path) – Path to the examples directory

download(path=None, tag='latest', overwrite=False, **_)

Downloads the ISOFIT examples from the repository https://github.com/isofit/isofit-tutorials.

Parameters:

• path (str | None) – Path to output as. If None, defaults to the ini path

• tag (str) – Release tag to pull from the github

• overwrite (bool, default=False) – Overwrite an existing installation

• **_ (dict) – Ignores unused params that may be used by other validate functions. This is to maintain compatibility with other functions

validate(path=None, checkForUpdate=True, debug=print, error=print, **_)

Validates an ISOFIT examples installation

Parameters:

• path (str, default=None) – Path to verify. If None, defaults to the ini path

• checkForUpdate (bool, default=True) – Checks for updates if the path is valid

• debug (function, default=print) – Print function to use for debug messages, eg. logging.debug

• error (function, default=print) – Print function to use for error messages, eg. logging.error

• **_ (dict) – Ignores unused params that may be used by other validate functions. This is to maintain compatibility with env.validate

Returns:

True if valid, False otherwise

Return type:

bool

isUpToDate(path=None, tag='latest', debug=print, error=print, **_)

Checks the installed version against the latest release

Parameters:

• path (str, default=None) – Path to update. If None, defaults to the ini path

• debug (function, default=print) – Print function to use for debug messages, eg. logging.debug

• error (function, default=print) – Print function to use for error messages, eg. logging.error

• **_ (dict) – Ignores unused params that may be used by other validate functions. This is to maintain compatibility with other functions

Returns:

True if the path is up to date, False otherwise

Return type:

bool

Notes

The Github workflows watch for the string “[x]” to determine if the cache needs to update the data of this module. If your module does not include this string, the workflows will never detect updates.

update(check=False, **kwargs)

Checks for an update and executes a new download if it is needed

Parameters:

• check (bool, default=False) – Just check if an update is available, do not download

• **kwargs (dict) – Additional key-word arguments to pass to download()

download_cli(**kwargs)

Downloads the ISOFIT examples from the repository https://github.com/isofit/isofit-tutorials.

 Run isofit download paths to see default path locations. There are two ways to specify output directory:

• isofit –examples /path/examples download examples: Override the ini file. This will save the provided path for future reference.

• isofit download examples –path /path/examples: Temporarily set the output location. This will not be saved in the ini and may need to be manually set.

It is recommended to use the first style so the download path is remembered in the future.

validate_cli(**kwargs)

Validates the installation of the ISOFIT examples as well as checks for updates