Skip to content

Commit 28fce8e

Browse files
Jorge Fernandez HernandezJorge Fernandez Hernandez
authored andcommitted
EUCLIDPCR-1863 Update documentation
1 parent 754237f commit 28fce8e

File tree

1 file changed

+23
-5
lines changed

1 file changed

+23
-5
lines changed

docs/esa/euclid/euclid.rst

Lines changed: 23 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,9 @@ imaging into merged mosaics, which can contain multiple different observations.
3232
mosaics are organized by Tile ID in the archive.
3333

3434

35-
This package provides access to the metadata and datasets provided by the European Space Agency EUCLID Archive using a
36-
TAP+ REST service. TAP+ is an extension of Table Access Protocol (TAP: http://www.ivoa.net/documents/TAP/) specified by
37-
the International Virtual Observatory Alliance (IVOA: http://www.ivoa.net).
35+
`astroquery.esa.euclid` provides the astroquery interface to the metadata and datasets provided by the European Space
36+
Agency EUCLID Archive using a TAP+ REST service. TAP+ is an extension of Table Access Protocol (TAP: http://www.ivoa.net/documents/TAP/)
37+
specified by the International Virtual Observatory Alliance (IVOA: http://www.ivoa.net).
3838

3939

4040
The TAP query language is Astronomical Data Query Language
@@ -276,6 +276,22 @@ This query performs a cone search centered at the specified ra/dec coordinates w
276276
102158889 2024-10-26T13:10:32.453 267.3807789 65.4983 EUC_MER_BGSUB-MOSAIC-NIR-H_TILE102158889-ED035A_20241024T212936.705156Z_00.00.fits /euclid/repository_idr/iqr1/Q1_R1/MER/102158889/NISP /data/euclid_q1/Q1_R1/MER/102158889/NISP NIR_H 0.16895922479034217
277277

278278

279+
280+
Queries return a limited number of rows controlled by ``Euclid.ROW_LIMIT``. To change the default behaviour set this appropriately.
281+
282+
.. Skipping authentication requiring examples
283+
.. doctest-skip::
284+
285+
>>> Euclid.ROW_LIMIT = 2
286+
>>> job = Euclid.cone_search(coordinate=coord, radius=radius, table_name="sedm.mosaic_product", ra_column_name="ra", dec_column_name="dec", columns="*", async_job=True)
287+
>>> cone_results = job.get_results()
288+
>>> print("Found", len(cone_results), "results")
289+
Found 2 results
290+
291+
292+
To return an unlimited number of rows set ``Euclid.ROW_LIMIT`` to -1.
293+
294+
279295
1.3. Query object
280296
^^^^^^^^^^^^^^^^^
281297

@@ -328,7 +344,7 @@ The previous query can be executed as an asynchronous version:
328344
>>> coord = SkyCoord(ra=60.3372780005097, dec=-49.93184727724773, unit=(u.degree, u.degree), frame='icrs')
329345
>>> width=u.Quantity(0.1, u.deg)
330346
>>> height= u.Quantity(0.1, u.deg)
331-
>>> table_async = Euclid.query_object_async(coordinate=coord, width=width, height=height)
347+
>>> table_async = Euclid.query_object(coordinate=coord, width=width, height=height, async_job=True)
332348
INFO: Query finished. [astroquery.utils.tap.core]
333349
>>> print("Found a total of", len(table_async), "query results")
334350
Found a total of 2895 query results
@@ -1130,8 +1146,10 @@ will be able to access to your shared table in a query.
11301146
>>> Euclid.share_table_stop(table_name="user_<user_login_name>.my_table", group_name="my_group")
11311147

11321148

1149+
-----------------------------------
11331150
3. Datalink service (Authenticated)
1134-
----------------------------------------------
1151+
-----------------------------------
1152+
11351153

11361154
DataLink_ is a data access protocol compliant with the IVOA_ architecture that provides a linking mechanism between
11371155
datasets offered by different services. In practice, it can be seen and used as a web service providing the list of additional

0 commit comments

Comments
 (0)