This is the documentation for the Astroquery affiliated package of astropy.
Code and issue tracker are on GitHub.
Astroquery is a set of tools for querying astronomical web forms and databases.
There are two other packages with complimentary functionality as Astroquery: pyvo is an Astropy affiliated package, and Simple-Cone-Search-Creator to generate a cone search service complying with the IVOA standard. They are more oriented to general virtual observatory discovery and queries, whereas Astroquery has web service specific interfaces.
Check out the :doc:`gallery` for some nice examples.
Astroquery has recently switched to a continuous deployment model, meaning that a release will be instantaniously available after each set of changes made to the code. The latest version of astroquery can be pip installed.
*Note: If an environment already has an older version of astroquery installed
add --upgrade to make sure the latest version is installed.
$ pip install --pre astroqueryWe also keep doing regular, tagged version for maintanence purposes. These
can be then conda installed from the astropy conda channel.
$ conda install -c astropy astroqueryThe development version can be obtained and installed from github:
$ # If you have a github account:
$ git clone git@github.com:astropy/astroquery.git
$ # If you do not:
$ git clone https://github.com/astropy/astroquery.git
$ cd astroquery
$ python setup.py installAstroquery works with Python 3.6 or later.
The following packages are required for astroquery installation & use:
and for running the tests:
The following packages are optional dependencies and are required for the full functionality of the ~astroquery.alma module:
The following packages are optional dependencies and are required for the full functionality of the ~astroquery.cds module:
- astropy-healpix
- regions
- mocpy >= 0.5.2
The following packages are optional dependencies and are required for the full functionality of the ~astroquery.mast module:
All astroquery modules are supposed to follow the same API. In its simplest form, the API involves queries based on coordinates or object names. Some simple examples, using SIMBAD:
>>> from astroquery.simbad import Simbad
>>> result_table = Simbad.query_object("m1")
>>> result_table.pprint(show_unit=True)
MAIN_ID RA DEC RA_PREC ... COO_QUAL COO_WAVELENGTH COO_BIBCODE
"h:m:s" "d:m:s" ...
------- ----------- ----------- ------- ... -------- -------------- -------------------
M 1 05 34 31.94 +22 00 52.2 6 ... C R 2011A&A...533A..10LAll query tools allow coordinate-based queries:
>>> from astropy import coordinates
>>> import astropy.units as u
>>> # works only for ICRS coordinates:
>>> c = coordinates.SkyCoord("05h35m17.3s -05d23m28s", frame='icrs')
>>> r = 5 * u.arcminute
>>> result_table = Simbad.query_region(c, radius=r)
>>> result_table.pprint(show_unit=True, max_width=80, max_lines=5)
MAIN_ID RA DEC ... COO_WAVELENGTH COO_BIBCODE
"h:m:s" "d:m:s" ...
------------ ------------ ------------ ... -------------- -------------------
M 42 05 35 17.3 -05 23 28 ... 1981MNRAS.194..693L
... ... ... ... ... ...
V* V2114 Ori 05 35 01.671 -05 26 36.30 ... I 2003yCat.2246....0CFor additional guidance and examples, read the documentation for the individual services below.
If you're new to Astroquery, a good place to start is the :doc:`gallery`:
.. toctree:: :maxdepth: 1 gallery
The following modules have been completed using a common API:
.. toctree:: :maxdepth: 1 alma/alma.rst atomic/atomic.rst besancon/besancon.rst cadc/cadc.rst casda/casda.rst cds/cds.rst esa/hubble.rst esasky/esasky.rst eso/eso.rst gaia/gaia.rst gama/gama.rst heasarc/heasarc.rst hitran/hitran.rst ibe/ibe.rst irsa/irsa.rst irsa/irsa_dust.rst jplspec/jplspec.rst magpis/magpis.rst mast/mast.rst mpc/mpc.rst nasa_ads/nasa_ads.rst ned/ned.rst nist/nist.rst nrao/nrao.rst nvas/nvas.rst simbad/simbad.rst skyview/skyview.rst splatalogue/splatalogue.rst ukidss/ukidss.rst vamdc/vamdc.rst vizier/vizier.rst vo_conesearch/vo_conesearch.rst vsa/vsa.rst xmatch/xmatch.rst dace/dace.rst
These others are functional, but do not follow a common & consistent API:
.. toctree:: :maxdepth: 1 alfalfa/alfalfa.rst cosmosim/cosmosim.rst exoplanet_orbit_database/exoplanet_orbit_database.rst fermi/fermi.rst jplhorizons/jplhorizons.rst jplsbdb/jplsbdb.rst lamda/lamda.rst nasa_exoplanet_archive/nasa_exoplanet_archive.rst oac/oac.rst ogle/ogle.rst open_exoplanet_catalogue/open_exoplanet_catalogue.rst sdss/sdss.rst sha/sha.rst
There are also subpackages that serve as the basis of others.
.. toctree:: :maxdepth: 1 wfau/wfau.rst
A second index of the services by the type of data they serve. Some services perform many tasks and are listed more than once.
The first serve catalogs, which generally return one row of information for each source (though they may return many catalogs that each have one row for each source)
.. toctree:: :maxdepth: 1 alfalfa/alfalfa.rst gama/gama.rst ibe/ibe.rst irsa/irsa.rst irsa/irsa_dust.rst mast/mast.rst ned/ned.rst ogle/ogle.rst open_exoplanet_catalogue/open_exoplanet_catalogue.rst sdss/sdss.rst sha/sha.rst simbad/simbad.rst ukidss/ukidss.rst vsa/vsa.rst vizier/vizier.rst xmatch/xmatch.rst vo_conesearch/vo_conesearch.rst nasa_exoplanet_archive/nasa_exoplanet_archive.rst exoplanet_orbit_database/exoplanet_orbit_database.rst
Archive services provide data, usually in FITS images or spectra. They will generally return a table listing the available data first.
.. toctree:: :maxdepth: 1 alfalfa/alfalfa.rst alma/alma.rst cadc/cadc.rst esa/hubble.rst eso/eso.rst fermi/fermi.rst gaia/gaia.rst heasarc/heasarc.rst ibe/ibe.rst irsa/irsa.rst magpis/magpis.rst mast/mast.rst ned/ned.rst nrao/nrao.rst nvas/nvas.rst sdss/sdss.rst sha/sha.rst ukidss/ukidss.rst vsa/vsa.rst skyview/skyview.rst
These services query databases of simulated or synthetic data:
.. toctree:: :maxdepth: 1 besancon/besancon.rst cosmosim/cosmosim.rst
There are several web services that provide atomic or molecular line lists, as well as cross section and collision rates. Those services are:
.. toctree:: :maxdepth: 1 atomic/atomic.rst lamda/lamda.rst nist/nist.rst splatalogue/splatalogue.rst vamdc/vamdc.rst hitran/hitran.rst
There are other astronomically significant services, that don't fit the above categories. Those services are here:
.. toctree:: :maxdepth: 1 nasa_ads/nasa_ads.rst utils/tap.rst jplhorizons/jplhorizons.rst jplsbdb/jplsbdb.rst jplspec/jplspec.rst imcce/imcce.rst astrometry_net/astrometry_net.rst
Some services focusing on similar topics are also collected in topical submodules:
.. toctree:: :maxdepth: 1 solarsystem/solarsystem.rst
The modules and their maintainers are listed on the Maintainers wiki page.
The :doc:`api` is intended to be kept as consistent as possible, such that any web service can be used with a minimal learning curve imposed on the user.
.. toctree:: :maxdepth: 1 api.rst template.rst testing.rst team.rst
The following Astroquery modules are mostly meant for internal use of services in Astroquery, you can use them for your scripts, but we don't guarantee API stability.
.. toctree:: :maxdepth: 1 utils.rst query.rst utils/tap.rst
Astroquery is licensed under a 3-clause BSD style license - see :doc:`license`.