Skip to content

Commit 6965865

Browse files
ManonMarchandbsipocz
authored andcommitted
docs: add links to external documentation
1 parent 17e06e8 commit 6965865

File tree

2 files changed

+27
-26
lines changed

2 files changed

+27
-26
lines changed

astroquery/mocserver/core.py

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -76,8 +76,8 @@ def query_region(
7676
fields. The complete list of fields can be obtained with `list_fields`.
7777
coordinate_system : str, optional
7878
This is the space system on which the coordinates are expressed. Can take
79-
the values ``sky``, ``mars``, ``moon``... The extended list can
80-
be printed with `~astroquery.mocserver.MOCServer.list_coordinate_systems`.
79+
the values ``sky``, ``mars``, ``moon``... The extended list can be printed
80+
with `~astroquery.mocserver.MOCServerClass.list_coordinate_systems`.
8181
Default is None, meaning that the results will have mixed frames.
8282
intersect : str, optional
8383
This parameter can take three different values:
@@ -163,8 +163,8 @@ def query_hips(
163163
fields. The complete list of fields can be obtained with `list_fields`.
164164
coordinate_system : str, optional
165165
This is the space system on which the coordinates are expressed. Can take
166-
the values ``sky``, ``mars``, ``moon``... The extended list can
167-
be printed with `~astroquery.mocserver.MOCServer.list_coordinate_systems`.
166+
the values ``sky``, ``mars``, ``moon``... The extended list can be printed
167+
with `~astroquery.mocserver.MOCServerClass.list_coordinate_systems`.
168168
Default is None, meaning that the results will have mixed frames.
169169
region : `regions.CircleSkyRegion`, `regions.PolygonSkyRegion`, `mocpy.MOC`,
170170
`mocpy.TimeMOC`, or `mocpy.STMOC`
@@ -257,8 +257,8 @@ def find_datasets(
257257
fields. The complete list of fields can be obtained with `list_fields`.
258258
coordinate_system : str, optional
259259
This is the space system on which the coordinates are expressed. Can take
260-
the values ``sky``, ``mars``, ``moon``... The extended list can
261-
be printed with `~astroquery.mocserver.MOCServer.list_coordinate_systems`.
260+
the values ``sky``, ``mars``, ``moon``... The extended list can be printed
261+
with `~astroquery.mocserver.MOCServerClass.list_coordinate_systems`.
262262
Default is None, meaning that the results will have mixed frames.
263263
region : `regions.CircleSkyRegion`, `regions.PolygonSkyRegion`, `mocpy.MOC`,
264264
`mocpy.TimeMOC`, or `mocpy.STMOC`
@@ -345,8 +345,8 @@ def query_async(
345345
fields. The complete list of fields can be obtained with `list_fields`.
346346
coordinate_system : str, optional
347347
This is the space system on which the coordinates are expressed. Can take
348-
the values ``sky``, ``mars``, ``moon``... The extended list can
349-
be printed with `~astroquery.mocserver.MOCServer.list_coordinate_systems`.
348+
the values ``sky``, ``mars``, ``moon``... The extended list can be printed
349+
with `~astroquery.mocserver.MOCServerClass.list_coordinate_systems`.
350350
Default is None, meaning that the results will have mixed frames.
351351
region : `regions.CircleSkyRegion`, `regions.PolygonSkyRegion`, `mocpy.MOC`,
352352
`mocpy.TimeMOC`, or `mocpy.STMOC`

docs/mocserver/mocserver.rst

Lines changed: 19 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -13,20 +13,22 @@ What's a MOC?
1313
-------------
1414

1515
MOC means Multi-Order Coverage. It's an `IVOA standard`_ that allows to describe
16-
Space-Time coverages of arbitrary sky regions --with or without
17-
an associated time of observation.
16+
Space-Time coverages of arbitrary sky regions, with or without an associated time of
17+
observation.
1818

19-
The space component maps the sky with the HEALPix sky
20-
tessellation to represent regions on the sky by hierarchically grouped HEALPix cells.
21-
It other words, a Spatial MOC is a set of HEALPix cells at different orders.
19+
The space component maps the sky with the `HEALPix sky tessellation
20+
<https://arxiv.org/abs/astro-ph/9905275>`_ to represent regions on the sky
21+
by hierarchically grouped HEALPix cells. It other words, a Spatial MOC is a set of
22+
HEALPix cells at different orders.
2223

2324
The idea is the same for Time MOCs. The time axis is split into time cells.
2425

2526
For those wanting to know more about MOCs, please refer to `the MOC 2.0 specification
2627
document <https://ivoa.net/documents/MOC/20220727/REC-moc-2.0-20220727.pdf>`_.
2728

28-
MOCPy is a Python library allowing to manipulate these Space-Time Coverage objects.
29-
You're welcome to have a look at `MOCPy's documentation <https://github.com/cds-astro/mocpy>`_.
29+
`MOCPy <https://github.com/cds-astro/mocpy>`_ is a Python library allowing to manipulate
30+
these Space-Time Coverage objects. You're welcome to have a look at
31+
`MOCPy's documentation <https://cds-astro.github.io/mocpy/>`_.
3032

3133
What's the MOC Server?
3234
----------------------
@@ -37,8 +39,8 @@ In the MOC Server, there a few tens of thousands of astronomical collections.
3739
They each have an identifier ``ID`` and a set of properties that describe their content.
3840
This is a practical way of finding datasets with criteria on time and/or space.
3941

40-
The meta-data properties are freely assigned by each publisher. You can get the list of
41-
properties with their frequency of usage and examples example with
42+
The meta data properties are freely assigned by each publisher. You can get the current
43+
list of properties with their frequency of usage and examples example with
4244
`astroquery.mocserver.MOCServerClass.list_fields`.
4345
This method also accepts a string to limit the number of responses. Let's try with ``MOC``:
4446

@@ -69,7 +71,8 @@ Querying with a region
6971

7072
The MOCServer is optimized to return the datasets having at least one source lying in a
7173
specific sky region (or time interval).
72-
The regions can be provided either as astropy-regions from the ``regions`` python library,
74+
The regions can be provided either as astropy-regions from the
75+
`regions <https://astropy-regions.readthedocs.io/en/stable/>`_ python library,
7376
or as an accepted MOC type (`mocpy.TimeMOC`, `mocpy.MOC`, `~mocpy.STMOC`).
7477
The frequency MOCs are not yet available.
7578

@@ -205,12 +208,13 @@ their identifier. These correspond to the Hubble surveys:
205208
ESAVO/P/HST/WFPC --
206209
ESAVO/P/HST/WFPC2 --
207210

208-
Query for HiPS surveys
209-
======================
211+
Query for Hierarchical Progressive Surveys (HiPS)
212+
=================================================
210213

211-
The MOCServer contains an extensive list of HiPS, for images and catalogs. These
212-
progressive surveys can be displayed in applications such as Aladin or ESASky.
213-
The `astroquery.mocserver.MOCServerClass.query_hips` method allows to find these HiPS.
214+
The MOCServer contains an extensive list of `HiPS <https://ivoa.net/documents/HiPS/>`_,
215+
for images and catalogs. These progressive surveys can be displayed in applications
216+
such as `ipyaladin <https://github.com/cds-astro/ipyaladin>`_. The
217+
`astroquery.mocserver.MOCServerClass.query_hips` method allows to find these HiPS.
214218
It accepts the same parameters (``region`` and ``meta_data`` for example) as the other
215219
methods. The only difference is that the output will only contain HiPS data.
216220

@@ -396,6 +400,3 @@ Reference/API
396400

397401
.. _CDS MOCServer: http://alasky.unistra.fr/MocServer/query
398402
.. _IVOA standard: http://ivoa.net/documents/MOC/20140602/REC-MOC-1.0-20140602.pdf
399-
.. _astropy-healpix: https://astropy-healpix.readthedocs.io/en/latest/
400-
.. _regions: https://github.com/astropy/regions
401-
.. _mocpy: https://github.com/cds-astro/mocpy

0 commit comments

Comments
 (0)