-
Notifications
You must be signed in to change notification settings - Fork 8
Config File
Kevin Ballantyne edited this page Nov 1, 2023
·
25 revisions
The config.ini file is located in the home folder under .eodms.
- /~/.eodms/config.ini in Linux
- %USERPROFILE%/.eodms/config.ini in Windows
The configuration file entries can be modified by running python eodms_cli.py --configure [OPTIONS].
The available options are:
| Option Syntax | Description | Example |
|---|---|---|
all |
Asks user for all parameters in the configuration file. | python eodms_cli.py --configure all |
<section> |
Asks users to enter parameters under the specified section. | python eodms_cli.py --configure RAPI |
<section>.<parameter>=<value> |
Sets a <parameter> in <section> to <value>. |
python eodms_cli.py --configure Paths.results=/tmp/logs |
To change the credentials stored in the configuration file, run python eodms_cli.py --configure credentials. When prompted, enter the username for your EODMS account and the password.
->> Username of the eodms account used to access the rapi (username) [default from file]:
->> Password of the eodms account used to access the rapi:| Parameter | Description | Default | CLI Example |
|---|---|---|---|
| keep_results | The most recent time to keep the files in the results folder. Must be a time interval such as '1 month', '5 days' or '1 year'. If blank, the files will be kept indefinitely. |
blank | python eodms_cli.py --configure Script.keep_results="1 year" |
| keep_downloads | The most recent time to keep the files in the downloads folder. Must be a time interval such as '1 month', '5 days' or '1 year'. If blank, the files will be kept indefinitely. |
blank | python eodms_cli.py --configure Script.keep_downloads="1 year" |
| colourize | Determines whether to use colours in the cli output | True | python eodms_cli.py --configure Script.colourize=False |
| Parameter | Description | Default |
|---|---|---|
| downloads | The folder location where the images will be downloaded. The path can be a relative path or absolute. If the path is relative, the folder(s) will be put into the script folder. If blank, files will be saved in a "downloads" folder in the script folder. |
blank |
| results | The folder location where the CSV files containing the download results will be placed. The path can be a relative path or absolute. If the path is relative, the folder(s) will be put into the script folder. If blank, the files will be saved in a "results" folder in the script folder. |
blank |
| log | The folder location where the log file will be saved. The path can be a relative path or absolute. If the path is relative, the folder(s) will be put into the script folder. If blank, the files will be saved in a "log" folder in the script folder. |
blank |
| Parameter | Description | Default |
|---|---|---|
| username | The username of the EODMS account used to search, order and download. Once entered, this username will always be used if no username is specified in the command-line. If blank, the script will prompt you for a username if no username is specified in the command-line. The script will then ask if you want to store the username for later sessions; the username will be saved here. |
blank |
| password | The password of the EODMS account used to search, order and download. Once entered, this password will always be used if no password is specified in the command-line. The password is encrypted using Python so you can only enter the password using the script. DO NOT enter your password manually into this file. If blank, the script will prompt you for a password if no password is specified in the command-line. The script will then ask if you want to store the password for later sessions; the password will be saved here. |
blank |
| Parameter | Description | Default |
|---|---|---|
| access_attempts | The number of times the script will attempt to send a query to the RAPI before the script exits. | 4 |
| max_results | The maximum number of results to search in the RAPI. | 1000 |
| timeout_query | The total timeout time, in seconds, for queries to the RAPI. | 120.0 |
| timeout_order | The total timeout time, in seconds, for orders sent to the RAPI. There is a separate timeout option for orders since the time to get orders can take quite a while depending on the number of orders for the user. |
180.0 |
| order_check_date | When checking for previously submitted orders, this date is the earliest they will be checked. It can be hours, days, months or years (ex: 50 hours). |
3 days |
| download_attempts | Maximum number of attempts to download images while waiting for orders to become AVAILABLE_FOR_DOWNLOAD (there is no limit if left blank). | blank |