nsidc_icesat2_sync_s3.py

  • Syncs all available ICESat-2 data for a specified data product, release, granule and track and transfers to an AWS S3 bucket using a local machine as pass through

Source code

Calling Sequence

usage: nsidc_icesat2_sync_s3.py [-h] [--user USER] [--password PASSWORD]
                                [--netrc NETRC] --aws-access-key-id
                                AWS_ACCESS_KEY_ID --aws-secret-access-key
                                AWS_SECRET_ACCESS_KEY
                                [--aws-region-name AWS_REGION_NAME]
                                --s3-bucket-name S3_BUCKET_NAME
                                [--s3-bucket-path S3_BUCKET_PATH]
                                [--year YEAR [YEAR ...]]
                                [--subdirectory SUBDIRECTORY [SUBDIRECTORY ...]]
                                [--release RELEASE]
                                [--version VERSION [VERSION ...]]
                                [--granule GRANULE [GRANULE ...]]
                                [--cycle CYCLE [CYCLE ...]]
                                [--region REGION [REGION ...]]
                                [--track RGT [RGT ...]] [--auxiliary]
                                [--index INDEX] [--flatten] [--np PROCESSES]
                                [--timeout TIMEOUT] [--retry RETRY]
                                [--clobber]
                                [PRODUCTS ...]

Positional Arguments

PRODUCTS

ICESat-2 products to sync

Named Arguments

--user, -U

Username for NASA Earthdata Login

--password, -W

Password for NASA Earthdata Login

--netrc, -N

Path to .netrc file for authentication

--aws-access-key-id

AWS Access Key ID

--aws-secret-access-key

AWS Secret Key

--aws-region-name

AWS Region Name

--s3-bucket-name

AWS S3 Bucket Name

--s3-bucket-path

AWS S3 Bucket Path

--year, -Y

Years to sync

--subdirectory, -S

subdirectories of data to sync

--release, -r

ICESat-2 Data Release

--version, -v

ICESat-2 Data Version

--granule, -g

Possible choices: 1–14

ICESat-2 Granule Region

--cycle, -c

ICESat-2 orbital cycles to sync

--region, -n

Possible choices: AA, AK, CN, CS, GL, IC, SV, RU

ICESat-2 Named Region (ATL14/ATL15)

--track, -t

Possible choices: 1–1387

ICESat-2 Reference Ground Tracks (RGTs)

--auxiliary, -a

Sync ICESat-2 auxiliary files for each HDF5 file

--index, -i

Input index of ICESat-2 files to sync

--flatten, -F

Do not create subdirectories

--np, -P

Number of processes to use in file downloads

--timeout, -T

Timeout in seconds for blocking operations

--retry, -R

Connection retry attempts

--clobber, -C

Overwrite existing data