Skip to content

Commit 4799e0e

Browse files
committed
docs: switch to use a single instance of Vizier when possible
1 parent 32a651d commit 4799e0e

File tree

1 file changed

+21
-17
lines changed

1 file changed

+21
-17
lines changed

docs/vizier/vizier.rst

Lines changed: 21 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,8 @@ the :meth:`~astroquery.vizier.VizierClass.find_catalogs` tool can be used:
2424
.. doctest-remote-data::
2525

2626
>>> from astroquery.vizier import Vizier
27-
>>> catalog_list = Vizier().find_catalogs('hot jupiter exoplanet transit')
27+
>>> vizier = Vizier() # this instantiates Vizier with its default parameters
28+
>>> catalog_list = vizier.find_catalogs('hot jupiter exoplanet transit')
2829
>>> for k, v in catalog_list.items(): # doctest: +IGNORE_OUTPUT
2930
... print(k, ":", v.description)
3031
J/A+A/635/A205 : Ultra-hot Jupiter WASP-121b transits (Bourrier+, 2020)
@@ -45,7 +46,7 @@ the complete contents of those catalogs:
4546

4647
.. doctest-remote-data::
4748

48-
>>> catalogs = Vizier.get_catalogs(catalog_list.keys())
49+
>>> catalogs = vizier.get_catalogs(catalog_list.keys())
4950
>>> print(catalogs) # doctest: +IGNORE_OUTPUT
5051
TableList with 10 tables:
5152
'0:J/A+A/635/A205/20140119' with 7 column(s) and 50 row(s)
@@ -65,7 +66,7 @@ way:
6566

6667
.. doctest-remote-data::
6768

68-
>>> catalogs = Vizier.get_catalogs(catalog_list.values())
69+
>>> catalogs = vizier.get_catalogs(catalog_list.values())
6970
>>> print(catalogs) # doctest: +IGNORE_OUTPUT
7071
TableList with 10 tables:
7172
'0:J/A+A/635/A205/20140119' with 7 column(s) and 50 row(s)
@@ -81,7 +82,7 @@ way:
8182

8283
.. doctest-remote-data::
8384

84-
>>> catalogs = Vizier.get_catalogs(catalog_list.keys())
85+
>>> catalogs = vizier.get_catalogs(catalog_list.keys())
8586
>>> print(catalogs) # doctest: +IGNORE_OUTPUT
8687
TableList with 10 tables:
8788
'0:J/A+A/635/A205/20140119' with 7 column(s) and 50 row(s)
@@ -100,8 +101,8 @@ complete catalog, you need to change that:
100101

101102
.. doctest-remote-data::
102103

103-
>>> Vizier.ROW_LIMIT = -1
104-
>>> catalogs = Vizier.get_catalogs(catalog_list.keys())
104+
>>> vizier.ROW_LIMIT = -1
105+
>>> catalogs = vizier.get_catalogs(catalog_list.keys())
105106
>>> print(catalogs) # doctest: +IGNORE_OUTPUT
106107
TableList with 10 tables:
107108
'0:J/A+A/635/A205/20140119' with 7 column(s) and 235 row(s)
@@ -114,7 +115,7 @@ complete catalog, you need to change that:
114115
'7:J/AJ/157/217/transits' with 8 column(s) and 236 row(s)
115116
'8:J/A+A/635/A122/table2' with 4 column(s) and 18 row(s)
116117
'9:J/A+A/635/A122/table3' with 4 column(s) and 17 row(s)
117-
>>> Vizier.ROW_LIMIT = 50
118+
>>> vizier.ROW_LIMIT = 50
118119

119120
Get a catalog's associated metadata
120121
-----------------------------------
@@ -211,22 +212,23 @@ quasar 3C 273:
211212

212213
>>> from astroquery.vizier import Vizier
213214
>>> from astropy.coordinates import Angle
214-
>>> result = Vizier.query_region("3C 273", radius=Angle(0.1, "deg"), catalog='GSC')
215+
>>> vizier = Vizier()
216+
>>> result = vizier.query_region("3C 273", radius=Angle(0.1, "deg"), catalog='GSC')
215217

216218
Note that the radius may also be specified as a string in the format
217219
expected by `~astropy.coordinates.Angle`. So the above query may also
218220
be written as:
219221

220222
.. doctest-remote-data::
221223

222-
>>> result = Vizier.query_region("3C 273", radius="0d6m0s", catalog='GSC')
224+
>>> result = vizier.query_region("3C 273", radius="0d6m0s", catalog='GSC')
223225

224226
Or using angular units and quantities from `astropy.units`:
225227

226228
.. doctest-remote-data::
227229

228230
>>> import astropy.units as u
229-
>>> result = Vizier.query_region("3C 273", radius=0.1*u.deg, catalog='GSC')
231+
>>> result = vizier.query_region("3C 273", radius=0.1*u.deg, catalog='GSC')
230232

231233
To see the result:
232234

@@ -250,7 +252,8 @@ dimension.
250252
>>> from astroquery.vizier import Vizier
251253
>>> import astropy.units as u
252254
>>> import astropy.coordinates as coord
253-
>>> result = Vizier.query_region(coord.SkyCoord(ra=299.590, dec=35.201,
255+
>>> vizier = Vizier()
256+
>>> result = vizier.query_region(coord.SkyCoord(ra=299.590, dec=35.201,
254257
... unit=(u.deg, u.deg),
255258
... frame='icrs'),
256259
... width="30m",
@@ -279,7 +282,8 @@ constraints on the columns of the returned tables by mean of the ``column_filter
279282
>>> from astroquery.vizier import Vizier
280283
>>> import astropy.units as u
281284
>>> from astropy.coordinates import SkyCoord
282-
>>> result = Vizier.query_region(SkyCoord.from_name('M81'),
285+
>>> vizier = Vizier()
286+
>>> result = vizier.query_region(SkyCoord.from_name('M81'),
283287
... radius=10*u.arcmin,
284288
... catalog='I/345/gaia2',
285289
... column_filters={'Gmag': '<19'})
@@ -296,7 +300,7 @@ on the Vizier class.
296300

297301
.. doctest-remote-data::
298302

299-
>>> v = Vizier(columns=['_RAJ2000', '_DEJ2000','B-V', 'Vmag', 'Plx'],
303+
>>> vizier = Vizier(columns=['_RAJ2000', '_DEJ2000','B-V', 'Vmag', 'Plx'],
300304
... column_filters={"Vmag":">10"}, keywords=["optical", "xry"]) # doctest: +IGNORE_WARNINGS
301305

302306
Note that whenever an unknown keyword is specified (here ``xry``) a warning is emitted and
@@ -308,9 +312,9 @@ this Vizier instance:
308312
.. output can be in any order here
309313
.. doctest-remote-data::
310314

311-
>>> v = Vizier(columns=['_RAJ2000', '_DEJ2000','B-V', 'Vmag', 'Plx'],
315+
>>> vizier = Vizier(columns=['_RAJ2000', '_DEJ2000','B-V', 'Vmag', 'Plx'],
312316
... column_filters={"Vmag":">10"}, keywords=["optical"])
313-
>>> result = v.query_object("HD 226868", catalog=["NOMAD", "UCAC"])
317+
>>> result = vizier.query_object("HD 226868", catalog=["NOMAD", "UCAC"])
314318
>>> print(result)
315319
TableList with 3 tables:
316320
'0:I/297/out' with 3 column(s) and 50 row(s)
@@ -340,8 +344,8 @@ the ``"+"`` in front of ``"_r"``.
340344

341345
.. doctest-remote-data::
342346

343-
>>> v = Vizier(columns=["*", "+_r"], catalog="II/246")
344-
>>> result = v.query_region("HD 226868", radius="20s")
347+
>>> vizier = Vizier(columns=["*", "+_r"], catalog="II/246")
348+
>>> result = vizier.query_region("HD 226868", radius="20s")
345349
>>> print(result[0])
346350
_r RAJ2000 DEJ2000 _2MASS Jmag ... Bflg Cflg Xflg Aflg
347351
deg deg mag ...

0 commit comments

Comments
 (0)