astroquery


Nameastroquery JSON
Version 0.4.7 PyPI version JSON
download
home_page
SummaryFunctions and classes to access online astronomical data resources
upload_time2024-03-09 06:41:46
maintainer
docs_urlNone
authorThe Astroquery Developers
requires_python>=3.7
licenseBSD
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            `Documentation`_ | Blog_ |  `View on Github`_ |  `Download Stable ZIP`_  |  `Download Stable TAR`_

.. image:: https://img.shields.io/pypi/v/astroquery.svg
    :target: https://pypi.org/project/astroquery/#history
    :alt: Latest PyPI version

.. image:: https://readthedocs.org/projects/astroquery/badge/?version=latest
    :target: https://astroquery.readthedocs.io/en/latest/?badge=latest
    :alt: Documentation Status

.. image:: https://github.com/astropy/astroquery/workflows/CI/badge.svg
    :target: https://github.com/astropy/astroquery/actions?query=workflow%3ACI
    :alt: Github Actions CI Status

.. image:: https://codecov.io/gh/astropy/astroquery/branch/main/graph/badge.svg
    :target: https://codecov.io/gh/astropy/astroquery
    :alt: Coverage results

.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.1160627.svg
   :target: https://doi.org/10.5281/zenodo.1160627
   :alt: Zenodo


==================================
Accessing Online Astronomical Data
==================================

Astroquery is an `astropy <https://www.astropy.org>`_ affiliated package that
contains a collection of tools to access online Astronomical data. Each web
service has its own sub-package. For example, to interface with the `SIMBAD
website <https://simbad.cds.unistra.fr/simbad/>`_, use the ``simbad`` sub-package:

.. code-block:: python

    >>> from astroquery.simbad import Simbad
    >>> theta1c = Simbad.query_object('tet01 Ori C')
    >>> theta1c.pprint()
       MAIN_ID          RA           DEC      ... COO_QUAL COO_WAVELENGTH     COO_BIBCODE
    ------------- ------------- ------------- ... -------- -------------- -------------------
    * tet01 Ori C 05 35 16.4637 -05 23 22.848 ...        A              O 2007A&A...474..653V

Installation and Requirements
-----------------------------

Astroquery works with Python 3.7 or later.
As an `astropy`_ affiliate, astroquery requires `astropy`_ version 4.2.1 or later.

astroquery uses the `requests <https://requests.readthedocs.io/en/latest/>`_
module to communicate with the internet.  `BeautifulSoup
<https://www.crummy.com/software/BeautifulSoup/>`_ and `html5lib'
<https://html5lib.readthedocs.io/en/latest/>`_ are needed for HTML parsing for
some services.  The `keyring <https://pypi.python.org/pypi/keyring>`_ module is
also required for accessing services that require a login.  These can all be
installed using `pip <https://pypi.python.org/pypi/pip>`_ or `anaconda
<https://www.anaconda.com/>`_.  Running the tests requires `curl
<https://curl.haxx.se/>`_ to be installed.

The latest version of astroquery can be pip installed (note the ``--pre`` for
picking up released developer versions, and ``-U`` for upgrade):

.. code-block:: bash

    $ python -m pip install -U --pre astroquery

To install all the mandatory and optional dependencies add the ``[all]``
identifier to the pip command above (or use ``[docs]`` or ``[test]`` for the
dependencies required to build the documentation or run the tests):

.. code-block:: bash

    $ python -m pip install -U --pre astroquery[all]


To install the 'bleeding edge' version:

.. code-block:: bash

   $ python -m pip install git+https://github.com/astropy/astroquery.git

or cloned and installed from source:

.. code-block:: bash

    $ # 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 -m pip install .

Using astroquery
----------------

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

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

Citing Astroquery
-----------------

If you use ``astroquery``, please cite the paper we published in `The
Astronomical Journal <https://adsabs.harvard.edu/abs/2019AJ....157...98G>`__.

The BibTeX entry is available from the package itself::

  import astroquery
  astroquery.__citation__


In addition you may also want to refer to specific versions of the
package. We create a separate Zenodo DOI for each version, they can be
looked up at the following `Zenodo page <https://doi.org/10.5281/zenodo.591669>`__


Additional Links
----------------

`Download Development ZIP`_  |  `Download Development TAR`_

Maintained by `Adam Ginsburg`_ and `Brigitta Sipocz <https://github.com/bsipocz>`_ (`astropy.astroquery@gmail.com`_)


.. _Download Development ZIP: https://github.com/astropy/astroquery/zipball/main
.. _Download Development TAR: https://github.com/astropy/astroquery/tarball/main
.. _Download Stable ZIP: https://github.com/astropy/astroquery/zipball/stable
.. _Download Stable TAR: https://github.com/astropy/astroquery/tarball/stable
.. _View on Github: https://github.com/astropy/astroquery/
.. _Documentation: https://astroquery.readthedocs.io
.. _astropy.astroquery@gmail.com: mailto:astropy.astroquery@gmail.com
.. _Adam Ginsburg: https://www.adamgginsburg.com
.. _Blog: http://astropy.org/astroquery-blog
.. _API: https://astroquery.readthedocs.io/en/latest/api.html

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "astroquery",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": "",
    "keywords": "",
    "author": "The Astroquery Developers",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/8f/0e/56d62ba2319d5ce5f7aaf663503a7ee65a9d688685ee5250cef81d363fa4/astroquery-0.4.7.tar.gz",
    "platform": null,
    "description": "`Documentation`_ | Blog_ |  `View on Github`_ |  `Download Stable ZIP`_  |  `Download Stable TAR`_\n\n.. image:: https://img.shields.io/pypi/v/astroquery.svg\n    :target: https://pypi.org/project/astroquery/#history\n    :alt: Latest PyPI version\n\n.. image:: https://readthedocs.org/projects/astroquery/badge/?version=latest\n    :target: https://astroquery.readthedocs.io/en/latest/?badge=latest\n    :alt: Documentation Status\n\n.. image:: https://github.com/astropy/astroquery/workflows/CI/badge.svg\n    :target: https://github.com/astropy/astroquery/actions?query=workflow%3ACI\n    :alt: Github Actions CI Status\n\n.. image:: https://codecov.io/gh/astropy/astroquery/branch/main/graph/badge.svg\n    :target: https://codecov.io/gh/astropy/astroquery\n    :alt: Coverage results\n\n.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.1160627.svg\n   :target: https://doi.org/10.5281/zenodo.1160627\n   :alt: Zenodo\n\n\n==================================\nAccessing Online Astronomical Data\n==================================\n\nAstroquery is an `astropy <https://www.astropy.org>`_ affiliated package that\ncontains a collection of tools to access online Astronomical data. Each web\nservice has its own sub-package. For example, to interface with the `SIMBAD\nwebsite <https://simbad.cds.unistra.fr/simbad/>`_, use the ``simbad`` sub-package:\n\n.. code-block:: python\n\n    >>> from astroquery.simbad import Simbad\n    >>> theta1c = Simbad.query_object('tet01 Ori C')\n    >>> theta1c.pprint()\n       MAIN_ID          RA           DEC      ... COO_QUAL COO_WAVELENGTH     COO_BIBCODE\n    ------------- ------------- ------------- ... -------- -------------- -------------------\n    * tet01 Ori C 05 35 16.4637 -05 23 22.848 ...        A              O 2007A&A...474..653V\n\nInstallation and Requirements\n-----------------------------\n\nAstroquery works with Python 3.7 or later.\nAs an `astropy`_ affiliate, astroquery requires `astropy`_ version 4.2.1 or later.\n\nastroquery uses the `requests <https://requests.readthedocs.io/en/latest/>`_\nmodule to communicate with the internet.  `BeautifulSoup\n<https://www.crummy.com/software/BeautifulSoup/>`_ and `html5lib'\n<https://html5lib.readthedocs.io/en/latest/>`_ are needed for HTML parsing for\nsome services.  The `keyring <https://pypi.python.org/pypi/keyring>`_ module is\nalso required for accessing services that require a login.  These can all be\ninstalled using `pip <https://pypi.python.org/pypi/pip>`_ or `anaconda\n<https://www.anaconda.com/>`_.  Running the tests requires `curl\n<https://curl.haxx.se/>`_ to be installed.\n\nThe latest version of astroquery can be pip installed (note the ``--pre`` for\npicking up released developer versions, and ``-U`` for upgrade):\n\n.. code-block:: bash\n\n    $ python -m pip install -U --pre astroquery\n\nTo install all the mandatory and optional dependencies add the ``[all]``\nidentifier to the pip command above (or use ``[docs]`` or ``[test]`` for the\ndependencies required to build the documentation or run the tests):\n\n.. code-block:: bash\n\n    $ python -m pip install -U --pre astroquery[all]\n\n\nTo install the 'bleeding edge' version:\n\n.. code-block:: bash\n\n   $ python -m pip install git+https://github.com/astropy/astroquery.git\n\nor cloned and installed from source:\n\n.. code-block:: bash\n\n    $ # If you have a github account:\n    $ git clone git@github.com:astropy/astroquery.git\n    $ # If you do not:\n    $ git clone https://github.com/astropy/astroquery.git\n    $ cd astroquery\n    $ python -m pip install .\n\nUsing astroquery\n----------------\n\nImporting astroquery on its own doesn't get you much: you need to import each\nsub-module specifically.  See the documentation for a list of `Available\nServices <https://astroquery.readthedocs.io/en/latest/#available-services>`_.\nThe `API`_ shows the standard suite of tools common to most modules, e.g.\n`query_object` and `query_region`.\n\nTo report bugs and request features, please use the issue tracker.  Code\ncontributions are very welcome, though we encourage you to follow the `API`_\nand `contributing guidelines\n<https://github.com/astropy/astroquery/blob/main/CONTRIBUTING.rst>`_ as much\nas possible.\n\nCiting Astroquery\n-----------------\n\nIf you use ``astroquery``, please cite the paper we published in `The\nAstronomical Journal <https://adsabs.harvard.edu/abs/2019AJ....157...98G>`__.\n\nThe BibTeX entry is available from the package itself::\n\n  import astroquery\n  astroquery.__citation__\n\n\nIn addition you may also want to refer to specific versions of the\npackage. We create a separate Zenodo DOI for each version, they can be\nlooked up at the following `Zenodo page <https://doi.org/10.5281/zenodo.591669>`__\n\n\nAdditional Links\n----------------\n\n`Download Development ZIP`_  |  `Download Development TAR`_\n\nMaintained by `Adam Ginsburg`_ and `Brigitta Sipocz <https://github.com/bsipocz>`_ (`astropy.astroquery@gmail.com`_)\n\n\n.. _Download Development ZIP: https://github.com/astropy/astroquery/zipball/main\n.. _Download Development TAR: https://github.com/astropy/astroquery/tarball/main\n.. _Download Stable ZIP: https://github.com/astropy/astroquery/zipball/stable\n.. _Download Stable TAR: https://github.com/astropy/astroquery/tarball/stable\n.. _View on Github: https://github.com/astropy/astroquery/\n.. _Documentation: https://astroquery.readthedocs.io\n.. _astropy.astroquery@gmail.com: mailto:astropy.astroquery@gmail.com\n.. _Adam Ginsburg: https://www.adamgginsburg.com\n.. _Blog: http://astropy.org/astroquery-blog\n.. _API: https://astroquery.readthedocs.io/en/latest/api.html\n",
    "bugtrack_url": null,
    "license": "BSD",
    "summary": "Functions and classes to access online astronomical data resources",
    "version": "0.4.7",
    "project_urls": {
        "Documentation": "https://astroquery.readthedocs.io",
        "Source": "https://github.com/astropy/astroquery"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "77243f78dc9e4357159ae223390a8ddbcf8d30c71b19896ab461214b1b4a71de",
                "md5": "a92e7d9ff4f3f505de21fbdceaa0e965",
                "sha256": "dfa8ca46ca0a983f66e9547c774601b331770242f9f6245df5e603f795d75540"
            },
            "downloads": -1,
            "filename": "astroquery-0.4.7-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "a92e7d9ff4f3f505de21fbdceaa0e965",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 5298594,
            "upload_time": "2024-03-09T06:41:39",
            "upload_time_iso_8601": "2024-03-09T06:41:39.529474Z",
            "url": "https://files.pythonhosted.org/packages/77/24/3f78dc9e4357159ae223390a8ddbcf8d30c71b19896ab461214b1b4a71de/astroquery-0.4.7-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "8f0e56d62ba2319d5ce5f7aaf663503a7ee65a9d688685ee5250cef81d363fa4",
                "md5": "1318e5e50f6d80e5743d511b8af5abb5",
                "sha256": "047fbacb0a4faec4cdb62675e919c244c1c35e661044fcbb6c9a933331747ec9"
            },
            "downloads": -1,
            "filename": "astroquery-0.4.7.tar.gz",
            "has_sig": false,
            "md5_digest": "1318e5e50f6d80e5743d511b8af5abb5",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 6504222,
            "upload_time": "2024-03-09T06:41:46",
            "upload_time_iso_8601": "2024-03-09T06:41:46.719372Z",
            "url": "https://files.pythonhosted.org/packages/8f/0e/56d62ba2319d5ce5f7aaf663503a7ee65a9d688685ee5250cef81d363fa4/astroquery-0.4.7.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-03-09 06:41:46",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "astropy",
    "github_project": "astroquery",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "tox": true,
    "lcname": "astroquery"
}
        
Elapsed time: 0.45563s