|
1 | 1 | # Astropy Tutorials |
2 | 2 |
|
3 | | -This repository contains tutorial Jupyter notebooks for the |
4 | | -[Astropy](http://astropy.org) project. These are typically longer-form, |
5 | | -narrative presentations of functionality in the [Astropy core |
6 | | -package](https://github.com/astropy/astropy) and any [affiliated |
7 | | -packages](http://www.astropy.org/affiliated/index.html). The tutorials are different |
8 | | -from the [Astropy core package documentation](http://docs.astropy.org), which presents a |
9 | | -more structured and exhaustive view of the Astropy core package. |
10 | | - |
11 | | - |
12 | | -## Viewing and running the tutorials |
13 | | - |
14 | | -To see the tutorials rendered as static web pages, see the [Learn Astropy |
15 | | -website](https://learn.astropy.org). |
16 | | - |
17 | | -To execute the tutorials interactively, either use Binder to run the tutorials |
18 | | -remotely or clone this repository to your local machine. |
19 | | - |
20 | | -### Run the tutorials in your browser with Binder |
21 | | - |
22 | | -[](https://mybinder.org/v2/gh/astropy/astropy-tutorials/main?filepath=tutorials) |
23 | | - |
24 | | -### Run the tutorials locally |
25 | | - |
26 | | -Clone this repository with `git` or download an archive of the repository from |
27 | | -GitHub. You will need to have [Jupyter notebook](http://jupyter.org/) and IPython |
28 | | -installed. Then install the `requirements.txt` that are specified in the folder |
29 | | -containing the specific `.ipynb` tutorial you wish to run. For example, to run the |
30 | | -`FITS-cubes.ipynb` tutorial, first install: |
31 | | - |
32 | | - python -m pip install -r FITS-cubes/requirements.txt |
33 | | - |
34 | | - |
35 | 3 | ## Contributing tutorial material |
36 | 4 |
|
37 | 5 | We are always interested in incorporating new tutorials into Learn Astropy and |
38 | 6 | the Astropy Tutorials series. We welcome tutorials covering astro-relevant topics; they |
39 | 7 | do not need to use the Astropy package in order to be hosted or indexed here. |
40 | | -If you have astronomy tutorials that you would like to contribute to this repository, |
| 8 | +If you have astronomy tutorials that you would like to contribute, |
41 | 9 | or if you have a separate tutorial series that you would like indexed by the |
42 | 10 | Learn Astropy website, see the [Contributing |
43 | 11 | Guide](https://learn.astropy.org/contributing) on the Learn Astropy website for |
|
0 commit comments