Skip to main content

Download EarthCARE satellite data

Project description

earthcare-downloader

CI PyPI version

A Python tool for downloading EarthCARE satellite data

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 --lat LAT --lon LON [options]

where the arguments are:

Argument Description
-p, --product Product type to download (see full list below).
--lat LAT Latitude of the target location.
--lon LON Longitude of the target location.
-d, --distance Search radius around the location in km (default: 200).
--start Start date (YYYY-MM-DD).
--stop Stop date (YYYY-MM-DD).
--orbit-min Minimum orbit number (default: 0).
--orbit-max Maximum orbit number (default: infinite).
-o, --output-path Directory to save downloaded files (default: current directory).
--max-workers Maximum number of concurrent downloads (default: 5).
--show Show filenames before downloading.
--unzip Automatically unzip downloaded files (keeps only .h5 files).
--quiet Hide progress bars during download.
--no-prompt Skip confirmation prompt before downloading.
-h, --help Show help message and exit.

Available products:

Level Product Code Description
Level 1 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_ARE_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 Water Content
ATL_TC__2A ATLID Target Classification
CPR_CD__2A CPR Cloud Droplet
CPR_CLD_2A CPR Cloud Parameters
CPR_FMR_2A CPR Feature Mask and 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
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

Examples

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

earthcare-downloader --lat 61.844 --lon 24.287 --distance 5 --product CPR_TC__2A

:snake: Python API

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

from earthcare_downloader import search, download

urls = search(product="CPR_TC__2A", lat=61.844, lon=24.287, distance=5)
paths = download(urls, output_path="data/", unzip=True)

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

from earthcare_downloader.aio import search, download

urls = await search(product="CPR_TC__2A", lat=61.844, lon=24.287, distance=5)
paths = await download(urls, output_path="data/", unzip=True, quiet=True)

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.1.0.tar.gz (513.4 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.1.0-py3-none-any.whl (12.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: earthcare_downloader-1.1.0.tar.gz
  • Upload date:
  • Size: 513.4 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.1.0.tar.gz
Algorithm Hash digest
SHA256 505e25def02e6cab096dd82dda50a0a1576cc250a18f43bea30d8bcc8a837c12
MD5 21dfa1373bc5b1fbccfc4f431475cc91
BLAKE2b-256 fa4b5d2cb3a0c765d3941a937e5b747eb191e79056e8043f4f49c48b12013b0d

See more details on using hashes here.

Provenance

The following attestation bundles were made for earthcare_downloader-1.1.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.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for earthcare_downloader-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e77edb35918d8bd2e7b2ed7e4827233e750bbead75455ddc86328a3992ab2cd7
MD5 08bc838464782dee61f4a31693807720
BLAKE2b-256 bb1c52693156f3ead815627f7b177392e60ebeab789b5bd360655abc3e1d6ffb

See more details on using hashes here.

Provenance

The following attestation bundles were made for earthcare_downloader-1.1.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