isofit.data.cli.imagecube

Downloads the extra ISOFIT image cube data files from https://avng.jpl.nasa.gov/pub/PBrodrick/isofit/

Attributes

CMD

URL

size

Functions

download([path, size, overwrite])

Downloads the extra ISOFIT data files from https://avng.jpl.nasa.gov/pub/PBrodrick/isofit/.

validate([path, size, debug, error])

Validates an ISOFIT image cube data installation

update([check])

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

download_cli(**kwargs)

Downloads the extra ISOFIT image cube data files from https://avng.jpl.nasa.gov/pub/PBrodrick/isofit/.

validate_cli(**kwargs)

Validates the installation of the image cube data

Module Contents

CMD = 'imagecube'[source]
URL = 'https://avng.jpl.nasa.gov/pub/PBrodrick/isofit/{size}_chunk.zip'[source]
download(path=None, size='both', overwrite=False, **_)[source]

Downloads the extra ISOFIT data files from https://avng.jpl.nasa.gov/pub/PBrodrick/isofit/.

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

  • size ("both" | "small" | "medium") – Which chunk size to pull

  • 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, size='both', debug=print, error=print, **_)[source]

Validates an ISOFIT image cube data installation

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

  • size ("both" | "small" | "medium") – Which chunk size to validate

  • 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

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)[source]

Checks for an update and executes a new download if it is needed Note: Not implemented for this module at this time

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()

size[source]
download_cli(**kwargs)[source]

Downloads the extra ISOFIT image cube data files from https://avng.jpl.nasa.gov/pub/PBrodrick/isofit/.

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

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

  • isofit download imagecube –path /path/imagecube: 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)[source]

Validates the installation of the image cube data