======= Astropy

.. container::

|Actions Status| |CircleCI Status| |Coverage Status| |PyPI Status| |Documentation Status| |Pre-Commit| |Ruff| |Zenodo|

The Astropy Project (https://astropy.org/) is a community effort to develop a single core package for Astronomy in Python and foster interoperability between Python astronomy packages. This repository contains the core package which is intended to contain much of the core functionality and some common tools needed for performing astronomy and astrophysics with Python.

Installation <#installation>_
Contributing <#contributing>_
Getting Started with GitHub Codespaces <#getting-started-with-github-codespaces>_
Supporting the Project <#supporting-the-project>_
License <#license>_

Installation

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

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

To install astropy from PyPI, use:

.. code-block:: bash

pip install astropy

Contributing

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 <https://www.astropy.org/about.html#codeofconduct>_.

More detailed information on contributing to the project or submitting feedback can be found on the contributions page <https://www.astropy.org/contribute.html>. A summary of contribution guidelines <CONTRIBUTING.md> can also be used as a quick reference when you are ready to start writing or validating code for submission.

Getting Started with GitHub Codespaces

Codespaces is a cloud development environment supported by GitHub. None of the Astropy build machinery depends on it, but it is a convenient way to quickly get started doing development on Astropy.

To get started, create a codespace for this repository by clicking this:

|Codespaces|

A codespace will open in a web-based version of Visual Studio Code. The dev container <.devcontainer/devcontainer.json> is fully configured with software needed for this project. For help, see the GitHub Codespaces Support page <https://docs.github.com/en/codespaces>.

Note: Dev containers is an open spec which is supported by GitHub Codespaces <https://github.com/codespaces> and other tools <https://containers.dev/supporting>.

Supporting the Project

|NumFOCUS| |Donate|

The Astropy Project is sponsored by NumFOCUS, a 501(c)(3) nonprofit in the United States. You can donate to the project by using the link above, and this donation will support our mission to promote sustainable, high-level code base for the astronomy community, open code development, educational materials, and reproducible scientific research.