|
5105 | 5105 | "text": [ |
5106 | 5106 | "Help on function ecco_podaac_s3_get in module ecco_s3_retrieve:\n", |
5107 | 5107 | "\n", |
5108 | | - "ecco_podaac_s3_get(ShortName, StartDate, EndDate, download_root_dir=None, n_workers=6,\n" |
| 5108 | + "ecco_podaac_s3_get(ShortName, StartDate, EndDate, download_root_dir=None, n_workers=6,\n", |
5109 | 5109 | " force_redownload=False, return_downloaded_files=False)\n", |
5110 | | - " This routine downloads ECCO datasets from PO.DAAC, to be stored locally on a AWS EC2 instance running in region us-west-2. \n", |
5111 | | - " It is adapted from the ecco_podaac_download function in the ecco_download.py module, and is the AWS Cloud equivalent of \n", |
5112 | | - " ecco_podaac_download.\n", |
| 5110 | + " This routine downloads ECCO datasets from PO.DAAC, to be stored locally on a AWS EC2 instance running in \n", |
| 5111 | + " region us-west-2. It is adapted from the ecco_podaac_download function in the ecco_download.py module, \n", |
| 5112 | + " and is the AWS Cloud equivalent of ecco_podaac_download.\n", |
5113 | 5113 | " \n", |
5114 | 5114 | " Parameters\n", |
5115 | 5115 | " ----------\n", |
|
5132 | 5132 | " force_redownload: bool, if True, existing files will be redownloaded and replaced;\n", |
5133 | 5133 | " if False, existing files will not be replaced.\n", |
5134 | 5134 | " \n", |
5135 | | - " return_downloaded_files: bool, if True, string or list of downloaded file(s) (including files that were already on disk\n", |
5136 | | - " and not replaced) is returned.\n", |
5137 | | - " if False (default), the function returns nothing.\n", |
| 5135 | + " return_downloaded_files: bool, if True, string or list of downloaded file(s) (including files that were \n", |
| 5136 | + " already on disk and not replaced) is returned.\n", |
| 5137 | + " If False (default), the function returns nothing.\n", |
5138 | 5138 | " \n", |
5139 | 5139 | " Returns\n", |
5140 | 5140 | " -------\n", |
|
5324 | 5324 | " If the footprint of the files to be downloaded (not including files already on the instance or re-downloads) \n", |
5325 | 5325 | " is <= the max_avail_frac specified of the instance's available storage, they are downloaded and stored locally \n", |
5326 | 5326 | " on the instance (hosting files locally typically speeds up loading and computation).\n", |
5327 | | - " Otherwise, the files are "opened" using ecco_podaac_s3_open so that they can be accessed directly \n", |
| 5327 | + " Otherwise, the files are \"opened\" using ecco_podaac_s3_open so that they can be accessed directly \n", |
5328 | 5328 | " on S3 without occupying local storage.\n", |
5329 | 5329 | " \n", |
5330 | 5330 | " Parameters\n", |
|
0 commit comments