Skip to main content

Download EarthCARE satellite data

Project description

earthcare-downloader

CI PyPI version

A Python tool for searching and downloading EarthCARE satellite data from the European Space Agency’s (ESA) Online Dissemination services.

Installation

python3 -m pip install earthcare-downloader

:penguin: CLI usage

Authentication

Store your ESA EO Sign In credentials in the environment variables ESA_EO_USERNAME and ESA_EO_PASSWORD. If these variables are not set, the program will prompt you to enter your credentials.

Running the program

earthcare-downloader -p PRODUCT [options]

where the arguments are:

Argument Description
-p, --product Product type(s) to download (see full list below).
--start Start date (YYYY-MM-DD).
--stop Stop date (YYYY-MM-DD).
-d, --date Single date (YYYY-MM-DD). Overrides --start and --stop
--orbit-min Minimum orbit number.
--orbit-max Maximum orbit number.
--orbit Single orbit number. Overrides --orbit-min and --orbit-max
--lat LAT Latitude of the target location (-90..90 degrees). Use with --lon and -r
--lon LON Longitude of the target location (-180..180 degrees). Use with --lat and -r
-r, --radius Search radius around the location in km. Use with --lat and --lon.
--lat-range LAT1,LAT2 Latitude range (min_lat,max_lat) to search for data. Use with --lon-range.
--lon-range LON1,LON2 Longitude range (min_lon,max_lon) to search for data. Use with --lat-range.
-o, --output-path Directory to save downloaded files (default: current directory).
--by-product Create subdirectories for each product type.
--max-workers Maximum number of concurrent downloads (default: 5).
--show Show filenames before downloading.
--no-unzip Do not unzip downloaded files. By default the files are unzipped.
-q, --quiet Hide progress bars during download.
--no-prompt Skip confirmation prompt before downloading.
--all Download all versions of the file. By default download only the newest version.
-f, --force Force downloading, even if file with the same name exists in the target folder.
-h, --help Show help message and exit.

Available products:

Level 1 Product Code Description
ATL_NOM_1B ATLID Nominal Mode
AUX_JSG_1D Auxiliary Joint Standard Grid
BBR_NOM_1B Broadband Radiometer Nominal Mode
BBR_SNG_1B Broadband Radiometer Single View
CPR_NOM_1B Cloud Profiling Radar Nominal Mode
MSI_NOM_1B Multi-Spectral Imager Nominal Mode
MSI_RGR_1C Multi-Spectral Imager Re-Gridded
Level 2A
ATL_AER_2A ATLID Aerosol Parameters
ATL_ALD_2A ATLID Aerosol Layer Descriptors
ATL_CTH_2A ATLID Cloud Top Height
ATL_EBD_2A ATLID Extinction, Backscatter and Depolarization
ATL_FM__2A ATLID Feature Mask
ATL_ICE_2A ATLID Ice Parameters
ATL_TC__2A ATLID Target Classification
CPR_CD__2A CPR Cloud Doppler parameters
CPR_CLD_2A CPR Cloud Parameters
CPR_FMR_2A CPR Feature Mask and Radar Reflectivity
CPR_TC__2A CPR Target Classification
MSI_AOT_2A MSI Aerosol Optical Thickness
MSI_CM__2A MSI Cloud Mask
MSI_COP_2A MSI Cloud Optical Properties
:japanese_castle: ATL_CLA_2A ATLID Cloud and Aerosol Classification
:japanese_castle: CPR_CLP_2A CPR Cloud Properties
:japanese_castle: CPR_ECO_2A CPR Echo Characteristics
:japanese_castle: MSI_CLP_2A MSI Cloud Properties
Level 2B
AC__TC__2B ATLID-CPR Target Classification
AM__ACD_2B ATLID-MSI Aerosol Column Descriptors
AM__CTH_2B ATLID-MSI Cloud Top Height
BM__RAD_2B BBR-MSI Radiative Fluxes and Heating Rates
:japanese_castle: AC__CLP_2B CPR-ATLID Synergy Cloud Properties
Orbit Data
AUX_ORBPRE Orbit Predictions
MPL_ORBSCT Orbit Scenario
MET Data
AUX_MET_1D ECMWF meteorological parameters

:japanese_castle: = JAXA product

Examples

Download all CPR_TC__2A overpass data within 5 km of Hyytiälä, Finland:

earthcare-downloader -p CPR_TC__2A --lat 61.844 --lon 24.287 -r 5

Download all ATL_ALD_2A and AUX_JSG_1D data from two days:

earthcare-downloader -p ATL_ALD_2A,AUX_JSG_1D --start=2025-05-01 --stop=2025-05-02

:snake: Python API

You can also use earthcare-downloader as a Python library:

from earthcare_downloader import search, download

files = search(product="CPR_TC__2A", date="2025-01-01")
paths = download(files)

When working in notebooks, use the asynchronous versions of these functions:

from earthcare_downloader.aio import search, download

files = await search(product="CPR_TC__2A", date="2025-01-01")
paths = await download(files)

Disclaimer

This package provides tools to access data from the European Space Agency’s (ESA) Online Dissemination services. The package does not host or redistribute ESA data.

All data are © European Space Agency (ESA) and subject to the ESA Online Dissemination Terms and Conditions. Please ensure your use complies with ESA’s non-commercial and attribution requirements.

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

earthcare_downloader-1.10.0.tar.gz (518.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

earthcare_downloader-1.10.0-py3-none-any.whl (17.9 kB view details)

Uploaded Python 3

File details

Details for the file earthcare_downloader-1.10.0.tar.gz.

File metadata

  • Download URL: earthcare_downloader-1.10.0.tar.gz
  • Upload date:
  • Size: 518.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for earthcare_downloader-1.10.0.tar.gz
Algorithm Hash digest
SHA256 f30f5a4a870fa0654d5dc47a925548342ca3e4355d277eaec1fe0c419c453b41
MD5 8910cab09ca4f6f229c344bc5c6c6883
BLAKE2b-256 b2d702b41b1ded7dcaa9604759e5a6fa56f692eba58f671c4804974b838172c2

See more details on using hashes here.

Provenance

The following attestation bundles were made for earthcare_downloader-1.10.0.tar.gz:

Publisher: publish.yml on actris-cloudnet/earthcare-downloader

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file earthcare_downloader-1.10.0-py3-none-any.whl.

File metadata

File hashes

Hashes for earthcare_downloader-1.10.0-py3-none-any.whl
Algorithm Hash digest
SHA256 513b80ba995b36cbae91147889b158109f189bcd786ed62508573ef43499765d
MD5 244d1142f042b60f5fcdd626cc6b1d7b
BLAKE2b-256 ab49a8fe1380d5fd99bd77dea0041337f7e7f7579912749ec26505c4c0c048f7

See more details on using hashes here.

Provenance

The following attestation bundles were made for earthcare_downloader-1.10.0-py3-none-any.whl:

Publisher: publish.yml on actris-cloudnet/earthcare-downloader

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page