Configuration

This page details some of the options available for configuring your esgpull installation.

Configuration¶

On invocation, $ esgpull config will show the base configurations in the terminal.

$ esgpull config

──────────────────────────────────────────────────────────────────────────────────────────────────────────────────── /home/me/.esgpull/config.toml ─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────
[paths]
auth = "/home/me/.esgpull/auth"
data = "/home/me/.esgpull/data"
db = "/home/me/.esgpull/db"
log = "/home/me/.esgpull/log"
tmp = "/home/me/.esgpull/tmp"

[credentials]
filename = "credentials.toml"

[cli]
page_size = 20

[db]
filename = "esgpull.db"

[download]
chunk_size = 67108864
http_timeout = 20
max_concurrent = 5
disable_ssl = false

[api]
index_node = "esgf-node.ipsl.upmc.fr"
http_timeout = 20
max_concurrent = 5
page_limit = 50

[api.default_options]
distrib = "false"
latest = "true"
replica = "none"
retracted = "false"

[plugins]
enabled = "false"

To modify a config item from the command line, the dot-separated path to that item must be provided as the first argument along with the new value that item should get as the second argument:

$ esgpull config api.index_node esgf-data.dkrz.de

[api]
index_node = "esgf-data.dkrz.de"

Previous value: esgf-node.ipsl.upmc.fr

On first call, this will generate a config.toml file in the ~/.esgpull directory with only the modified values:

$ esgpull config api.index_node esgf-data.dkrz.de

[api]
index_node = "esgf-data.dkrz.de"

👍 New config file created at /home/srodriguez/.esgpull_test_config_generate/config.toml.

If a user wishes to simply generate the config.toml file without modifying any values, they simply must run the following:

$ esgpull config --generate

👍 Config generated at /home/me/.esgpull/config.toml

Complete existing config with defaults

The --generate flag also works when a configuration file already exists.

In this case, a prompt will ask for permission to fill the existing file with default values for all missing options:

$ esgpull config --generate

A config file already exists, fill it with missing defaults? [y/n] (n): y
👍 Config generated at /home/me/.esgpull/config.toml

Although most data on ESGF can be downloaded without authentication, some datasets require a valid OpenID login and password.

The ESGF OpenID authentication system is described on the ESGF user documentation.

This can be provided from the command line by running the following:

$ esgpull login

No credentials found.
  [0] esg-dn1.nsc.liu.se
  [1] esgf-data.dkrz.de
  [2] ceda.ac.uk
  [3] esgf-node.ipsl.upmc.fr
  [4] esgf-node.llnl.gov
  [5] esgf.nci.org.au
Select a provider: 0
User: MyESGFusername
Password: <hidden>
Certificates are missing.
👍 Renewed successfully

The credentials will then be saved under the ~/.esgpull/auth directory, within credentials.toml, which can then be used for future sessions.

Plugins¶

Plugin functionality is disabled by default and can be enabled with:

$ esgpull config plugins.enabled true

Plugin-specific configurations are managed separately through the esgpull plugins config command and stored in a dedicated plugins.toml file. See the Plugins page for more information.

Configuration

Configuration¶

Login¶

Plugins¶