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.
eradiate [OPTIONS] COMMAND [ARGS]...
Options
- -l, --log-level <log_level>#
Set log level (default: ‘WARNING’).
- Options:
CRITICAL | ERROR | WARNING | INFO | DEBUG | NOTSET
data#
Manage data.
eradiate data [OPTIONS] COMMAND [ARGS]...
fetch#
Fetch files from the Eradiate data store. FILES is an arbitrary number of
relative paths to files to be retrieved from the data store. If FILES is
unset, the list of files is read from a YAML file which can be specified by
using the --from-file option and defaults to
$ERADIATE_SOURCE_DIR/resources/downloads.yml.
eradiate data fetch [OPTIONS] [FILES]...
Options
- -f, --from-file <from_file>#
Optional path to a file list (YAML format). If this option is set, the FILES argument(s) will be ignored.
Arguments
- FILES#
Optional argument(s)
info#
Display information about data store configuration.
The optional DATA_STORES argument specifies the list of data stores for which information is requested. If no data store ID is passed, information is displayed for all data stores.
eradiate data info [OPTIONS] [DATA_STORES]...
Options
- -l, --list-registry#
Show registry content if relevant.
Arguments
- DATA_STORES#
Optional argument(s)
make-registry#
Recursively construct a file registry from the current working directory.
eradiate data make-registry [OPTIONS]
Options
- -i, --input-directory <input_directory>#
Path to input directory (default: ‘.’).
- -o, --output-file <output_file>#
Path to output file (default: ‘<input_directory>/registry.txt’).
- -r, --rules <rules>#
Path to the registry rule file (default: ‘<input_directory>/registry_rules.yml’).
- -a, --hash-algorithm <hash_algorithm>#
Hashing algorithm (default: ‘sha256’).
purge-cache#
Purge the cache of online data stores.
eradiate data purge-cache [OPTIONS]
Options
- -k, --keep#
Keep registered files.
update-registries#
Update local registries for online sources.
eradiate data update-registries [OPTIONS]
show#
Display information useful for debugging.
eradiate show [OPTIONS]
srf#
Spectral response function filtering utility.
eradiate srf [OPTIONS] COMMAND [ARGS]...
filter#
Filter a spectral response function data set.
FILENAME specifies the path to the spectral response function data to filter. OUTPUT specified the path where to write the filtered data.
eradiate srf filter [OPTIONS] FILENAME OUTPUT
Options
- --trim, --no-trim#
Trim the data set prior to filtering.
- Default:
True
- -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 <threshold>#
Data points where response is less then or equal to this value are dropped.
- -w, --wmin <wmin>#
Lower wavelength value [float, str]
- -W, --wmax <wmax>#
Upper wavelength value [float, str]
- -p, --percentage <percentage>#
Data points that do not contribute to this percentage of the integrated spectral response are dropped
Arguments
- FILENAME#
Required argument
- OUTPUT#
Required argument
trim#
Trim a spectral response function.
Remove all-except-last leading zeros and all-except-first trailing zeros.
FILENAME is the path to the spectral response function data set to process. OUTPUT specifies where to write the filtered data set.
eradiate srf trim [OPTIONS] FILENAME OUTPUT
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.
Arguments
- FILENAME#
Required argument
- OUTPUT#
Required argument