1=======
2Astropy
3=======
4
5|Actions Status| |CircleCI Status| |Azure Status| |Coverage Status| |PyPI Status| |Documentation Status| |Zenodo|
6
7The Astropy Project (http://astropy.org/) is a community effort to develop a
8single core package for Astronomy in Python and foster interoperability between
9Python astronomy packages. This repository contains the core package which is
10intended to contain much of the core functionality and some common tools needed
11for performing astronomy and astrophysics with Python.
12
13Releases are `registered on PyPI <https://pypi.org/project/astropy>`_,
14and development is occurring at the
15`project's GitHub page <http://github.com/astropy/astropy>`_.
16
17For installation instructions, see the `online documentation <https://docs.astropy.org/>`_
18or  `docs/install.rst <docs/install.rst>`_ in this source distribution.
19
20Contributing Code, Documentation, or Feedback
21---------------------------------------------
22
23The Astropy Project is made both by and for its users, so we welcome and
24encourage contributions of many kinds. Our goal is to keep this a positive,
25inclusive, successful, and growing community by abiding with the
26`Astropy Community Code of Conduct <http://www.astropy.org/about.html#codeofconduct>`_.
27
28More detailed information on contributing to the project or submitting feedback
29can be found on the `contributions <http://www.astropy.org/contribute.html>`_
30page. A `summary of contribution guidelines <CONTRIBUTING.md>`_ can also be
31used as a quick reference when you are ready to start writing or validating
32code for submission.
33
34Supporting the Project
35----------------------
36
37|NumFOCUS| |Donate|
38
39The Astropy Project is sponsored by NumFOCUS, a 501(c)(3) nonprofit in the
40United States. You can donate to the project by using the link above, and this
41donation will support our mission to promote sustainable, high-level code base
42for the astronomy community, open code development, educational materials, and
43reproducible scientific research.
44
45License
46-------
47
48Astropy is licensed under a 3-clause BSD style license - see the
49`LICENSE.rst <LICENSE.rst>`_ file.
50
51.. |Actions Status| image:: https://github.com/astropy/astropy/workflows/CI/badge.svg
52    :target: https://github.com/astropy/astropy/actions
53    :alt: Astropy's GitHub Actions CI Status
54
55.. |CircleCI Status| image::  https://img.shields.io/circleci/build/github/astropy/astropy/main?logo=circleci&label=CircleCI
56    :target: https://circleci.com/gh/astropy/astropy
57    :alt: Astropy's CircleCI Status
58
59.. |Azure Status| image:: https://dev.azure.com/astropy-project/astropy/_apis/build/status/astropy.astropy?repoName=astropy%2Fastropy&branchName=main
60    :target: https://dev.azure.com/astropy-project/astropy
61    :alt: Astropy's Azure Pipelines Status
62
63.. |Coverage Status| image:: https://codecov.io/gh/astropy/astropy/branch/main/graph/badge.svg
64    :target: https://codecov.io/gh/astropy/astropy
65    :alt: Astropy's Coverage Status
66
67.. |PyPI Status| image:: https://img.shields.io/pypi/v/astropy.svg
68    :target: https://pypi.org/project/astropy
69    :alt: Astropy's PyPI Status
70
71.. |Zenodo| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.4670728.svg
72   :target: https://doi.org/10.5281/zenodo.4670728
73   :alt: Zenodo DOI
74
75.. |Documentation Status| image:: https://img.shields.io/readthedocs/astropy/latest.svg?logo=read%20the%20docs&logoColor=white&label=Docs&version=stable
76    :target: https://docs.astropy.org/en/stable/?badge=stable
77    :alt: Documentation Status
78
79.. |NumFOCUS| image:: https://img.shields.io/badge/powered%20by-NumFOCUS-orange.svg?style=flat&colorA=E1523D&colorB=007D8A
80    :target: http://numfocus.org
81    :alt: Powered by NumFOCUS
82
83.. |Donate| image:: https://img.shields.io/badge/Donate-to%20Astropy-brightgreen.svg
84    :target: https://numfocus.salsalabs.org/donate-to-astropy/index.html
85
86
87If you locally cloned this repo before 7 Apr 2021
88-------------------------------------------------
89
90The primary branch for this repo has been transitioned from ``master`` to
91``main``.  If you have a local clone of this repository and want to keep your
92local branch in sync with this repo, you'll need to do the following in your
93local clone from your terminal::
94
95   git fetch --all --prune
96   # you can stop here if you don't use your local "master"/"main" branch
97   git branch -m master main
98   git branch -u origin/main main
99
100If you are using a GUI to manage your repos you'll have to find the equivalent
101commands as it's different for different programs. Alternatively, you can just
102delete your local clone and re-clone!
103