Skip to content

Commit 376b0bb

Browse files
committed
Minor cleanup: breaking up long lines, fixing namespace usage
1 parent 70a2621 commit 376b0bb

File tree

1 file changed

+32
-16
lines changed

1 file changed

+32
-16
lines changed

docs/mast/mast.rst

Lines changed: 32 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,10 @@ Criteria are supplied as keyword arguments, where valid criteria are "coordinate
6868
"objectname", "radius" (as in `~astroquery.mast.ObservationsClass.query_region` and
6969
`~astroquery.mast.ObservationsClass.query_object`), and all observation fields listed
7070
`here <https://mast.stsci.edu/api/v0/_c_a_o_mfields.html>`__.
71-
**Note:** The obstype keyword has been replaced by intentType, with valid values "calibration" and "science." If the intentType keyword is not supplied, both science and calibration observations will be returned.
71+
72+
**Note:** The obstype keyword has been replaced by intentType, with valid values
73+
"calibration" and "science." If the intentType keyword is not supplied, both
74+
science and calibration observations will be returned.
7275

7376
Argument values are one or more acceptable values for the criterion,
7477
except for fields with a float datatype where the argument should be in the form
@@ -194,7 +197,7 @@ default service set to 'search'.
194197

195198
.. code-block:: python
196199
197-
>>> from astroquery.mast.missions import MastMissions
200+
>>> from astroquery.mast import MastMissions
198201
>>> missions = MastMissions()
199202
>>> missions.mission
200203
'hst'
@@ -208,7 +211,7 @@ by using the ~astroquery.mast.MastMissionsClass.get_column_list function.
208211

209212
.. doctest-remote-data::
210213

211-
>>> from astroquery.mast.missions import MastMissions
214+
>>> from astroquery.mast import MastMissions
212215
>>> missions = MastMissions(mission='hst')
213216
>>> columns = missions.get_column_list()
214217

@@ -222,7 +225,7 @@ For a non positional search, select_cols would always include search_key and sci
222225

223226
.. doctest-remote-data::
224227

225-
>>> from astroquery.mast.missions import MastMissions
228+
>>> from astroquery.mast import MastMissions
226229
>>> from astropy.coordinates import SkyCoord
227230
>>> missions = MastMissions(mission='hst')
228231
>>> regionCoords = SkyCoord(210.80227, 54.34895, unit=('deg', 'deg'))
@@ -246,7 +249,7 @@ of returned records. the default values for offset and limit is 0 and 5000 respe
246249

247250
.. doctest-remote-data::
248251

249-
>>> from astroquery.mast.missions import MastMissions
252+
>>> from astroquery.mast import MastMissions
250253
>>> from astropy.coordinates import SkyCoord
251254
>>> missions = MastMissions()
252255
>>> results = missions.query_criteria(sci_start_time=">=2021-01-01 00:00:00",
@@ -432,7 +435,8 @@ with a `~astropy.table.Table` of data products, or a list (or single) obsid as t
432435
./mastDownload/IUE/lwp13058/lwp13058.mxlo.gz COMPLETE None None
433436
./mastDownload/IUE/lwp13058/lwp13058mxlo_vo.fits COMPLETE None None
434437

435-
​As an alternative to downloading the data files now, the ``curl_flag`` can be used instead to instead get a curl script that can be used to download the files at a later time.
438+
​As an alternative to downloading the data files now, the ``curl_flag`` can be used instead to instead get a curl
439+
script that can be used to download the files at a later time.
436440

437441
.. doctest-remote-data::
438442

@@ -474,15 +478,20 @@ Cloud Data Access
474478
Public datasets from the Hubble, Kepler and TESS telescopes are also available for free on Amazon Web Services
475479
in `public S3 buckets <https://registry.opendata.aws/collab/stsci/>`__.
476480

477-
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, TESS, and GALEX missions, follow the steps below:
481+
Using AWS resources to process public data no longer requires an AWS account for all AWS regions. To enable
482+
cloud data access for the Hubble, Kepler, TESS, and GALEX missions, follow the steps below:
478483

479-
You can enable cloud data access via the `~astroquery.mast.ObservationsClass.enable_cloud_dataset` function, which sets AWS to become the preferred source for data access as opposed to on-premise MAST until it is disabled with `~astroquery.mast.ObservationsClass.disable_cloud_dataset`.
484+
You can enable cloud data access via the `~astroquery.mast.ObservationsClass.enable_cloud_dataset` function,
485+
which sets AWS to become the preferred source for data access as opposed to on-premise MAST until it
486+
is disabled with `~astroquery.mast.ObservationsClass.disable_cloud_dataset`.
480487

481488
To directly access a list of cloud URIs for a given dataset, use the `~astroquery.mast.ObservationsClass.get_cloud_uris`
482489
function (Python will prompt you to enable cloud access if you haven't already).
483490

484491
When cloud access is enabled, the standard download function
485-
`~astroquery.mast.ObservationsClass.download_products` preferentially pulls files from AWS when they are available. When set to `True`, the ``cloud_only`` parameter in `~astroquery.mast.ObservationsClass.download_products` skips all data products not available in the cloud.
492+
`~astroquery.mast.ObservationsClass.download_products` preferentially pulls files from AWS when they are available.
493+
When set to `True`, the ``cloud_only`` parameter in `~astroquery.mast.ObservationsClass.download_products`
494+
skips all data products not available in the cloud.
486495

487496

488497
Getting a list of S3 URIs:
@@ -568,7 +577,8 @@ Downloading data products from S3:
568577
Catalog Queries
569578
===============
570579

571-
The Catalogs class provides access to a subset of the astronomical catalogs stored at MAST. The catalogs currently available through this interface are:
580+
The Catalogs class provides access to a subset of the astronomical catalogs stored at MAST.
581+
The catalogs currently available through this interface are:
572582

573583
- The Hubble Source Catalog (HSC)
574584
- The GALEX Catalog (V2 and V3)
@@ -583,7 +593,9 @@ Positional Queries
583593
------------------
584594

585595
Positional queries can be based on a sky position or a target name.
586-
The returned fields vary by catalog, find the field documentation for specific catalogs `here <https://mast.stsci.edu/api/v0/pages.html>`__. If no catalog is specified, the Hubble Source Catalog will be queried.
596+
The returned fields vary by catalog, find the field documentation for specific catalogs
597+
`here <https://mast.stsci.edu/api/v0/pages.html>`__.
598+
If no catalog is specified, the Hubble Source Catalog will be queried.
587599

588600
.. doctest-remote-data::
589601

@@ -822,7 +834,8 @@ Given an HSC Match ID, return all catalog results.
822834
410574498 63980492 ... -1.10056e-005 1.56577e-009 1.56577e-009 1.10056e-005
823835
410574497 63980492 ... -1.10056e-005 1.56577e-009 1.56577e-009 1.10056e-005
824836

825-
HSC spectra accessed through this class as well. `~astroquery.mast.CatalogsClass.get_hsc_spectra` does not take any arguments, and simply loads all HSC spectra.
837+
HSC spectra accessed through this class as well. `~astroquery.mast.CatalogsClass.get_hsc_spectra`
838+
does not take any arguments, and simply loads all HSC spectra.
826839

827840
.. doctest-remote-data::
828841

@@ -930,8 +943,9 @@ Requesting a cutout by moving_target accesses the
930943
`MAST Moving Target TESScut API <https://mast.stsci.edu/tesscut/docs/getting_started.html#moving-target-cutouts>`__
931944
and returns a target pixel file, with format described
932945
`here <https://astrocut.readthedocs.io/en/latest/astrocut/file_formats.html#path-focused-target-pixel-files>`__.
933-
The moving_target is an optional bool argument where `True` signifies that the accompanying ``objectname`` input is the object name or ID understood by the
934-
`JPL Horizon ephemerades interface <https://ssd.jpl.nasa.gov/horizons.cgi>`__. The default value for moving_target is set to False. Therefore, a non-moving target can be input simply with either the objectname or coordinates.
946+
The moving_target is an optional bool argument where `True` signifies that the accompanying ``objectname`` input is
947+
the object name or ID understood by the `JPL Horizon ephemerades interface <https://ssd.jpl.nasa.gov/horizons.cgi>`__.
948+
The default value for ``moving_target`` is set to `False`. Therefore, a non-moving target can be input simply with either the objectname or coordinates.
935949

936950
.. doctest-remote-data::
937951

@@ -950,7 +964,8 @@ The `~astroquery.mast.TesscutClass.download_cutouts` function takes a coordinate
950964
(in pixels or an angular quantity), or object name
951965
(i.e. "M104" or "TIC 32449963") and moving target (True or False). It uses these parameters to download the cutout target pixel file(s).
952966

953-
If a given coordinate/object/moving target appears in more than one TESS sector, a target pixel file will be produced for each sector. If the cutout area overlaps more than one camera or ccd, a target pixel file will be produced for each one.
967+
If a given coordinate/object/moving target appears in more than one TESS sector, a target pixel file will be produced for each sector.
968+
If the cutout area overlaps more than one camera or ccd, a target pixel file will be produced for each one.
954969

955970
.. doctest-remote-data::
956971

@@ -999,7 +1014,7 @@ To access sector information for a particular coordinate, object, or moving targ
9991014

10001015

10011016
.. doctest-remote-data::
1002-
1017+
10031018
>>> from astroquery.mast import Tesscut
10041019
...
10051020
>>> sector_table = Tesscut.get_sectors(objectname="Ceres", moving_target=True)
@@ -1010,6 +1025,7 @@ To access sector information for a particular coordinate, object, or moving targ
10101025
tess-s0043-3-3 43 3 3
10111026
tess-s0044-2-4 44 2 4
10121027

1028+
10131029
Zcut
10141030
====
10151031

0 commit comments

Comments
 (0)