Skip to content

Commit f699ae8

Browse files
bsipoczbsipocz
authored
Merge pull request #1948 from tinumide/gemini-doc-cleanup
Gemini documentation clean up
2 parents eee2e40 + 2159b0a commit f699ae8

File tree

1 file changed

+43
-52
lines changed

1 file changed

+43
-52
lines changed

‎docs/gemini/gemini.rst

Lines changed: 43 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
.. doctest-skip-all
2-
31
.. _astroquery.gemini:
42

53
************************************
@@ -12,48 +10,46 @@ Getting Started
1210
This module can be used to query the Gemini Archive. Below are examples of querying the data with various
1311
parameters.
1412

13+
1514
Positional Queries
1615
------------------
1716

1817
Positional queries can be based on a sky position. Radius is an optional parameter and the default is 0.3 degrees.
1918

20-
.. code-block:: python
2119

22-
>>> from astroquery.gemini import Observations
23-
>>> from astropy import coordinates, units
20+
.. doctest-remote-data::
2421

25-
>>> coord = coordinates.SkyCoord(210.80242917, 54.34875, unit="deg")
26-
>>> data = Observations.query_region(coordinates=coord, radius=0.3*units.deg)
27-
>>> print(data[0:5])
28-
29-
exposure_time detector_roi_setting detector_welldepth_setting telescope ...
30-
------------- -------------------- -------------------------- ------------ ...
31-
119.9986 Full Frame -- Gemini-North ...
32-
119.9983 Full Frame -- Gemini-North ...
33-
119.9986 Full Frame -- Gemini-North ...
34-
119.9983 Full Frame -- Gemini-North ...
35-
99.9983 Full Frame -- Gemini-North ...
22+
>>> from astroquery.gemini import Observations
23+
>>> from astropy import coordinates, units
24+
>>> coord = coordinates.SkyCoord(210.80242917, 54.34875, unit="deg")
25+
>>> data = Observations.query_region(coordinates=coord, radius=0.3*units.deg)
26+
>>> print(data[0:5])
27+
exposure_time detector_roi_setting ... release dec
28+
------------- -------------------- ... ---------- ---------------
29+
119.9986 Full Frame ... 2008-08-21 54.34877772501
30+
119.9983 Full Frame ... 2008-09-25 54.376194395654
31+
119.9986 Full Frame ... 2008-09-25 54.366916626746
32+
119.9983 Full Frame ... 2008-09-25 54.274527402457
33+
99.9983 Full Frame ... 2013-08-16 54.307561057825
3634

3735

3836
Observation Name Queries
3937
------------------------
4038

4139
You may also do a query by the name of the object you are interested in.
4240

43-
.. code-block:: python
41+
.. doctest-remote-data::
4442

4543
>>> from astroquery.gemini import Observations
46-
4744
>>> data = Observations.query_object(objectname='m101')
4845
>>> print(data[0:5])
49-
50-
exposure_time detector_roi_setting detector_welldepth_setting telescope ...
51-
------------- -------------------- -------------------------- ------------ ...
52-
119.9986 Full Frame -- Gemini-North ...
53-
119.9983 Full Frame -- Gemini-North ...
54-
119.9986 Full Frame -- Gemini-North ...
55-
119.9983 Full Frame -- Gemini-North ...
56-
99.9983 Full Frame -- Gemini-North ...
46+
exposure_time detector_roi_setting ... release dec
47+
------------- -------------------- ... ---------- ---------------
48+
-- Undefined ... 2013-12-21 --
49+
-- Undefined ... 2013-12-21 --
50+
49.9987 Full Frame ... 2013-08-28 54.348777039949
51+
49.9987 Full Frame ... 2013-08-28 54.346975563951
52+
49.9989 Full Frame ... 2013-08-28 54.347048438693
5753

5854

5955
Observation Criteria Queries
@@ -68,32 +64,31 @@ Some examples of available search fields are the instrument used, such as GMOS-N
6864
and the program ID. For a complete list of available search fields, see
6965
`~astroquery.gemini.ObservationsClass.query_criteria`
7066

71-
.. code-block:: python
67+
.. doctest-remote-data::
7268

7369
>>> from astroquery.gemini import Observations
74-
7570
>>> data = Observations.query_criteria(instrument='GMOS-N',
7671
... program_id='GN-CAL20191122',
7772
... observation_type='BIAS')
7873
>>> print(data[0:5])
74+
exposure_time detector_roi_setting detector_welldepth_setting ... release dec
75+
------------- -------------------- -------------------------- ... ---------- ---
76+
0.0 Central Stamp -- ... 2019-11-22 --
77+
0.0 Full Frame -- ... 2019-11-22 --
78+
0.0 Full Frame -- ... 2019-11-22 --
79+
0.0 Full Frame -- ... 2019-11-22 --
80+
0.0 Full Frame -- ... 2019-11-22 --
81+
7982

80-
exposure_time detector_roi_setting detector_welldepth_setting telescope mdready ...
81-
------------- -------------------- -------------------------- ------------ ------- ...
82-
0.0 Central Stamp -- Gemini-North True ...
83-
0.0 Full Frame -- Gemini-North True ...
84-
0.0 Full Frame -- Gemini-North True ...
85-
0.0 Full Frame -- Gemini-North True ...
86-
0.0 Full Frame -- Gemini-North True ...
8783

8884
In addition, the criteria query can accept additional parameters via the ``*rawqueryargs`` and ``**rawquerykwargs``
8985
optional parameters.
9086

9187
The ``orderby`` parameter can be used to pass the desired sort order.
9288

93-
.. code-block:: python
89+
.. doctest-remote-data::
9490

9591
>>> from astroquery.gemini import Observations
96-
9792
>>> data = Observations.query_criteria('centralspectrum',
9893
... instrument='GMOS-N',
9994
... program_id='GN-CAL20191122',
@@ -120,20 +115,18 @@ Note that *NotFail*, *notengineering*, *RAW*, and *cols* are all sent automatica
120115
terms need be passed into the method. If QA or engineering search terms are passed, those will replace
121116
the *NotFail* or *notengineering* terms respectively.
122117

123-
.. code-block:: python
118+
.. doctest-remote-data::
124119

125120
>>> from astroquery.gemini import Observations
126-
127121
>>> data = Observations.query_raw('GMOS-N', 'BIAS', progid='GN-CAL20191122')
128122
>>> print(data[0:5])
129-
130-
exposure_time detector_roi_setting detector_welldepth_setting telescope mdready ...
131-
------------- -------------------- -------------------------- ------------ ------- ...
132-
0.0 Central Stamp -- Gemini-North True ...
133-
0.0 Full Frame -- Gemini-North True ...
134-
0.0 Full Frame -- Gemini-North True ...
135-
0.0 Full Frame -- Gemini-North True ...
136-
0.0 Full Frame -- Gemini-North True ...
123+
exposure_time detector_roi_setting detector_welldepth_setting ... release dec
124+
------------- -------------------- -------------------------- ... ---------- ---
125+
0.0 Central Stamp -- ... 2019-11-22 --
126+
0.0 Full Frame -- ... 2019-11-22 --
127+
0.0 Full Frame -- ... 2019-11-22 --
128+
0.0 Full Frame -- ... 2019-11-22 --
129+
0.0 Full Frame -- ... 2019-11-22 --
137130

138131

139132
Authenticated Sessions
@@ -143,10 +136,9 @@ The Gemini module allows for authenticated sessions using your GOA account. Thi
143136
with on the GOA homepage at `<https://archive.gemini.edu/>`__. The `astroquery.gemini.ObservationsClass.login`
144137
method returns `True` if successful.
145138

146-
.. code-block:: python
139+
.. doctest-skip::
147140

148141
>>> from astroquery.gemini import Observations
149-
150142
>>> Observations.login(username, password)
151143
>>> # do something with your elevated access
152144

@@ -158,11 +150,10 @@ As a convenience, you can request file downloads directly from the Gemini module
158150
URL and fetches the file. It will use any authenticated session you may have, so it will retrieve any
159151
proprietary data you may be permissioned for.
160152

161-
.. code-block:: python
153+
.. doctest-remote-data::
162154

163155
>>> from astroquery.gemini import Observations
164-
165-
>>> Observations.get_file("GS2020AQ319-10.fits", download_dir="/tmp")
156+
>>> Observations.get_file("GS2020AQ319-10.fits", download_dir="/tmp") # doctest: +IGNORE_OUTPUT
166157

167158

168159
Reference/API

0 commit comments

Comments
 (0)