Skip to content

Commit 92b74aa

Browse files
updated gemini doc
1 parent 3dcc1cd commit 92b74aa

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

docs/gemini/gemini.rst

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,11 @@ Positional queries can be based on a sky position. Radius is an optional parame
1919

2020
.. code-block:: python
2121
22-
>>> from astroquery.gemini import Observations
22+
>>> from astroquery.gemini import GeminiObservations
2323
>>> from astropy import coordinates, units
2424
2525
>>> coord = coordinates.SkyCoord(210.80242917, 54.34875, unit="deg")
26-
>>> data = Observations.query_region(coordinates=coord, radius=0.3*units.deg)
26+
>>> data = GeminiObservations.query_region(coordinates=coord, radius=0.3*units.deg)
2727
>>> print(data[0:5])
2828
2929
exposure_time detector_roi_setting detector_welldepth_setting telescope ...
@@ -42,9 +42,9 @@ You may also do a query by the name of the object you are interested in.
4242

4343
.. code-block:: python
4444
45-
>>> from astroquery.gemini import Observations
45+
>>> from astroquery.gemini import GeminiObservations
4646
47-
>>> data = Observations.query_object(objectname='m101')
47+
>>> data = GeminiObservations.query_object(objectname='m101')
4848
>>> print(data[0:5])
4949
5050
exposure_time detector_roi_setting detector_welldepth_setting telescope ...
@@ -59,18 +59,18 @@ You may also do a query by the name of the object you are interested in.
5959
Observation Criteria Queries
6060
----------------------------
6161

62-
Additional search terms are available as optional arguments to the `~astroquery.gemini.ObservationsClass.query_criteria`
62+
Additional search terms are available as optional arguments to the `~astroquery.gemini.GeminiObservationsClass.query_criteria`
6363
call. These all have default values of None, in which case they will not be considered during the search.
6464

6565
Some examples of available search fields are the instrument used, such as GMOS-N, the observation_type, such as BIAS,
6666
and the program ID. For a complete list of available search fields, see
67-
`~astroquery.gemini.ObservationsClass.query_criteria`
67+
`~astroquery.gemini.GeminiObservationsClass.query_criteria`
6868

6969
.. code-block:: python
7070
71-
>>> from astroquery.gemini import Observations
71+
>>> from astroquery.gemini import GeminiObservations
7272
73-
>>> data = Observations.query_criteria(instrument='GMOS-N',
73+
>>> data = GeminiObservations.query_criteria(instrument='GMOS-N',
7474
... program_id='GN-CAL20191122',
7575
... observation_type='BIAS')
7676
>>> print(data[0:5])
@@ -90,9 +90,9 @@ The ``orderby`` parameter can be used to pass the desired sort order.
9090

9191
.. code-block:: python
9292
93-
>>> from astroquery.gemini import Observations
93+
>>> from astroquery.gemini import GeminiObservations
9494
95-
>>> data = Observations.query_criteria('centralspectrum',
95+
>>> data = GeminiObservations.query_criteria('centralspectrum',
9696
... instrument='GMOS-N',
9797
... program_id='GN-CAL20191122',
9898
... observation_type='BIAS',
@@ -118,9 +118,9 @@ terms need be passed into the method.
118118

119119
.. code-block:: python
120120
121-
>>> from astroquery.gemini import Observations
121+
>>> from astroquery.gemini import GeminiObservations
122122
123-
>>> data = Observations.query_raw('GMOS-N', 'BIAS', progid='GN-CAL20191122')
123+
>>> data = GeminiObservations.query_raw('GMOS-N', 'BIAS', progid='GN-CAL20191122')
124124
>>> print(data[0:5])
125125
126126
exposure_time detector_roi_setting detector_welldepth_setting telescope mdready ...
@@ -136,14 +136,14 @@ Authenticated Sessions
136136
----------------------
137137

138138
The Gemini module allows for authenticated sessions using your GOA account. This is the same account you login
139-
with on the GOA homepage at `<https://archive.gemini.edu/>`__. The `astroquery.gemini.ObservationsClass.login`
139+
with on the GOA homepage at `<https://archive.gemini.edu/>`__. The `astroquery.gemini.GeminiObservationsClass.login`
140140
method returns `True` if successful.
141141

142142
.. code-block:: python
143143
144-
>>> from astroquery.gemini import Observations
144+
>>> from astroquery.gemini import GeminiObservations
145145
146-
>>> Observations.login(username, password)
146+
>>> GeminiObservations.login(username, password)
147147
>>> # do something with your elevated access
148148
149149
@@ -156,9 +156,9 @@ proprietary data you may be permissioned for.
156156

157157
.. code-block:: python
158158
159-
>>> from astroquery.gemini import Observations
159+
>>> from astroquery.gemini import GeminiObservations
160160
161-
>>> Observations.get_file("GS2020AQ319-10.fits", download_dir="/tmp")
161+
>>> GeminiObservations.get_file("GS2020AQ319-10.fits", download_dir="/tmp")
162162
163163
164164
Reference/API

0 commit comments

Comments
 (0)