Skip to main content

CLI to download ESO raw and Phase3 archive data and metadata

Project description

eso-download

Command-line utility to query and download ESO Archive raw and Phase3 data.

Requirements

  • python>=3.10
  • astroquery>=0.4.12 (current pre-release v0.4.12.dev10525)

Usage examples

Raw archive

    $ eso-download raw --help
    $ eso-download raw --user <user> \
        --run-id "090.C-0733(A)" \
        --instrument FORS2
    $ eso-download raw --user <user> \
        --ra 129.0629 --dec -26.4093 \
        --max-rows 20
    $ eso-download raw --run-id '090.C-0733(A)' \
        --instrument FORS2 \
        --start-date 2013-01-01 --end-date 2013-04-01 \
        --file-cat SCIENCE \
        --max-rows 30 --metadata-only

Phase3 archive

    $ eso-download phase3 --help
    $ eso-download phase3 --user <user> \
        --proposal-id "094.B-0345(A)" \
        --collection MUSE
    $ eso-download phase3 --user <user> \
        --target-name "NGC 253"
    $ eso-download phase3 --proposal-id '275.A-5060(A)' \
        --instrument FORS2 \
        --target-name 'GDS J033223' \
        --ra 53.1 --dec -27.73\
        --publication-date-start 2014-07-11 --publication-date-end 2014-07-12 \
        --facility ESO-VLT-U1 \
        --max-rows 30 --metadata-only

Common options - count available records and query metadata only

    $ eso-download raw --count-only
    $ eso-download phase3 --metadata-only

Authenticate / Deauthenticate

  • To download proprietary data and metadata available only to user :

    $ eso-download [raw|phase3] --user <username>
    

    A password is required if not yet unauthenticated.

  • To delete a saved password (deauthenticate):

    $ eso-download [raw|phase3] --user <username> --deauthenticate
    

    Password for <username> will need to be re-entered next time.

General Usage

Phase3

$ eso-download phase3 -h
usage: eso-download phase3 [-h] [--user USER] [--deauthenticate] [--max-rows MAX_ROWS] [--with-calib {raw,processed}]
                           [--count-only] [--metadata-only] [--outdir OUTDIR] [--target-name TARGET_NAME] [--ra RA]
                           [--dec DEC] [--proposal-id PROPOSAL_ID] [--instrument INSTRUMENT] [--collection COLLECTION]
                           [--facility FACILITY] [--release-date-start RELEASE_DATE_START]
                           [--release-date-end RELEASE_DATE_END] [--publication-date-start PUBLICATION_DATE_START]
                           [--publication-date-end PUBLICATION_DATE_END]

options:
  -h, --help            show this help message and exit
  --user USER           ESO User Portal username; if provided, a password will be required
  --deauthenticate      Remove password from keyring. Use with --user <username>
  --max-rows MAX_ROWS
  --with-calib {raw,processed}
  --count-only          Print the count of records and exit
  --metadata-only       Save a csv with the matching records and exit
  --outdir OUTDIR
  --target-name TARGET_NAME
                        Target name (metadata match)
  --ra RA               Right Ascension in degrees
  --dec DEC             Declination in degrees
  --proposal-id PROPOSAL_ID
                        ESO Proposal ID (e.g. 094.B-0345(A))
  --instrument INSTRUMENT
                        Instrument name (e.g. MUSE)
  --collection COLLECTION
                        Observation collection name (e.g. MUSE)
  --facility FACILITY   Facility name (e.g. ESO-VLT-U4)
  --release-date-start RELEASE_DATE_START
                        Release date range start (YYYY-MM-DD)
  --release-date-end RELEASE_DATE_END
                        Release date range end (YYYY-MM-DD)
  --publication-date-start PUBLICATION_DATE_START
                        Publication date range start (YYYY-MM-DD)
  --publication-date-end PUBLICATION_DATE_END
                        Publication date range end (YYYY-MM-DD)

Raw

$ eso-download raw -h
usage: eso-download raw [-h] [--user USER] [--deauthenticate] [--max-rows MAX_ROWS] [--with-calib {raw,processed}]
                        [--count-only] [--metadata-only] [--outdir OUTDIR] [--target-name TARGET_NAME] [--ra RA] [--dec DEC]
                        [--run-id RUN_ID] [--instrument INSTRUMENT] [--file-cat {SCIENCE,CALIB,ACQUISITION}]
                        [--start-date START_DATE] [--end-date END_DATE]

options:
  -h, --help            show this help message and exit
  --user USER           ESO User Portal username; if provided, a password will be required
  --deauthenticate      Remove password from keyring. Use with --user <username>
  --max-rows MAX_ROWS
  --with-calib {raw,processed}
  --count-only          Print the count of records and exit
  --metadata-only       Save a csv with the matching records and exit
  --outdir OUTDIR
  --target-name TARGET_NAME
                        Target name (metadata match)
  --ra RA               Right Ascension (degrees)
  --dec DEC             Declination (degrees)
  --run-id RUN_ID       ESO Run ID (e.g. 090.C-0733(A))
  --instrument INSTRUMENT
                        Instrument name (e.g. FORS2)
  --file-cat {SCIENCE,CALIB,ACQUISITION}
  --start-date START_DATE
                        Start date YYYY-MM-DD
  --end-date END_DATE   End date YYYY-MM-DD


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

eso_download-0.1.dev13.tar.gz (12.4 kB view details)

Uploaded Source

Built Distribution

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

eso_download-0.1.dev13-py3-none-any.whl (8.2 kB view details)

Uploaded Python 3

File details

Details for the file eso_download-0.1.dev13.tar.gz.

File metadata

  • Download URL: eso_download-0.1.dev13.tar.gz
  • Upload date:
  • Size: 12.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.19

File hashes

Hashes for eso_download-0.1.dev13.tar.gz
Algorithm Hash digest
SHA256 df83635eb959683e67ffbd9ae21448f3cb38c70dafcaa33d1af80a7c4ddf7853
MD5 6b5618e99074e66d68abf106d1969802
BLAKE2b-256 0c25fecd302331df944ea4168027dceed75781b5a41073f61af9253220791af3

See more details on using hashes here.

File details

Details for the file eso_download-0.1.dev13-py3-none-any.whl.

File metadata

File hashes

Hashes for eso_download-0.1.dev13-py3-none-any.whl
Algorithm Hash digest
SHA256 cb7d302d02a80eee679c95ff143463dc645f70a0fe3b0e887cb8d922548ac6a6
MD5 1ab43b0cd81151866341dbf6c50d828d
BLAKE2b-256 0a360130b54de90d858159ec1d6710a9619dbce1338d4621ace2c57aa705a5dc

See more details on using hashes here.

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