Astropy Tutorials

This repository contains tutorial IPython notebooks for the Astropy project. These are typically longer-form, narrative presentations of functionality in the Astropy core package and any affiliated packages. The tutorials are different from the Astropy core package documentation, which presents a more structured and exhaustive view of the Astropy core package.

Viewing and running the tutorials

To see the tutorials rendered as static web pages, see the Learn Astropy website.

To execute the tutorials interactively, either use Binder to run the tutorials remotely or clone this repository to your local machine.

Run the tutorials in your browser with Binder

Run the tutorials locally

Clone this repository with git or download an archive of the repository from GitHub. You will need to have Jupyter notebook and IPython installed. Then install the requirements.txt that are specified in the folder containing the specific .ipynb tutorial you wish to run. For example, to run the FITS-cubes.ipynb tutorial, first install:

python -m pip install -r FITS-cubes/requirements.txt

Contributing tutorial material

We are always interested in incorporating new tutorials into Learn Astropy and the Astropy Tutorials series. We welcome tutorials covering astro-relevant topics; they do not need to use the Astropy package in order to be hosted or indexed here. If you have astronomy tutorials that you would like to contribute to this repository, or if you have a separate tutorial series that you would like indexed by the Learn Astropy website, please see the Contributing Guide on the Learn Astropy website for information on how to get started.