Skip to content

Commit d488263

Browse files
bsipoczbsipocz
authored
Merge pull request #1963 from tinumide/imcce-doc-cleanup
Imcce documentation cleanup
2 parents 8a7e23d + 8dc4ae4 commit d488263

File tree

1 file changed

+67
-54
lines changed

1 file changed

+67
-54
lines changed

‎docs/imcce/imcce.rst

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

53
******************************************************************************************************************************************
@@ -17,7 +15,7 @@ IMCCE provides a number of Solar System-related services, two of which are curre
1715
* `Miriade <http://vo.imcce.fr/webservices/miriade/>`_: ephemerides service
1816

1917
Use cases for both services are detailed below.
20-
18+
2119

2220
SkyBot - Solar System Body Identification Service
2321
=================================================
@@ -31,27 +29,37 @@ Cone Search
3129
A simple cone search for Solar System objects in a circular field
3230
looks like this:
3331

34-
.. code-block:: python
32+
.. doctest-remote-data::
3533

3634
>>> from astroquery.imcce import Skybot
3735
>>> from astropy.coordinates import SkyCoord
3836
>>> from astropy.time import Time
3937
>>> import astropy.units as u
4038
>>> field = SkyCoord(0*u.deg, 0*u.deg)
4139
>>> epoch = Time('2019-05-29 21:42', format='iso')
42-
>>> Skybot.cone_search(field, 5*u.arcmin, epoch) # doctest: +SKIP
43-
<QTable length=2>
44-
Number Name RA ... vy vz epoch
45-
deg ... AU / d AU / d d
46-
int64 str10 float64 ... float64 float64 float64
47-
------ ---------- ------------------ ... ----------- ----------- ---------
48-
516566 2007 DH36 0.005535 ... 0.008556458 0.002875929 2458630.0
49-
163149 2002 CV106 359.98691791666664 ... 0.009078103 0.00267749 2458630.0
40+
>>> Skybot.cone_search(field, 5*u.arcmin, epoch)
41+
<QTable length=12>
42+
Number Name RA ... vy vz epoch
43+
deg ... AU / d AU / d d
44+
int64 str10 float64 ... float64 float64 float64
45+
------ ---------- -------------------- ... ----------- ----------- ---------
46+
-- -- 0.0 ... 0.002324846 0.000311389 2458630.0
47+
-- -- 0.0 ... ——— ——— 2458630.0
48+
-- -- 0.0 ... ——— ——— 2458630.0
49+
-- -- 0.0 ... ——— ——— 2458630.0
50+
-- -- 0.0 ... ——— ——— 2458630.0
51+
-- -- 0.0 ... ——— ——— 2458630.0
52+
-- -- 0.0 ... ——— ——— 2458630.0
53+
-- -- 0.0 ... ——— ——— 2458630.0
54+
-- 2012 BO42 0.019414999999999998 ... 0.009345668 0.005003011 2458630.0
55+
516566 2007 DH36 0.005546249999999999 ... 0.00855646 0.002875928 2458630.0
56+
-- 2019 SS82 359.9931945833333 ... 0.009809784 0.004636687 2458630.0
57+
163149 2002 CV106 359.98692374999996 ... 0.009078104 0.00267749 2458630.0
5058

5159
`~astroquery.imcce.SkybotClass.cone_search` produces a
5260
`~astropy.table.QTable` object with the properties of all Solar System
53-
bodies that are present in the cone at the given epoch.
54-
61+
bodies that are present in the cone at the given epoch.
62+
5563
The required input arguments for
5664
`~astroquery.imcce.SkybotClass.cone_search` are the center coordinates
5765
of the cone, its radius, as well as the epoch of the
@@ -141,17 +149,17 @@ The *Miriade* service enable the query of Solar System object ephemerides.
141149
The most minimalistic `~astroquery.imcce.MiriadeClass.get_ephemerides`
142150
query looks like this:
143151

144-
.. code-block:: python
145-
146-
>>> from astroquery.miriade import Miriade
147-
>>> Miriade.get_ephemerides('Ceres')
148-
<Table masked=True length=1>
149-
target epoch RA ... DEC_rate delta_rate
150-
d deg ... arcs / min km / s
151-
bytes20 float64 float64 ... float64 float64
152-
------- -------------------- ----------------- ... ---------- ------------
153-
Ceres 2458519.315165116 242.1874308333333 ... -0.14926 -20.9668673
154-
152+
.. doctest-remote-data::
153+
154+
>>> from astroquery.imcce import Miriade
155+
>>> Miriade.get_ephemerides('Ceres') # doctest: +IGNORE_OUTPUT
156+
<Table length=1>
157+
target epoch RA ... DEC_rate delta_rate
158+
d deg ... arcsec / min km / s
159+
str20 float64 float64 ... float64 float64
160+
------ -------------------- ------------------ ... ------------ ------------
161+
Ceres 2459914.7406457304 178.71843708333333 ... -0.18976 -21.5458636
162+
155163
This query will return ephemerides for asteroid Ceres, for the current
156164
epoch, and for a geocentric location. The query output is formatted as
157165
a `~astropy.table.Table`.
@@ -180,31 +188,38 @@ which means that only a single epoch ``epoch`` will be queried.
180188
Consider the following example, which queries ephemerides for asteroid
181189
Pallas over an entire year with a time step of 1 day:
182190

183-
.. code-block:: python
191+
.. doctest-remote-data::
184192

185-
>>> from astroquery.miriade import Miriade
193+
>>> from astroquery.imcce import Miriade
186194
>>> Miriade.get_ephemerides('Pallas', epoch='2019-01-01',
187-
>>> epoch_step='1d', epoch_nsteps=365) # doctest: +SKIP
188-
<Table masked=True length=365>
189-
target epoch RA ... DEC_rate delta_rate
190-
d deg ... arcs / min km / s
191-
bytes20 float64 float64 ... float64 float64
192-
------- -------------------- ------------------ ... ---------- ------------
193-
Pallas 2458484.5 200.5865645833333 ... 0.15854 -19.3678422
194-
Pallas 2458485.5 200.92699458333328 ... 0.16727 -19.4137907
195-
Pallas 2458486.5 201.26416541666663 ... 0.17613 -19.4552649
196-
Pallas 2458487.5 201.59800958333332 ... 0.18511 -19.4921113
197-
Pallas 2458488.5 201.9284608333333 ... 0.19421 -19.5241972
198-
Pallas 2458489.5 202.25545124999996 ... 0.20344 -19.5514101
199-
... ... ... ... ... ...
200-
Pallas 2458843.5 261.1308308333333 ... 0.025007 -2.2916737
201-
Pallas 2458844.5 261.5084158333333 ... 0.029542 -2.5107013
202-
Pallas 2458845.5 261.88534958333327 ... 0.034077 -2.7290895
203-
Pallas 2458846.5 262.2616025 ... 0.038612 -2.9467393
204-
Pallas 2458847.5 262.6371470833333 ... 0.043144 -3.1635784
205-
Pallas 2458848.5 263.011955 ... 0.047672 -3.3795565
206-
207-
195+
... epoch_step='1d', epoch_nsteps=365)
196+
<Table length=365>
197+
target epoch RA ... DEC_rate delta_rate
198+
d deg ... arcsec / min km / s
199+
str20 float64 float64 ... float64 float64
200+
------ -------------------- ------------------ ... ------------ ------------
201+
Pallas 2458484.5 200.58650791666665 ... 0.15854 -19.3678463
202+
Pallas 2458485.5 200.92693791666662 ... 0.16727 -19.4137948
203+
Pallas 2458486.5 201.26410874999996 ... 0.17613 -19.455269
204+
Pallas 2458487.5 201.59795291666666 ... 0.18511 -19.4921153
205+
Pallas 2458488.5 201.92840374999994 ... 0.19421 -19.5242013
206+
Pallas 2458489.5 202.25539416666663 ... 0.20344 -19.5514142
207+
Pallas 2458490.5 202.57885791666664 ... 0.21278 -19.5736602
208+
Pallas 2458491.5 202.8987283333333 ... 0.22224 -19.5908624
209+
Pallas 2458492.5 203.21493999999996 ... 0.23181 -19.6029579
210+
... ... ... ... ... ...
211+
Pallas 2458839.5 259.61455249999995 ... 0.0069182 -1.4120216
212+
Pallas 2458840.5 259.994445 ... 0.011429 -1.632143
213+
Pallas 2458841.5 260.373805 ... 0.015948 -1.8522401
214+
Pallas 2458842.5 260.75260374999993 ... 0.020475 -2.0721425
215+
Pallas 2458843.5 261.13081041666663 ... 0.025007 -2.2916831
216+
Pallas 2458844.5 261.50839541666664 ... 0.029542 -2.5107109
217+
Pallas 2458845.5 261.8853291666666 ... 0.034077 -2.7290991
218+
Pallas 2458846.5 262.2615820833333 ... 0.038612 -2.9467491
219+
Pallas 2458847.5 262.63712666666663 ... 0.043144 -3.1635884
220+
Pallas 2458848.5 263.0119345833333 ... 0.047672 -3.3795666
221+
222+
208223
The observer location is defined through the ``location`` keyword,
209224
expecting a string containing the official IAU observatory code, a
210225
spacecraft name, or a set of coordinates (see the `Miriade manual
@@ -306,8 +321,8 @@ to be provided to the keyword ``coordtype`` to use these sets) :
306321
+------------------+-----------------------------------------------+
307322
| ``vz_h`` | Z heliocentric vel. vector (au/d, float) |
308323
+------------------+-----------------------------------------------+
309-
310-
324+
325+
311326
3. Local coordinates:
312327

313328
+------------------+-----------------------------------------------+
@@ -454,8 +469,7 @@ results:
454469
ecliptical coordinates
455470
* ``elements``: switch to MPCORB ephemerides instead of ASTORB
456471
* ``radial_velocity``: provides additional information on target's radial
457-
velocity
458-
472+
velocity
459473

460474

461475

@@ -483,10 +497,9 @@ Please consider the following notes from IMCCE:
483497
The development of this submodule is funded through NASA PDART Grant
484498
No. 80NSSC18K0987 to the `sbpy project <http://sbpy.org>`_.
485499

486-
500+
487501
Reference/API
488502
=============
489503

490504
.. automodapi:: astroquery.imcce
491505
:no-inheritance-diagram:
492-

0 commit comments

Comments
 (0)