Skip to content

Commit 6b34f88

Browse files
tinuademargaretbsipocz
authored andcommitted
irsa doc cleanup
1 parent 3cdf684 commit 6b34f88

File tree

1 file changed

+12
-14
lines changed

1 file changed

+12
-14
lines changed

docs/irsa/irsa.rst

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

53
********************************
@@ -26,10 +24,10 @@ the catalog in the IRSA database, on which the query must be performed. To take
2624
a look at all the available catalogs:
2725

2826
.. code-block:: python
27+
.. doctest-remote-data::
2928

3029
>>> from astroquery.irsa import Irsa
31-
>>> Irsa.list_catalogs()
32-
30+
>>> Irsa.list_catalogs() # doctest: +IGNORE_OUTPUT
3331
{'a1763t2': 'Abell 1763 Source Catalog',
3432
'a1763t3': 'Abell 1763 MIPS 70 micron Catalog',
3533
'acs_iphot_sep07': 'COSMOS ACS I-band photometry catalog September 2007',
@@ -44,10 +42,10 @@ This returns a dictionary of catalog names with their description. If you would
4442
rather just print out this information:
4543

4644
.. code-block:: python
45+
.. doctest-remote-data::
4746

4847
>>> from astroquery.irsa import Irsa
49-
>>> Irsa.print_catalogs()
50-
48+
>>> Irsa.print_catalogs() # doctest: +IGNORE_OUTPUT
5149
wise_allsky_2band_p1bm_frm WISE Post-Cryo Single Exposure (L1b) Image Inventory Table
5250
wise_allsky_4band_p3as_psr WISE All-Sky Reject Table
5351
cosmos_morph_col_1 COSMOS Zamojski Morphology Catalog v1.0
@@ -69,13 +67,13 @@ any appropriate unit using a `~astropy.units.Quantity` object. It may also be
6967
entered as a string that is parsable by `~astropy.coordinates.Angle`.
7068

7169
.. code-block:: python
70+
.. doctest-remote-data::
7271

7372
>>> from astroquery.irsa import Irsa
7473
>>> import astropy.units as u
7574
>>> table = Irsa.query_region("m31", catalog="fp_psc", spatial="Cone",
7675
... radius=2 * u.arcmin)
7776
>>> print(table)
78-
7977
ra dec clon clat err_maj ... j_h h_k j_k id
8078
------- ------- ------------ ------------ ------- ... ----- ------ ------ ---
8179
10.685 41.248 00h42m44.45s 41d14m52.56s 0.14 ... 1.792 -0.821 0.971 0
@@ -103,14 +101,15 @@ name. The coordinates can be specified using the appropriate
103101
a string, as specified by `astropy.coordinates`:
104102

105103
.. code-block:: python
104+
.. doctest-remote-data::
106105

107106
>>> from astroquery.irsa import Irsa
108107
>>> import astropy.coordinates as coord
109108
>>> table = Irsa.query_region(coord.SkyCoord(121.1743,
110109
... -21.5733, unit=(u.deg,u.deg),
111110
... frame='galactic'),
112111
... catalog='fp_psc', radius='0d2m0s')
113-
>>> print(table)
112+
>>> print(table) # doctest: +IGNORE_OUTPUT
114113

115114
Performing a box search
116115
-----------------------
@@ -122,16 +121,15 @@ for cone search queries, above - so it may be set using the appropriate
122121
`~astropy.units.Quantity` object or a string parsable by `~astropy.coordinates.Angle`.
123122

124123
.. code-block:: python
124+
.. doctest-remote-data::
125125

126126
>>> from astroquery.irsa import Irsa
127127
>>> import astropy.units as u
128128
>>> table = Irsa.query_region("00h42m44.330s +41d16m07.50s",
129129
... catalog='fp_psc', spatial='Box',
130130
... width=5 * u.arcsec)
131-
132131
WARNING: Coordinate string is being interpreted as an ICRS
133132
coordinate. [astroquery.irsa.core]
134-
135133
>>> print(table)
136134

137135
ra dec clon clat err_maj ... j_h h_k j_k id
@@ -157,6 +155,7 @@ tuples, each tuple containing the ra and dec values in degrees. Each of these
157155
options is illustrated below:
158156

159157
.. code-block:: python
158+
.. doctest-remote-data::
160159

161160
>>> from astroquery.irsa import Irsa
162161
>>> from astropy import coordinates
@@ -166,7 +165,6 @@ options is illustrated below:
166165
... coordinates.SkyCoord(ra=10.0, dec=10.0, unit=(u.deg, u.deg), frame='icrs')
167166
... ])
168167
>>> print(table)
169-
170168
ra dec clon clat err_maj ... j_h h_k j_k id
171169
------- ------- ------------ ------------ ------- ... ----- ----- ----- ---
172170
10.016 10.099 00h40m03.77s 10d05m57.22s 0.1 ... 0.602 0.154 0.756 0
@@ -181,12 +179,12 @@ Another way to specify the polygon is directly as a list of tuples - each tuple
181179
is an ra, dec pair expressed in degrees:
182180

183181
.. code-block:: python
182+
.. doctest-remote-data::
184183

185184
>>> from astroquery.irsa import Irsa
186185
>>> table = Irsa.query_region("m31", catalog="fp_psc", spatial="Polygon",
187186
... polygon = [(10.1, 10.1), (10.0, 10.1), (10.0, 10.0)])
188187
>>> print(table)
189-
190188
ra dec clon clat err_maj ... j_h h_k j_k id
191189
------- ------- ------------ ------------ ------- ... ----- ----- ----- ---
192190
10.016 10.099 00h40m03.77s 10d05m57.22s 0.1 ... 0.602 0.154 0.756 0
@@ -205,11 +203,11 @@ The IRSA service allows to query either a subset of the default columns for a gi
205203
An example where the AllWISE Source Catalog needs to be queried around the star HIP 12 with just the ra, dec and w1mpro columns would be:
206204

207205
.. code-block:: python
206+
.. doctest-remote-data::
208207

209208
>>> from astroquery.irsa import Irsa
210209
>>> table = Irsa.query_region("HIP 12", catalog="allwise_p3as_psd", spatial="Cone", selcols="ra,dec,w1mpro")
211210
>>> print(table)
212-
213211
ra dec clon clat w1mpro dist angle id
214212
deg deg mag arcsec deg
215213
------- ------- ------------ ------------- ------ -------- ---------- ---
@@ -227,13 +225,13 @@ is written in ``ascii.ipac`` or ``ascii.csv`` formats. The ``.format`` attribute
227225
individual columns may be set to increase the precision.
228226

229227
.. code-block:: python
228+
.. doctest-remote-data::
230229

231230
>>> from astroquery.irsa import Irsa
232231
>>> table = Irsa.query_region("HIP 12", catalog="allwise_p3as_psd", spatial="Cone", selcols="ra,dec,w1mpro")
233232
>>> table['ra'].format = '{:10.6f}'
234233
>>> table['dec'].format = '{:10.6f}'
235234
>>> print(table)
236-
237235
ra dec clon clat w1mpro dist angle id
238236
deg deg mag arcs deg
239237
----------- ----------- ------------ ------------- ------ -------- ---------- ---

0 commit comments

Comments
 (0)