Credentials Templates¶

Gathering provides templates to configure your service access keys and credentials either in a centralized YAML file or via environment variables.

See the Authentication Guide for full details on credentials resolution and automatic CLI storage.

`credentials.yaml.example`¶

Built-in template: credentials.yaml.example
Export locally: gathering examples copy credentials.yaml.example ~/.config/gathering/credentials.yaml | View: gathering examples show credentials.yaml.example

You can copy this template to ~/.config/gathering/credentials.yaml or $GATHERER_FOLDER/credentials.yaml:

# ==============================================================================
# GATHERING - Centralized Credentials Configuration Example
# ==============================================================================
# You can copy this file to:
#   1. ~/.config/gathering/credentials.yaml (default global location)
#   2. $GATHERER_FOLDER/credentials.yaml
#   3. Or set the custom path via: export GATHERING_CREDENTIALS_FILE=/path/to/credentials.yaml
#
# Alternatively, you can use CLI commands:
#   gathering auth login cdse -u "your_email" -p "your_password"
#   gathering auth login eumdac -u "your_key" -p "your_secret"
#   gathering auth login earthcare -u "your_user" -p "your_password"
#   gathering auth login earthdata -u "your_user" -p "your_password"
#   gathering auth login pandonia -p "your_api_key"
# ==============================================================================

# Copernicus Data Space Ecosystem (CDSE)
# Used for Sentinel-2 MSI, Sentinel-3 OLCI/SLSTR, Sentinel-5P TROPOMI
cdse:
  username: "your_email@domain.com"
  password: "your_cdse_password"

# EUMETSAT Data Access Client (EUMDAC)
# Used for MTG FCI, MSG SEVIRI, Metop IASI/GOME-2, Sentinel-3 (EUMETSAT marine stream)
eumdac:
  consumer_key: "your_eumetsat_consumer_key"
  consumer_secret: "your_eumetsat_consumer_secret"

# ESA EarthCARE (MAAP STAC / OADS)
# Used for EarthCARE ATLID, CPR, MSI, BBR, and synergy products
earthcare:
  username: "your_earthcare_username"
  password: "your_earthcare_password"
  maap_token: "your_optional_earthcare_maap_token"

# Pandonia Global Network (PGN)
# Used for Pandonia direct API data downloads
pandonia:
  api_key: "your_pandonia_api_key"

# NASA Earthdata Login
# Used for NASA MODIS & PACE satellite datasets
earthdata:
  username: "your_earthdata_username"
  password: "your_earthdata_password"

`credentials.env.example`¶

Built-in template: credentials.env.example
Generate locally: gathering auth env | Copy template: gathering examples copy credentials.env.example .env

You can copy this file to .env in your working directory or generate it using gathering auth env:

# ==============================================================================
# GATHERING - Environment Variables Configuration (.env) Example
# ==============================================================================

# Root Download & Cache Directory (optional, defaults to ~/.cache/gathering)
GATHERER_FOLDER=/home/user/satellite_data

# Copernicus Data Space Ecosystem (CDSE)
CDSE_USERNAME=your_email@domain.com
CDSE_PASSWORD=your_cdse_password

# EUMETSAT Data Access Client (EUMDAC)
EUMETSAT_CONSUMER_KEY=your_eumetsat_consumer_key
EUMETSAT_CONSUMER_SECRET=your_eumetsat_consumer_secret

# ESA EarthCARE (MAAP STAC / OADS)
EARTHCARE_USERNAME=your_earthcare_username
EARTHCARE_PASSWORD=your_earthcare_password
EARTHCARE_MAAP_TOKEN=your_optional_maap_token

# Pandonia Global Network (PGN)
PANDONIA_API_KEY=your_pandonia_api_key

# NASA Earthdata Login (MODIS & PACE)
EARTHDATA_USERNAME=your_earthdata_username
EARTHDATA_PASSWORD=your_earthdata_password

Credentials Templates¶

credentials.yaml.example¶

credentials.env.example¶

`credentials.yaml.example`¶

`credentials.env.example`¶