Command-line interface reference

Command-line interface reference#

This is the reference for Eradiate’s command-line tools. It consists of a main entry point eradiate, and its multiple subcommands documented hereafter. The implementation is located in the eradiate.cli module (not documented here).

eradiate#

Eradiate — A modern radiative transfer model for Earth observation.

Usage:

$ eradiate [OPTIONS] COMMAND [ARGS]...

Options:

  • --log-level [CRITICAL|ERROR|WARNING|INFO|DEBUG|NOTSET]: Set log level. [default: WARNING]

  • --debug / --no-debug: Enable debug mode. This will notably print exceptions with locals. [default: no-debug]

  • --install-completion: Install completion for the current shell.

  • --show-completion: Show completion for the current shell, to copy it or customize the installation.

  • --help: Show this message and exit.

Commands:

  • show: Display information useful for debugging.

  • data: Manage data.

  • srf: Spectral response function filtering utility.

eradiate show#

Display information useful for debugging.

Usage:

$ eradiate show [OPTIONS]

Options:

  • --help: Show this message and exit.

eradiate data#

Manage data.

Usage:

$ eradiate data [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • make-registry: Recursively construct a file registry from…

  • update-registries: Update local registries for online sources.

  • fetch: Fetch files from the Eradiate data store.

  • purge-cache: Purge the cache of online data stores.

  • info: Display information about data store…

  • check: Check data for availability and integrity,…

eradiate data make-registry#

Recursively construct a file registry from the current working directory.

Usage:

$ eradiate data make-registry [OPTIONS]

Options:

  • -i, --input-directory TEXT: Path to input directory. [default: .]

  • -o, --output-file TEXT: Path to output file (default: ‘<input_directory>/registry.txt’).

  • -r, --rules TEXT: Path to the registry rule file (default: ‘<input_directory>/registry_rules.yml’).

  • -a, --hash-algorithm TEXT: Hashing algorithm (default: ‘sha256’). [default: sha256]

  • --help: Show this message and exit.

eradiate data update-registries#

Update local registries for online sources.

Usage:

$ eradiate data update-registries [OPTIONS]

Options:

  • --help: Show this message and exit.

eradiate data fetch#

Fetch files from the Eradiate data store.

Usage:

$ eradiate data fetch [OPTIONS] [FILE_LIST]...

Arguments:

  • [FILE_LIST]...: An arbitrary number of relative paths to files to be retrieved from the data store or file list specifications. A file list keyword can also be specified to download a pre-defined list of files (use the --list option to display) available keywords. If unset, the list of files is read from a YAML file which can be specified by using the --from-file option, if it is used. Otherwise, it defaults to all in a production environment and minimal in a development environment.

Options:

  • -f, --from-file TEXT: Optional path to a file list (YAML format). If this option is set, the FILES argument(s) will be ignored.

  • -l, --list: List built-in file lists and exit.

  • --help: Show this message and exit.

eradiate data purge-cache#

Purge the cache of online data stores.

Usage:

$ eradiate data purge-cache [OPTIONS]

Options:

  • -k, --keep: Keep registered files.

  • --help: Show this message and exit.

eradiate data info#

Display information about data store configuration.

Usage:

$ eradiate data info [OPTIONS] [DATA_STORES]...

Arguments:

  • [DATA_STORES]...: List of data stores for which information is requested. If no data store ID is passed, information is displayed for all data stores.

Options:

  • -l, --list-registry: Show registry content if relevant.

  • --help: Show this message and exit.

eradiate data check#

Check data for availability and integrity, optionally fix them.

Usage:

$ eradiate data check [OPTIONS] [KEYWORDS]...

Arguments:

  • [KEYWORDS]...: A keyword defining the datasets that are to be checked. See the --list option for available keywords,

Options:

  • -l, --list: List known keywords and exit.

  • -f, --fix: Fix issues that can be.

  • --help: Show this message and exit.

eradiate srf#

Spectral response function filtering utility.

Usage:

$ eradiate srf [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • trim: Trim a spectral response function.

  • filter: Filter a spectral response function data set.

eradiate srf trim#

Trim a spectral response function. Remove all-except-last leading zeros and all-except-first trailing zeros.

Usage:

$ eradiate srf trim [OPTIONS] FILENAME OUTPUT

Arguments:

  • FILENAME: [required]

  • OUTPUT: File where to write the filtered data set. [required]

Options:

  • -v, --verbose: Display filtering summary.

  • -s, --show-plot: Show plot of the filtered region.

  • -d, --dry-run: Do not write filtered data to disk.

  • -i, --interactive: Prompt user to proceed to saving the filtered dataset.

  • --help: Show this message and exit.

eradiate srf filter#

Filter a spectral response function data set.

Usage:

$ eradiate srf filter [OPTIONS] FILENAME OUTPUT

Arguments:

  • FILENAME: path to the spectral response function data to filter. [required]

  • OUTPUT: Path where to write the filtered data. [required]

Options:

  • --trim / --no-trim: Trim the data set prior to filtering. [default: trim]

  • -v, --verbose: Display filtering summary.

  • -d, --dry-run: Do not write filtered data to file.

  • -i, --interactive: Prompt user to proceed to saving the filtered dataset.

  • -s, --show-plot: Show plot of the filtered region.

  • -t, --threshold FLOAT: Data points where response is less then or equal to this value are dropped.

  • -w, --wmin FLOAT: Lower wavelength value in nm.

  • -W, --wmax FLOAT: Upper wavelength value in nm.

  • -p, --percentage FLOAT: Data points that do not contribute to this percentage of the integrated spectral response are dropped

  • --help: Show this message and exit.