Skip to content

Commit f686405

Browse files
committed
updating documentation to reflect new anonymous cloud access for dbs
1 parent 40ac26f commit f686405

File tree

1 file changed

+14
-20
lines changed

1 file changed

+14
-20
lines changed

docs/mast/mast.rst

Lines changed: 14 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -343,26 +343,21 @@ the *local_path* keyword argument.
343343
344344
Cloud Data Access
345345
------------------
346-
Public datasets from the Hubble, Kepler and TESS telescopes are also available on Amazon Web Services
346+
Public datasets from the Hubble, Kepler and TESS telescopes are also available for free on Amazon Web Services
347347
in `public S3 buckets <https://registry.opendata.aws/collab/stsci/>`__.
348348

349-
Using AWS resources to process public data requires an `AWS account <https://aws.amazon.com/>`__ and associated
350-
`credentials file <https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html>`__. The `boto3
351-
<https://boto3.amazonaws.com/v1/documentation/api/latest/index.html>`__ library is also required as it handles
352-
connections to the AWS servers. Instructions for creating AWS credentials are available `here
353-
<https://stackoverflow.com/questions/21440709/how-do-i-get-aws-access-key-id-for-amazon>`__. Data transfer charges
354-
are the responsibility of the requester (see `request pricing <https://aws.amazon.com/s3/pricing/>`__), however
355-
transfers are free within the US-East AWS region.
349+
Using AWS resources to process public data no longer requires an `AWS account for all AWS regions. To enable cloud data access for the Hubble, Kepler, and TESS missions, follow the steps below:
356350

357-
Cload data access is enabled using the `~astroquery.mast.ObservationsClass.enable_cloud_dataset` function, which
358-
will cause AWS to become the prefered source for data access until it is disabled
351+
Enable cloud data access via the `~astroquery.mast.ObservationsClass.enable_cloud_dataset` function, which
352+
will cause AWS to become the preferred source for data access until it is disabled
359353
(`~astroquery.mast.ObservationsClass.disable_cloud_dataset`).
360354

361355
To directly access a list of cloud URIs for a given dataset, use the `~astroquery.mast.ObservationsClass.get_cloud_uris`
362-
function, however when cloud access is enabled, the standatd download function
363-
`~astroquery.mast.ObservationsClass.download_products` will preferentially pull files from AWS when they are avilable.
364-
There is also a ``cloud_only`` flag, which when set to True will cause all data products not available in the
365-
cloud to be skipped.
356+
function (Python will prompt you to enable cloud access if you haven't already).
357+
358+
When cloud access is enabled, the standard download function
359+
`~astroquery.mast.ObservationsClass.download_products` will preferentially pull files from AWS when they are available.
360+
When set to `True`, the ``cloud_only`` parameter in `download_products` will cause all data products not available in the cloud to be skipped.
366361

367362

368363
Getting a list of S3 URIs:
@@ -770,7 +765,7 @@ be accessed in Astroquery by using the Tesscut class.
770765
After the user has reached this limit TESScut will return a
771766
``503 Service Temporarily Unavailable Error``.
772767
773-
If you use TESSCut for your work, please cite Brasseur et al. 2019
768+
If you use TESSCut for your work, please cite Brasseur et al. 2019
774769
https://ui.adsabs.harvard.edu/abs/2019ascl.soft05007B/abstract
775770
776771
@@ -870,9 +865,9 @@ Zcut
870865
====
871866
872867
873-
Zcut for MAST allows users to request cutouts from various Hubble deep field surveys. The cutouts can
874-
be returned as either fits or image files (jpg and png are supported). This tool can be accessed in
875-
Astroquery by using the Zcut class. The list of supported deep field surveys can be found here:
868+
Zcut for MAST allows users to request cutouts from various Hubble deep field surveys. The cutouts can
869+
be returned as either fits or image files (jpg and png are supported). This tool can be accessed in
870+
Astroquery by using the Zcut class. The list of supported deep field surveys can be found here:
876871
https://mast.stsci.edu/zcut/
877872
878873
@@ -882,7 +877,7 @@ Cutouts
882877
The `~astroquery.mast.ZcutClass.get_cutouts` function takes a coordinate and cutout size (in pixels or
883878
an angular quantity) and returns the cutout FITS file(s) as a list of ~astropy.io.fits.HDUList objects.
884879
885-
If the given coordinate appears in more than one Zcut survey, a FITS file will be produced for each survey.
880+
If the given coordinate appears in more than one Zcut survey, a FITS file will be produced for each survey.
886881
887882
.. code-block:: python
888883
@@ -1084,4 +1079,3 @@ Reference/API
10841079
.. automodapi:: astroquery.mast
10851080
:no-inheritance-diagram:
10861081
:inherited-members:
1087-

0 commit comments

Comments
 (0)