YAML Examples Gallery¶

Gathering includes a comprehensive library of 22+ ready-to-use YAML configuration files packaged directly inside the distribution. You can run them out-of-the-box, export them to your working directory, or copy and paste the YAML blocks shown in this gallery.

Managing Built-in Examples¶

You can inspect, export, or run built-in examples directly with the CLI:

# List all packaged examples grouped by category
gathering examples list

# View the full contents of an example in your terminal
gathering examples show aeronet/aeronet_aod_inversions.yaml

# Copy an example to your current directory for customization
gathering examples copy cdse/cdse_sentinel2_msi.yaml .

Running Examples¶

# Run a built-in example directly using the example: prefix
gathering run example:multi_source_campaign_pipeline.yaml

# Or with verbose logging
gathering --verbose run example:cdse/cdse_sentinel2_msi.yaml

# Run your locally customized copy
gathering run cdse_sentinel2_msi.yaml

from gathering import copy_example, list_examples, run_from_yaml

# List all available packaged examples
print(list_examples())

# Run any built-in example directly
results = run_from_yaml("example:multi_source_campaign_pipeline.yaml")
print(f"Downloaded {len(results.files)} file(s):")
for path in results.files:
    print(f" - {path}")

Directory Overview¶

Exploring Examples by Domain¶

Browse through the dedicated subsections to view and copy individual YAML files:

• Multi-Source Campaign: Complete campaign orchestrating 8 sources concurrently.
• Ground-Based Networks: AERONET, Pandonia, ACTRIS ARES, ACTRIS Cloudnet.
• NASA Satellites: MODIS (Terra, Aqua, Combined) and PACE (OCI, HARP2, SPEXone).
• Copernicus CDSE Satellites: Sentinel-2 MSI, Sentinel-3 OLCI, Sentinel-5P TROPOMI.
• EUMETSAT Data Store Satellites: MTG FCI, MSG SEVIRI, Metop IASI/AVHRR, Sentinel streams.
• ESA EarthCARE Satellite: ATLID Lidar, CPR Radar, MSI Imager.
• Credentials Templates: Templates for credentials.yaml and .env.