Skip to content

Commit 31a4164

Browse files
authored
Merge pull request #2265 from eerovaher/docs-module-lists
Update module lists in documentation
2 parents 4a3f214 + 3651a70 commit 31a4164

File tree

3 files changed

+24
-83
lines changed

3 files changed

+24
-83
lines changed

README.rst

Lines changed: 4 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -88,76 +88,17 @@ Using astroquery
8888
----------------
8989

9090
Importing astroquery on its own doesn't get you much: you need to import each
91-
sub-module specifically. Check out the `docs`_
92-
to find a list of the tools available. The `API`_
93-
shows the standard suite of tools common to most modules, e.g. `query_object`
94-
and `query_region`.
91+
sub-module specifically. See the documentation for a list of `Available
92+
Services <https://astroquery.readthedocs.io/en/latest/#available-services>`_.
93+
The `API`_ shows the standard suite of tools common to most modules, e.g.
94+
`query_object` and `query_region`.
9595

9696
To report bugs and request features, please use the issue tracker. Code
9797
contributions are very welcome, though we encourage you to follow the `API`_
9898
and `contributing guidelines
9999
<https://github.com/astropy/astroquery/blob/main/CONTRIBUTING.rst>`_ as much
100100
as possible.
101101

102-
List of Modules
103-
---------------
104-
105-
The following modules have been completed using a common API:
106-
107-
* `ALMA Archive <http://astroquery.readthedocs.io/en/latest/alma/alma.html>`_
108-
* `Atomic Line List <http://astroquery.readthedocs.io/en/latest/atomic/atomic.html>`_: A collection of more than 900,000 atomic transitions.
109-
* `Besancon <http://astroquery.readthedocs.io/en/latest/besancon/besancon.html>`_: Model of stellar population synthesis in the Galaxy.
110-
* `CDS MOC Service <https://astroquery.readthedocs.io/en/latest/cds/cds.html>`_: A collection of all-sky survey coverage maps.
111-
* `CADC <https://astroquery.readthedocs.io/en/latest/cadc/cadc.html>`_: Canadian Astronomy Data Centre.
112-
* `CASDA <https://astroquery.readthedocs.io/en/latest/casda/casda.html>`_: CSIRO ASKAP Science Data Archive.
113-
* `ESASky <http://astroquery.readthedocs.io/en/latest/esasky/esasky.html>`_: ESASky is a science driven discovery portal providing easy visualizations and full access to the entire sky as observed with ESA Space astronomy missions.
114-
* `ESO Archive <http://astroquery.readthedocs.io/en/latest/eso/eso.html>`_
115-
* `FIRST <http://astroquery.readthedocs.io/en/latest/image_cutouts/first/first.html>`_: Faint Images of the Radio Sky at Twenty-cm. 20-cm radio images of the extragalactic sky from the VLA.
116-
* `Gaia <http://astroquery.readthedocs.io/en/latest/gaia/gaia.html>`_: European Space Agency Gaia Archive.
117-
* `ESA XMM <https://astroquery.readthedocs.io/en/latest/esa/xmm_newton.html>`_: European Space Agency XMM-Newton Science Archive.
118-
* `ESA Hubble <https://astroquery.readthedocs.io/en/latest/esa/hubble.html>`_: European Space Agency Hubble Science Archive.
119-
* `ESA ISO <https://astroquery.readthedocs.io/en/latest/esa/iso.html>`_: European Space Agency ISO Data Archive.
120-
* `GAMA database <http://astroquery.readthedocs.io/en/latest/gama/gama.html>`_
121-
* `Gemini <http://astroquery.readthedocs.io/en/latest/gemini/gemini.html>`_: Gemini Archive.
122-
* `HEASARC <http://astroquery.readthedocs.io/en/latest/heasarc/heasarc.html>`_: NASA's High Energy Astrophysics Science Archive Research Center.
123-
* `IBE <http://astroquery.readthedocs.io/en/latest/ibe/ibe.html>`_: IRSA Image Server program interface (IBE) Query Tool provides access to the 2MASS, WISE, and PTF image archives.
124-
* `IRSA <http://astroquery.readthedocs.io/en/latest/irsa/irsa.html>`_: NASA/IPAC Infrared Science Archive. Science products for all of NASA's infrared and sub-mm missions.
125-
* `IRSA dust <http://astroquery.readthedocs.io/en/latest/irsa/irsa_dust.html>`_: Galactic dust reddening and extinction maps from IRAS 100 um data.
126-
* `MAGPIS <http://astroquery.readthedocs.io/en/latest/magpis/magpis.html>`_: Multi-Array Galactic Plane Imaging Survey. 6 and 20-cm radio images of the Galactic plane from the VLA.
127-
* `MAST <http://astroquery.readthedocs.io/en/latest/mast/mast.html>`_: Barbara A. Mikulski Archive for Space Telescopes.
128-
* `Minor Planet Center <http://astroquery.readthedocs.io/en/latest/mpc/mpc.html>`_
129-
* `NASA ADS <http://astroquery.readthedocs.io/en/latest/nasa_ads/nasa_ads.html>`_: SAO/NASA Astrophysics Data System.
130-
* `NED <http://astroquery.readthedocs.io/en/latest/ned/ned.html>`_: NASA/IPAC Extragalactic Database. Multiwavelength data from both surveys and publications.
131-
* `NIST <http://astroquery.readthedocs.io/en/latest/nist/nist.html>`_: National Institute of Standards and Technology (NIST) atomic lines database.
132-
* `NRAO <http://astroquery.readthedocs.io/en/latest/nrao/nrao.html>`_: Science data archive of the National Radio Astronomy Observatory. VLA, JVLA, VLBA and GBT data products.
133-
* `NVAS archive <http://astroquery.readthedocs.io/en/latest/nvas/nvas.html>`_
134-
* `Simbad <http://astroquery.readthedocs.io/en/latest/simbad/simbad.html>`_: Basic data, cross-identifications, bibliography and measurements for astronomical objects outside the solar system.
135-
* `Skyview <http://astroquery.readthedocs.io/en/latest/skyview/skyview.html>`_: NASA SkyView service for imaging surveys.
136-
* `Splatalogue <http://astroquery.readthedocs.io/en/latest/splatalogue/splatalogue.html>`_: National Radio Astronomy Observatory (NRAO)-maintained (mostly) molecular radio and millimeter line list service.
137-
* `UKIDSS <http://astroquery.readthedocs.io/en/latest/ukidss/ukidss.html>`_: UKIRT Infrared Deep Sky Survey. JHK images of 7500 sq deg. in the northern sky.
138-
* `Vamdc <http://astroquery.readthedocs.io/en/latest/vamdc/vamdc.html>`_: VAMDC molecular line database.
139-
* `Vizier <http://astroquery.readthedocs.io/en/latest/vizier/vizier.html>`_: Set of 11,000+ published, multiwavelength catalogues hosted by the CDS.
140-
* `VO Simple Cone Search <http://astroquery.readthedocs.io/en/latest/vo_conesearch/vo_conesearch.html>`_
141-
* `xMatch <http://astroquery.readthedocs.io/en/latest/xmatch/xmatch.html>`_: Cross-identify sources between very large data sets or between a user-uploaded list and a large catalogue.
142-
143-
These others are functional, but do not follow a common or consistent API:
144-
145-
* `Alfalfa <http://astroquery.readthedocs.io/en/latest/alfalfa/alfalfa.html>`_: Arecibo Legacy Fast ALFA survey; extragalactic HI radio data.
146-
* `CosmoSim <http://astroquery.readthedocs.io/en/latest/cosmosim/cosmosim.html>`_: The CosmoSim database provides results from cosmological simulations performed within different projects: the MultiDark project, the BolshoiP project, and the CLUES project.
147-
* `Exoplanet Orbit Database <http://astroquery.readthedocs.io/en/latest/exoplanet_orbit_database/exoplanet_orbit_database.html>`_
148-
* `Fermi <http://astroquery.readthedocs.io/en/latest/fermi/fermi.html>`_: Fermi gamma-ray telescope archive.
149-
* `HITRAN <http://astroquery.readthedocs.io/en/latest/hitran/hitran.html>`_: Access to the high-resolution transmission molecular absorption database.
150-
* `JPL Horizons <http://astroquery.readthedocs.io/en/latest/jplhorizons/jplhorizons.html>`_: JPL Solar System Dynamics Horizons Service.
151-
* `JPL SBDB <http://astroquery.readthedocs.io/en/latest/jplsbdb/jplsbdb.html>`_: JPL Solar System Dynamics Small-Body Database Browser Service.
152-
* `Lamda <http://astroquery.readthedocs.io/en/latest/lamda/lamda.html>`_: Leiden Atomic and Molecular Database; energy levels, radiative transitions, and collisional rates for astrophysically relevant atoms and molecules.
153-
* `NASA Exoplanet Archive <http://astroquery.readthedocs.io/en/latest/nasa_exoplanet_archive/nasa_exoplanet_archive.html>`_
154-
* `OAC API <http://astroquery.readthedocs.io/en/latest/oac/oac.html>`_: Open Astronomy Catalog REST API Service.
155-
* `Ogle <http://astroquery.readthedocs.io/en/latest/ogle/ogle.html>`_: Optical Gravitational Lensing Experiment III; information on interstellar extinction towards the Galactic bulge.
156-
* `Open Expolanet Catalog (OEC) <http://astroquery.readthedocs.io/en/latest/open_exoplanet_catalogue/open_exoplanet_catalogue.html>`_
157-
* `SDSS <http://astroquery.readthedocs.io/en/latest/sdss/sdss.html>`_: Sloan Digital Sky Survey data, including optical images, spectra, and spectral templates.
158-
* `SHA <http://astroquery.readthedocs.io/en/latest/sha/sha.html>`_: Spitzer Heritage Archive; infrared data products from the Spitzer Space Telescope.
159-
160-
161102
Citing Astroquery
162103
-----------------
163104

@@ -188,7 +129,6 @@ Maintained by `Adam Ginsburg`_ and `Brigitta Sipocz <https://github.com/bsipocz>
188129
.. _Download Stable ZIP: https://github.com/astropy/astroquery/zipball/stable
189130
.. _Download Stable TAR: https://github.com/astropy/astroquery/tarball/stable
190131
.. _View on Github: https://github.com/astropy/astroquery/
191-
.. _docs: http://astroquery.readthedocs.io
192132
.. _Documentation: http://astroquery.readthedocs.io
193133
194134
.. _Adam Ginsburg: http://www.adamgginsburg.com

docs/index.rst

Lines changed: 19 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -185,23 +185,25 @@ The following modules have been completed using a common API:
185185
cadc/cadc.rst
186186
casda/casda.rst
187187
cds/cds.rst
188+
linelists/cdms/cdms.rst
189+
dace/dace.rst
188190
esa/hubble.rst
189191
esa/iso.rst
190192
esa/jwst.rst
191193
esa/xmm_newton.rst
192194
esasky/esasky.rst
193195
eso/eso.rst
196+
image_cutouts/first/first.rst
194197
gaia/gaia.rst
195198
gama/gama.rst
196199
gemini/gemini.rst
197200
heasarc/heasarc.rst
198201
hips2fits/hips2fits.rst
199202
hitran/hitran.rst
203+
ipac/irsa/irsa_dust/irsa_dust.rst
200204
ipac/irsa/ibe/ibe.rst
201205
ipac/irsa/irsa.rst
202-
ipac/irsa/irsa_dust/irsa_dust.rst
203206
jplspec/jplspec.rst
204-
linelists/cdms/cdms.rst
205207
magpis/magpis.rst
206208
mast/mast.rst
207209
mpc/mpc.rst
@@ -221,7 +223,6 @@ The following modules have been completed using a common API:
221223
vo_conesearch/vo_conesearch.rst
222224
vsa/vsa.rst
223225
xmatch/xmatch.rst
224-
dace/dace.rst
225226

226227

227228
These others are functional, but do not follow a common & consistent API:
@@ -269,22 +270,22 @@ for each source)
269270
alfalfa/alfalfa.rst
270271
exoplanet_orbit_database/exoplanet_orbit_database.rst
271272
gama/gama.rst
273+
ipac/irsa/irsa_dust/irsa_dust.rst
272274
ipac/irsa/ibe/ibe.rst
273275
ipac/irsa/irsa.rst
274-
ipac/irsa/irsa_dust/irsa_dust.rst
275276
mast/mast.rst
276277
ipac/nexsci/nasa_exoplanet_archive.rst
277278
ipac/ned/ned.rst
278279
ogle/ogle.rst
279280
open_exoplanet_catalogue/open_exoplanet_catalogue.rst
280281
sdss/sdss.rst
281-
ipac/irsa/sha/sha.rst
282282
simbad/simbad.rst
283+
ipac/irsa/sha/sha.rst
283284
ukidss/ukidss.rst
284-
vsa/vsa.rst
285285
vizier/vizier.rst
286-
xmatch/xmatch.rst
287286
vo_conesearch/vo_conesearch.rst
287+
vsa/vsa.rst
288+
xmatch/xmatch.rst
288289

289290
Archives
290291
--------
@@ -301,25 +302,25 @@ generally return a table listing the available data first.
301302
casda/casda.rst
302303
esa/hubble.rst
303304
esa/jwst.rst
305+
esa/xmm_newton.rst
304306
eso/eso.rst
305307
fermi/fermi.rst
306308
gaia/gaia.rst
309+
gemini/gemini.rst
307310
heasarc/heasarc.rst
308311
ipac/irsa/ibe/ibe.rst
309312
ipac/irsa/irsa.rst
310313
magpis/magpis.rst
311-
gemini/gemini.rst
312314
mast/mast.rst
313315
ipac/ned/ned.rst
314316
noirlab/noirlab.rst
315317
nrao/nrao.rst
316318
nvas/nvas.rst
317319
sdss/sdss.rst
320+
skyview/skyview.rst
318321
ipac/irsa/sha/sha.rst
319322
ukidss/ukidss.rst
320323
vsa/vsa.rst
321-
skyview/skyview.rst
322-
esa/xmm_newton.rst
323324

324325
Simulations
325326
-----------
@@ -342,13 +343,13 @@ well as cross section and collision rates. Those services are:
342343
:maxdepth: 1
343344

344345
atomic/atomic.rst
346+
linelists/cdms/cdms.rst
347+
hitran/hitran.rst
348+
jplspec/jplspec.rst
345349
lamda/lamda.rst
346350
nist/nist.rst
347351
splatalogue/splatalogue.rst
348352
vamdc/vamdc.rst
349-
hitran/hitran.rst
350-
linelists/cdms/cdms.rst
351-
jplspec/jplspec.rst
352353

353354
Other
354355
-----
@@ -359,12 +360,12 @@ above categories. Those services are here:
359360
.. toctree::
360361
:maxdepth: 1
361362

362-
nasa_ads/nasa_ads.rst
363-
utils/tap.rst
363+
astrometry_net/astrometry_net.rst
364+
imcce/imcce.rst
364365
jplhorizons/jplhorizons.rst
365366
jplsbdb/jplsbdb.rst
366-
imcce/imcce.rst
367-
astrometry_net/astrometry_net.rst
367+
nasa_ads/nasa_ads.rst
368+
utils/tap.rst
368369

369370

370371
Topical Collections
@@ -376,8 +377,8 @@ topical submodules:
376377
.. toctree::
377378
:maxdepth: 1
378379

379-
solarsystem/solarsystem.rst
380380
image_cutouts/image_cutouts.rst
381+
solarsystem/solarsystem.rst
381382

382383

383384
Developer documentation

docs/solarsystem/solarsystem.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ The currently available service providers and services are:
1616
.. toctree::
1717
:maxdepth: 1
1818

19-
jpl/jpl.rst
2019
imcce/imcce.rst
20+
jpl/jpl.rst
2121
mpc/mpc.rst
2222

2323
Reference/API

0 commit comments

Comments
 (0)