Skip to content

Update contributing doc to add uploading data files to Zenodo info #455

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
eblur merged 2 commits into from
Sep 2, 2020
Merged

Update contributing doc to add uploading data files to Zenodo info #455

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
387ecde
Update contributing doc to add uploading data files to Zenodo info
Jul 22, 2020
195ad6a
Apply suggestions from code review
Sep 2, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 24 additions & 3 deletions CONTRIBUTING.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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`.
Expand Down
3 changes: 2 additions & 1 deletion pip-requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@ 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
Expand Down