eso-downloader
==============
A python package which provides an easy way to download data for a given ESO
observational program ID.
Getting started
...............
To run eso-downloader, you will need to add your ESO portal username and
password to the system keyring (the secure place to store login details), and
create a config file detailing where to put the data.
Storing passwords/credentials
-----------------------------
This package uses the keyring package (https://pypi.org/project/keyring) to
store passwords and other credentials. If keyring is unable to find a place to
store and read secrets from, see how to configure keyring at
https://keyring.readthedocs.io/en/stable/#configuring.
To add your password to the keyring on your system, run::
keyring set eso-downloader <your ESO portal username>
and enter your ESO portal password (in the future, we hope that there will be
long-lasting tokens so that we do not need to store the portal password
directly).
To confirm that the password is saved, run::
keyring get eso-downloader <your ESO portal username>
Creating a config file
----------------------
An initial starter config file (in ``.ini`` format) would be::
[DEFAULT]
username = <your ESO portal username>
base_dir = <where you want to save the downloaded data>
If you need to use different paths or different usernames for particular
programs, you can add sections for specific programs e.g.::
[103.20AX.101]
username = <some other username>
or::
[98.13BA.215]
base_dir = <some other directory>
Running the script
------------------
The script will use the config file and the list of program IDs passed to it to
download in parallel all the files needed for the reduction of the found science
files, skipping those already downloaded (see algorithm below).
Doing::
eso-downloader --config <path_to_config_file> <program_id> <program_id> ...
will start the download. If sent `SIGTERM`, the script will stop requesting new
files, and finish downloading the files it was working on.
Raw data
{
"_id": null,
"home_page": "https://eso_downloader.readthedocs.io",
"name": "eso-downloader",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "ESO archive download astronomy astropy",
"author": "James Tocknell",
"author_email": "james.tocknell@mq.edu.au",
"download_url": "https://files.pythonhosted.org/packages/85/12/a7eaf8b901d14ebf0bb0272ee00939c79f65b425990ef07f0d1b91b0e38b/eso-downloader-0.1.tar.gz",
"platform": null,
"description": "eso-downloader\n==============\nA python package which provides an easy way to download data for a given ESO\nobservational program ID.\n\nGetting started\n...............\nTo run eso-downloader, you will need to add your ESO portal username and\npassword to the system keyring (the secure place to store login details), and\ncreate a config file detailing where to put the data.\n\nStoring passwords/credentials\n-----------------------------\nThis package uses the keyring package (https://pypi.org/project/keyring) to\nstore passwords and other credentials. If keyring is unable to find a place to\nstore and read secrets from, see how to configure keyring at\nhttps://keyring.readthedocs.io/en/stable/#configuring.\n\nTo add your password to the keyring on your system, run::\n\n keyring set eso-downloader <your ESO portal username>\n\nand enter your ESO portal password (in the future, we hope that there will be\nlong-lasting tokens so that we do not need to store the portal password\ndirectly).\nTo confirm that the password is saved, run::\n\n keyring get eso-downloader <your ESO portal username>\n\nCreating a config file\n----------------------\nAn initial starter config file (in ``.ini`` format) would be::\n\n [DEFAULT]\n username = <your ESO portal username>\n base_dir = <where you want to save the downloaded data>\n\nIf you need to use different paths or different usernames for particular\nprograms, you can add sections for specific programs e.g.::\n\n [103.20AX.101]\n username = <some other username>\n\nor::\n\n [98.13BA.215]\n base_dir = <some other directory>\n\nRunning the script\n------------------\nThe script will use the config file and the list of program IDs passed to it to\ndownload in parallel all the files needed for the reduction of the found science\nfiles, skipping those already downloaded (see algorithm below).\n\nDoing::\n\n eso-downloader --config <path_to_config_file> <program_id> <program_id> ...\n\nwill start the download. If sent `SIGTERM`, the script will stop requesting new\nfiles, and finish downloading the files it was working on.\n",
"bugtrack_url": null,
"license": "3-clause BSD",
"summary": "Downloader for public and proprietary ESO archive data",
"version": "0.1",
"project_urls": {
"Documentation": "https://eso-downloader.readthedocs.io",
"Homepage": "https://eso_downloader.readthedocs.io",
"Source": "https://dev.aao.org.au/adacs/eso-downloader/",
"Tracker": "https://dev.aao.org.au/adacs/eso-downloader/issues"
},
"split_keywords": [
"eso",
"archive",
"download",
"astronomy",
"astropy"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8512a7eaf8b901d14ebf0bb0272ee00939c79f65b425990ef07f0d1b91b0e38b",
"md5": "eaa9f1666057ccf2acc9d43ce45d00c2",
"sha256": "9ac0e77435e2b7fd2e2086217c883ad8e0596032a829401638c02ecebb595361"
},
"downloads": -1,
"filename": "eso-downloader-0.1.tar.gz",
"has_sig": false,
"md5_digest": "eaa9f1666057ccf2acc9d43ce45d00c2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 50442,
"upload_time": "2023-06-28T03:40:53",
"upload_time_iso_8601": "2023-06-28T03:40:53.733461Z",
"url": "https://files.pythonhosted.org/packages/85/12/a7eaf8b901d14ebf0bb0272ee00939c79f65b425990ef07f0d1b91b0e38b/eso-downloader-0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-28 03:40:53",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "eso-downloader"
}
JSON