=======
Astropy
=======

.. image:: https://img.shields.io/pypi/v/astropy.svg
    :target: https://pypi.python.org/pypi/astropy

Astropy (http://www.astropy.org) is a package intended to contain much of
the core functionality and some common tools needed for performing
astronomy and astrophysics with Python.

Releases are `registered on PyPI <http://pypi.python.org/pypi/astropy>`_,
and development is occurring at the
`project's github page <http://github.com/astropy/astropy>`_.

For installation instructions, see the `online documentation <http://docs.astropy.org/>`_
or  ``docs/install.rst`` in this source distribution.

For system packagers: Please install Astropy with the command::

    $ python setup.py --offline install

This will prevent the astropy_helpers bootstrap script from attempting to
reach out to PyPI.

Project Status
--------------

.. image:: https://travis-ci.org/astropy/astropy.svg
    :target: https://travis-ci.org/astropy/astropy
    :alt: Astropy's Travis CI Status

.. image:: https://circleci.com/gh/astropy/astropy.svg?style=svg
    :target: https://circleci.com/gh/astropy/astropy
    :alt: Astropy's CircleCI Status

.. image:: https://codecov.io/gh/astropy/astropy/branch/master/graph/badge.svg
    :target: https://codecov.io/gh/astropy/astropy
    :alt: Astropy's Coverage Status

.. image:: https://ci.appveyor.com/api/projects/status/ym7lxajcs5qwm31e/branch/master?svg=true
    :target: https://ci.appveyor.com/project/Astropy/astropy/branch/master
    :alt: Astropy's Appveyor Status

For an overview of the testing and build status of all packages associated
with the Astropy Project, see http://dashboard.astropy.org.

.. image:: https://img.shields.io/badge/powered%20by-NumFOCUS-orange.svg?style=flat&colorA=E1523D&colorB=007D8A
    :target: http://numfocus.org
    :alt: Powered by NumFOCUS


Contributing Code, Documentation, or Feedback
---------------------------------------------
The Astropy project is made both by and for its users, so we welcome and encourage
contributions of many kinds. Our goal is to keep this a positive, inclusive,
successful, and growing community, by abiding with the
`Astropy Community Code of Conduct <http://www.astropy.org/about.html#codeofconduct>`_.

More detailed information on contributing to the project or submitting feedback
can be found on the `contributions <http://www.astropy.org/contribute.html>`_ page.

A `summary of contribution guidelines <CONTRIBUTING.md>`_ can also be used as a quick
reference when you're ready to start writing or validating code for submission.

License
-------
Astropy is licensed under a 3-clause BSD style license - see the
``LICENSE.rst`` file.
