Skip to content

Commit

Permalink
attemp to fix doctest
Browse files Browse the repository at this point in the history
  • Loading branch information
zoghbi-a committed Oct 18, 2023
1 parent e7f5571 commit 68659c3
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/utils/download.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ This is an example of downloading data when an URL or URI are available:
>>> image_file = http_download(url=data_url)
>>> s3_uri = 's3://nasa-heasarc/chandra/data/byobsid/2/3052/primary/acisf03052N004_cntr_img2.jpg'
>>> image2_file = aws_download(uri=s3_uri)
Downloading chandra/data/byobsid/2/3052/primary/acisf03052N004_cntr_img2.jpg to acisf03052N004_cntr_img2.jpg ... [Done]


A bucket name and a key can also be passed to `~pyvo.utils.download.aws_download` instead of an URI:
Expand All @@ -33,6 +34,7 @@ A bucket name and a key can also be passed to `~pyvo.utils.download.aws_download
>>> s3_key = 'chandra/data/byobsid/2/3052/primary/acisf03052N004_cntr_img2.jpg'
>>> s3_bucket = 'nasa-heasarc'
>>> image2_file = aws_download(bucket_name=s3_bucket, key=s3_key)
Downloading chandra/data/byobsid/2/3052/primary/acisf03052N004_cntr_img2.jpg to acisf03052N004_cntr_img2.jpg ... [Done]


If the aws data requires authentication, a credential profile (e.g. ``aws_user`` profile in ``~/.aws/credentials``) can be passed:
Expand Down

0 comments on commit 68659c3

Please sign in to comment.