Skip to content

Commit 5b73553

Browse files
authored
Merge pull request #617 from jeffjennings/binder_build
Binder dependencies
2 parents e7d20e1 + c810359 commit 5b73553

File tree

2 files changed

+34
-38
lines changed

2 files changed

+34
-38
lines changed

README.md

Lines changed: 19 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,61 +1,42 @@
11
# Astropy Tutorials
22

33
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,
55
narrative presentations of functionality in the [Astropy core
66
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.
1110

1211

13-
## View the tutorials rendered as HTML pages
12+
## Viewing and running the tutorials
1413

1514
To see the tutorials rendered as static web pages, see the [Learn Astropy
1615
website](https://learn.astropy.org).
1716

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.
2119

20+
### Run the tutorials in your browser with Binder
2221

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+
[![Binder](http://mybinder.org/badge.svg)](https://mybinder.org/v2/gh/astropy/astropy-tutorials/main?filepath=tutorials)
4423

45-
## Run the tutorials on Binder
24+
### Run the tutorials locally
4625

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:
4931

50-
[![Binder](http://mybinder.org/badge.svg)](https://mybinder.org/v2/gh/astropy/astropy-tutorials/main?filepath=tutorials)
32+
python -m pip install -r FITS-cubes/requirements.txt
5133

5234

53-
Contributing tutorial material
54-
------------------------------
35+
## Contributing tutorial material
5536

5637
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.
5940
If you have astronomy tutorials that you would like to contribute to this repository,
6041
or if you have a separate tutorial series that you would like indexed by the
6142
Learn Astropy website, please see the [Contributing

binder/requirements.txt

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
astropy
2+
astroquery>=0.4.8.dev9474 # 2024-09-24 pinned for Gaia column capitalization issue
3+
dask
4+
dust_extinction
5+
gala
6+
IPython
7+
matplotlib
8+
numpy
9+
pillow
10+
pvextractor
11+
radio_beam
12+
reproject
13+
scipy
14+
spectral_cube @ git+https://github.com/radio-astro-tools/spectral-cube # as of: 2024-10-10 for issue with 'distutils'
15+
synphot

0 commit comments

Comments
 (0)