Skip to content

Latest commit

 

History

History
142 lines (97 loc) · 5.45 KB

index.rst

File metadata and controls

142 lines (97 loc) · 5.45 KB
logos/astropy_banner_96.png

The Astropy Project is a community effort to develop a single core package for Astronomy in Python and foster interoperability between Python astronomy packages. Development is actively ongoing, with major packages such as PyFITS, PyWCS, vo, and asciitable already merged in, and many other components are under development. For more details, on the plan for the Astropy project, you can read the :doc:`original vision <vision>`, or the documentation overview.

The current stable version is Astropy 0.3. (Changelog)

Stay updated by following @astropy on Twitter, and sign up for the astropy mailing list, where you can ask python astronomy questions of all sorts! If you want to get involved in Astropy development efforts, or other more technical discussions of Astropy, join the astropy-dev list.

Please note: If you use Astropy for work/research presented in a publication, please read Acknowledging the use of Astropy.

How to start working with Astropy

Take a look at the Getting Started guide in the documentation for an initial look at how to work with Astropy.

Documentation

The documentation for the astropy core package is available at the websites listed below. The first is for the most recent released version. The second is for a version of the documentation that is automatically updated any time a change is made to the astropy source code repository.

Installing

Detailed up-to-date installation instructions are provided in the latest documentation, but we have included a simplified version here.

Astropy requires Python 2.6, 2.7, 3.1, 3.2, or 3.3, and Numpy 1.5 or later. The best way to install astropy is to use pip:

pip install astropy

Or alternatively, you can download the source from the current version (Astropy 0.3), and install the source code in that archive using:

python setup.py install

You can check that astropy is correctly installed by starting up python or ipython, and importing astropy:

>>> import astropy

If you do not get any errors, the installation was successful!

Note

If you want to install the latest developer version of Astropy, use:

git clone https://github.com/astropy/astropy.git
cd astropy
python setup.py install

Be aware that the developer build requires Cython (in addition to Numpy).

Getting help

If you want to discuss issues with other Astropy users, you can sign up to the astropy mailing list. Alternatively, the astropy-dev list is where you should go to discuss more technical aspects of Astropy.

Reporting issues

If you have come across something that you believe is a bug, please open a ticket in the Astropy issue tracker, and we will look into it promptly!

Acknowledging the use of Astropy

Publications

If you use Astropy for work/research presented in a publication (whether directly, or as a dependency to another package), we would be grateful if you could include the following acknowledgment:

This research made use of Astropy, a community-developed core Python package for Astronomy (Astropy Collaboration, 2013).

where (Astropy Collaboration, 2013) is a citation to this paper (ADS - BibTeX).

If you wish, you can also include a link to http://www.astropy.org (if the journal allows this) in addition to the above text.

Presentations

If you are giving a presentation or talk featuring work/research that makes use of Astropy and would like to acknowledge Astropy, we suggest using :download:`this logo <logos/astropy_powered.png>` on your title slide:

logos/astropy_powered.png

The logo is :download:`also available with white text <logos/astropy_powered_white.png>`, or the SVG originals can be obtained at the astropy-logo github repository.