trying to bring my material up-to-date with astropy-tutorials main

.circleci/config.yml

@@ -13,9 +13,10 @@ pip-run: &pip-install
   command: |
     python3 -m venv venv
     . venv/bin/activate
-    pip install -r pip-requirements.txt  --progress-bar off
-    pip install --progress-bar off sphinx pytest
-    pip install --progress-bar off sphinx-astropy sphinx-bootstrap-theme nbconvert==5.6.1
+    python3 -m pip install --upgrade pip wheel
+    python3 -m pip install -r pip-requirements.txt  --progress-bar off
+    python3 -m pip install --progress-bar off "sphinx>=2.0,<3.0" pytest
+    python3 -m pip install --progress-bar off sphinx-astropy sphinx-bootstrap-theme nbconvert==5.6.1
 
 jobs:
 

CONTRIBUTING.rst

@@ -6,7 +6,7 @@ Overview
 
 Each tutorial is a `Jupyter notebook <http://jupyter.org/>`_ file. Each notebook is saved in a separate directory within the ``tutorials/notebooks``
 subdirectory in this project. For an example, let's look at the source notebook
-of the `FITS-header <https://github.com/astropy/astropy-tutorials/tree/master/tu
+of the `FITS-header <https://github.com/astropy/astropy-tutorials/tree/main/tu
 torials/notebooks/FITS-header/>`_ tutorial. Within
 ``tutorials/notebooks/FITS-header``, there is a single Jupyter notebook file
 that contains the text and code for the tutorial, and any small data files used
@@ -188,7 +188,7 @@ your ``requirements.txt`` file would look like:
     numpy>=1.13
 
 To see an example, have a look at the FITS-header `requirements.txt file <https:
-//github.com/astropy/astropy-tutorials/blob/master/tutorials/notebooks/FITS-head
+//github.com/astropy/astropy-tutorials/blob/main/tutorials/notebooks/FITS-head
 er/requirements.txt>`_.
 
 Push the notebook and other files from your local branch up to your fork of the
@@ -211,7 +211,10 @@ If your tutorial includes large data files (where large means >~ 1 MB), we don't
 want to include them in the ``astropy/astropy-tutorials`` git repository, as
 that will drastically slow down cloning the repository. Instead, we encourage
 use of the `astropy.utils.download_files` function, and will host data files on
-the `<http://data.astropy.org>`_ server. To do this, use the following
+the `<http://data.astropy.org>`_ server by opening a PR at the
+`<https://github.com/astropy/astropy-data>`_ repository, or to use Zenodo to host the data files
+if the file concerned is larger than 10 MB.
+To do the former, use the following
 procedure:
 
 * When writing your tutorial, include the files in your tutorial's directory
@@ -241,10 +244,28 @@ procedure:
 
   If you do this, the only change necessary when merging your notebook will be to set ``tutorialpath`` to  ``'http://data.astropy.org/tutorials/My-tutorial-name/'``.
 
+For larger data files that are bigger than 10 MB in size, we recommend hosting with Zenodo.
+To use this approach, follow these steps:
+
+* You will need to sign up for an account with Zenodo before you can upload a file there.
+
+* After a Zenodo account has been properly set up, be sure to log in and do a new upload. Follow
+the Zenodo instructions and complete all the required fields as the bare minimum in order to have
+the data file(s) uploaded to their records. Once this is done you will have a link to share the data.
+
+* With the link to the data file record, which has the format ``https://zenodo.org/api/records/:id``, an example HTTP GET request needed to retrieve the data using the Python package ``requests`` is shown below::
+
+    import requests
+    r = requests.get("https://zenodo.org/api/records/1234)
+
+To use the output as a locally stored file, you would first need to write the file contents to a file, for example::
+
+    with open('./some-data-file.fits', 'wb') as f:
+        f.write(r.content)
+
 If you need information or help with:
 
-* previewing how the rendered Jupyter notebooks will look on the tutorial
-  webpage
+* previewing how the rendered Jupyter notebooks will look on the tutorial webpage
 * marking a cell with an intentional / expected error
 
 please see the :ref:`dev-page`.

README.rst

@@ -22,7 +22,7 @@ You can also get started quickly using `Binder <http://mybinder.org>`_ to run th
 your web browser within a remote server:
 
 .. image:: http://mybinder.org/badge.svg
-    :target: https://mybinder.org/v2/gh/astropy/astropy-tutorials/master?filepath=tutorials/notebooks
+    :target: https://mybinder.org/v2/gh/astropy/astropy-tutorials/main?filepath=tutorials/notebooks
 
 
 Contributing tutorial material

pip-requirements.txt

@@ -1,13 +1,14 @@
 IPython>=6.1
-astropy>=3
-astroquery>=0.3.7
+astropy>=4
+git+https://github.com/astropy/astroquery.git
 matplotlib==3.0.2
-numpy>=1.15
+numpy>=1.17
 jupyter>=1.0
 scipy>=1.0
 notebook>=5.7.2
 aplpy
-spectral-cube
+git+https://github.com/radio-astro-tools/spectral-cube.git#egg=spectral-cube
+git+https://github.com/radio-astro-tools/radio-beam.git#egg=radio-beam
 reproject==0.5.1
 dust_extinction>=0.7
 astro-gala

scripts/tests/test_convert.py

@@ -10,7 +10,7 @@
 tests_path = path.split(path.abspath(__file__))[0]
 
 def test_convert_succeed():
-    # With the current master version of nbconvert, we can allow errors
+    # With the current main version of nbconvert, we can allow errors
     # per-cell. This notebook, even though it raises an exception, should still
     # execute fine:
     nbc = NBConverter(path.join(tests_path, 'test-succeed.ipynb'))

tutorials/astropy.tpl

@@ -8,7 +8,7 @@
 .. raw:: html
 
     <a href="../_static/{{ nb_name }}/{{ nb_name }}.ipynb"><button id="download">Download tutorial notebook</button></a>
-    <a href="https://beta.mybinder.org/v2/gh/astropy/astropy-tutorials/master?filepath=/tutorials/notebooks/{{ nb_name }}/{{ nb_name }}.ipynb"><button id="binder">Interactive tutorial notebook</button></a>
+    <a href="https://beta.mybinder.org/v2/gh/astropy/astropy-tutorials/main?filepath=/tutorials/notebooks/{{ nb_name }}/{{ nb_name }}.ipynb"><button id="binder">Interactive tutorial notebook</button></a>
 
     <div id="spacer"></div>
 
@@ -31,7 +31,7 @@
     <div id="spacer"></div>
 
     <a href="../_static/{{ nb_name }}/{{ nb_name }}.ipynb"><button id="download">Download tutorial notebook</button></a>
-    <a href="https://beta.mybinder.org/v2/gh/astropy/astropy-tutorials/master?filepath=/tutorials/notebooks/{{ nb_name }}/{{ nb_name }}.ipynb"><button id="binder">Interactive tutorial notebook</button></a>
+    <a href="https://beta.mybinder.org/v2/gh/astropy/astropy-tutorials/main?filepath=/tutorials/notebooks/{{ nb_name }}/{{ nb_name }}.ipynb"><button id="binder">Interactive tutorial notebook</button></a>
 
 {% endblock %}
 

tutorials/dev.rst

@@ -8,7 +8,7 @@ Documentation on tutorials infrastructure
 Overview
 --------
 
-Tutorials are written as Jupyter notebooks on the ``master`` branch of the
+Tutorials are written as Jupyter notebooks on the ``main`` branch of the
 ``astropy/astropy-tutorials`` repository in ``tutorials/notebooks/``. These
 notebook files do not contain output in order to simplify version-controlling
 the files.
@@ -18,15 +18,11 @@ to look like the main documentation. Sphinx requires restructured text (RST)
 files for its build process, so use an intermediate step to run the notebooks to
 produce output, and then convert the notebook files into RST files.
 
-We use our own run-and-convert machinery using ``nbconvert``. We use the same
-script that converts the notebooks to RST to test the notebooks on travis by
-simply executing the notebooks and ignoring the output.
-
 We use `CircleCI <https://circleci.com>`_ to do the Sphinx build, which is then
 pushed to the ``gh-pages`` branch of the repository and served by GitHub. The
 notebooks are first converted to RST files during the Sphinx build by doing the
 conversion at the end of the `Sphinx configuration file
-<https://github.com/astropy/astropy-tutorials/blob/master/tutorials/conf.py>`_.
+<https://github.com/astropy/astropy-tutorials/blob/main/tutorials/conf.py>`_.
 
 Why not use nbsphinx?
 ---------------------
@@ -77,7 +73,7 @@ Building the tutorials page locally
 -----------------------------------
 
 For this, you can use the `Makefile
-<https://github.com/astropy/astropy-tutorials/blob/master/Makefile>`_ at the
+<https://github.com/astropy/astropy-tutorials/blob/main/Makefile>`_ at the
 top-level of the tutorials repository. From the root level of the cloned or
 downloaded repository::
 
@@ -135,7 +131,7 @@ Marking a cell with an intentional error
 
 Edit the cell metadata of the cell in which you would like to raise an exception
 and add the following to the top-level JSON: ``"tags": ["raises-exception"]``
-This tag is recognized by the latest (master) version of nbconvert.
+This tag is recognized by the latest (main) version of nbconvert.
 
 Automatically Strip Output and Notebook Metadata
 ------------------------------------------------