|
1 | 1 | # Astropy Tutorials |
2 | 2 |
|
3 | 3 | This repository contains tutorial IPython notebooks for the |
4 | | -[Astropy](http://astropy.org) project. These are typically longer-form, more |
| 4 | +[Astropy](http://astropy.org) project. These are typically longer-form, |
5 | 5 | narrative presentations of functionality in the [Astropy core |
6 | 6 | package](https://github.com/astropy/astropy) and any [affiliated |
7 | | -packages](http://www.astropy.org/affiliated/index.html). The tutorials are |
8 | | -therefore different from the [Astropy core package |
9 | | -documentation](http://docs.astropy.org), which presents a more structured and |
10 | | -exhaustive view of the Astropy core package. |
| 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. |
11 | 10 |
|
12 | 11 |
|
13 | | -## View the tutorials rendered as HTML pages |
| 12 | +## Viewing and running the tutorials |
14 | 13 |
|
15 | 14 | To see the tutorials rendered as static web pages, see the [Learn Astropy |
16 | 15 | website](https://learn.astropy.org). |
17 | 16 |
|
18 | | -To execute the tutorials interactively, you can either clone this repository to |
19 | | -your local machine or use Binder to run the tutorials remotely, as described |
20 | | -below. |
| 17 | +To execute the tutorials interactively, either use Binder to run the tutorials |
| 18 | +remotely or clone this repository to your local machine. |
21 | 19 |
|
| 20 | +### Run the tutorials in your browser with Binder |
22 | 21 |
|
23 | | -## Run the tutorials locally |
24 | | - |
25 | | -To run the tutorials locally, you should start by cloning this repository with |
26 | | -`git` or downloading an archive of this repository from GitHub. You will need to |
27 | | -have [Jupyter notebook](http://jupyter.org/) and IPython installed and will need |
28 | | -to install the tutorial dependencies specified in `requirements.txt`: |
29 | | - |
30 | | - python -m pip install -r requirements.txt |
31 | | - |
32 | | -To check that your environment is set up to run the tutorials, you can use the |
33 | | -Makefile provided in this repository with the custom `envcheck` command: |
34 | | - |
35 | | - make envcheck |
36 | | - |
37 | | -If this line fails, your environment is missing packages, and you should run the |
38 | | -pip install line shown above. |
39 | | - |
40 | | -The notebook files themselves live in the `tutorials` directory of this |
41 | | -repository, organized by the names of the tutorials. These can be opened with |
42 | | -Jupyter notebook as with any other notebook files. |
43 | | - |
| 22 | +[](https://mybinder.org/v2/gh/astropy/astropy-tutorials/main?filepath=tutorials) |
44 | 23 |
|
45 | | -## Run the tutorials on Binder |
| 24 | +### Run the tutorials locally |
46 | 25 |
|
47 | | -You can also get started with a remote environment to run the tutorial notebooks |
48 | | -in your browser using [Binder](http://mybinder.org) |
| 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: |
49 | 31 |
|
50 | | -[](https://mybinder.org/v2/gh/astropy/astropy-tutorials/main?filepath=tutorials) |
| 32 | + python -m pip install -r FITS-cubes/requirements.txt |
51 | 33 |
|
52 | 34 |
|
53 | | -Contributing tutorial material |
54 | | ------------------------------- |
| 35 | +## Contributing tutorial material |
55 | 36 |
|
56 | 37 | We are always interested in incorporating new tutorials into Learn Astropy and |
57 | | -the Astropy Tutorials series. We welcome tutorials covering astro-relevant topics and they do not |
58 | | -necessarily need to use the Astropy package in order to be hosted or indexed here. |
| 38 | +the Astropy Tutorials series. We welcome tutorials covering astro-relevant topics; they |
| 39 | +do not need to use the Astropy package in order to be hosted or indexed here. |
59 | 40 | If you have astronomy tutorials that you would like to contribute to this repository, |
60 | 41 | or if you have a separate tutorial series that you would like indexed by the |
61 | 42 | Learn Astropy website, please see the [Contributing |
|
0 commit comments