1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132
|
.. Astropy documentation index file, created by
sphinx-quickstart on Tue Jul 26 02:59:34 2011.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
:tocdepth: 3
#################################################
astropy: A Community Python Library for Astronomy
#################################################
**Version**: |release| - :ref:`whatsnew-7.0`
**Useful links**:
:ref:`Installation <installing-astropy>` |
`Issues & Ideas <https://github.com/astropy/astropy/issues>`__ |
`Get Help <http://www.astropy.org/help.html>`__ |
`Contribute <http://www.astropy.org/contribute.html>`__ |
`About <http://www.astropy.org/about.html>`__
The ``astropy`` package contains key functionality and common tools needed for
performing astronomy and astrophysics with Python. It is at the core of the
`Astropy Project <http://www.astropy.org/about.html>`_, which aims to enable
the community to develop a robust ecosystem of `affiliated packages`_
covering a broad range of needs for astronomical research, data
processing, and data analysis.
.. Important:: If you use Astropy for work presented in a publication or talk
please help the project via proper `citation or acknowledgement
<https://www.astropy.org/acknowledging.html>`_. This also applies to use of
software or `affiliated packages`_ that depend on the astropy
core package.
.. toctree::
:maxdepth: 1
:hidden:
index_getting_started
index_user_docs
index_dev
index_project_details
.. grid:: 2
.. grid-item-card::
:img-top: _static/index-images/getting_started.svg
:text-align: center
Getting Started
^^^^^^^^^^^^^^^
New to Astropy? Check out the getting started guides. They contain an
introduction to astropy's main concepts and links to additional tutorials.
+++
.. button-ref:: index_getting_started
:expand:
:color: primary
:click-parent:
To the getting started guides
.. grid-item-card::
:img-top: _static/index-images/user_guide.svg
:text-align: center
User Guide
^^^^^^^^^^
The user guide provides in-depth information on the key concepts
of astropy with useful background information and explanation.
+++
.. button-ref:: index_user_docs
:expand:
:color: primary
:click-parent:
To the user guide
.. grid-item-card::
:img-top: _static/index-images/contributor.svg
:text-align: center
Contributor's Guide
^^^^^^^^^^^^^^^^^^^
Saw a typo in the documentation? Want to improve
existing functionalities? The contributing guidelines will guide
you through the process of improving astropy.
+++
.. button-ref:: index_dev
:expand:
:color: primary
:click-parent:
To the contributor's guide
.. grid-item-card::
:img-top: _static/index-images/api.svg
:text-align: center
Project Details
^^^^^^^^^^^^^^^
What's new in the latest release, changelog, and other project details.
+++
.. button-ref:: index_project_details
:expand:
:color: primary
:click-parent:
To the project details
.. image:: https://github.com/astropy/repo_stats/blob/cache/cache/astropy_user_stats_light.png?raw=true
:class: only-light
:target: https://docs.astropy.org/en/latest/impact_health.html
:alt: Astropy User Statistics
.. image:: https://github.com/astropy/repo_stats/blob/cache/cache/astropy_user_stats_dark.png?raw=true
:class: only-dark
:target: https://docs.astropy.org/en/latest/impact_health.html
:alt: Astropy User Statistics
.. _feedback@astropy.org: mailto:feedback@astropy.org
.. _affiliated packages: https://www.astropy.org/affiliated/
|