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-min 2014-07-11 --publication-date-max 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-min RELEASE_DATE]
                           [--release-date-max RELEASE_DATE] [--publication-date-min PUBLICATION_DATE]
                           [--publication-date-max PUBLICATION_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 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-min RELEASE_DATE
                        Release date range start (YYYY-MM-DD)
  --release-date-max RELEASE_DATE
                        Release date range end (YYYY-MM-DD)
  --publication-date-min PUBLICATION_DATE
                        Publication date range start (YYYY-MM-DD)
  --publication-date-max PUBLICATION_DATE
                        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.dev15.tar.gz (12.3 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.dev15-py3-none-any.whl (8.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: eso_download-0.1.dev15.tar.gz
  • Upload date:
  • Size: 12.3 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.dev15.tar.gz
Algorithm Hash digest
SHA256 6955046f690abcfb007fb94d6bd69e1bbf6a6d50998db6afbc7fa41e31bd8c62
MD5 04279a1735f898e4ff68f87396b8ce41
BLAKE2b-256 4e6d9b2a192cbd43ae2e1922c2b49ae7582440bf692c0d7176fb740541a7545d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for eso_download-0.1.dev15-py3-none-any.whl
Algorithm Hash digest
SHA256 fd4533de0ce8c45dec62953ae52dd96332494e1a5fa2c333fa16d9e1aefe305b
MD5 b5b075940ca5be1a27b25c43f98cbd2b
BLAKE2b-256 fa8f04d34ca3c49cf144235143a3e0dcd7a4691c5638e0c793328aa5b0dd27b1

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