Skip to content
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

Jump to bottom

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

Merged
merged 2 commits into from
Sep 2, 2020
Merged

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

merged 2 commits into from
Sep 2, 2020

Conversation

kakirastern
Copy link
Contributor

Fixes #454.

Add info to the CONTRIBUTING.rst file to add info regarding how to use Zenodo to host large data files plus code snippets that may be needed for this approach to supplement the existing large data file uploading mechanism with http://www.astropy.org/astropy-data/ or http://data.astropy.org.

@kakirastern
Copy link
Contributor Author

kakirastern commented Jul 22, 2020 •
edited
Loading

Build is failing now because of some pip dependency issues. Will wait until perhaps PR #453 is merged then rebase before the issues are resolved.

eblur
eblur reviewed Jul 29, 2020
View reviewed changes
CONTRIBUTING.rst Outdated Show resolved Hide resolved
@eblur
Copy link
Contributor

eblur commented Jul 29, 2020

It was decided during our Learn Astropy meeting today that Zenodo should be the primary recommended method. So please reverse the order. I have suggested word changes in the lead up to those instructions in individual comments to the document.

eblur
eblur reviewed Jul 29, 2020
View reviewed changes
CONTRIBUTING.rst Outdated Show resolved Hide resolved
eblur
eblur reviewed Jul 29, 2020
View reviewed changes
CONTRIBUTING.rst Outdated Show resolved Hide resolved
eblur
eblur reviewed Jul 29, 2020
View reviewed changes
CONTRIBUTING.rst Outdated Show resolved Hide resolved
eblur
eblur reviewed Jul 29, 2020
View reviewed changes
CONTRIBUTING.rst Outdated Show resolved Hide resolved
@kakirastern
Copy link
Contributor Author

Since @stargaser proposed changing from using requests to download_file from astropy.utils.data in #453, I think I better wait a bit until this issue has been settled / some consensus has been reached regarding this decision before continuing on.

@kakirastern
Copy link
Contributor Author

Latest consensus is that only data files of sizes > 10 MB should be allowed to be archived/stored/hosted on Zenodo. So Zenodo will be the last resort for the time being as opposed to the default means of storing larger data files. I have updated the PR to reflect this latest development.

@kakirastern kakirastern requested review from eblur and adrn August 12, 2020 15:01
@kakirastern
Copy link
Contributor Author

Will need some discussions on this PR on the next telecon on how to proceed, now that @eteq has confirmed that we would still want data files less than 10 MB to be hosted on astropy/astropy-data via GitHub, until the limit of that service has been reached at least. Large data files > 10 MB we would want to be hosted on Zenodo, however. If I have made any mistake here please correct me.

adrn
adrn reviewed Sep 2, 2020
View reviewed changes
Copy link
Member

@adrn adrn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few minor suggestions to wording

CONTRIBUTING.rst Outdated Show resolved Hide resolved
CONTRIBUTING.rst Outdated Show resolved Hide resolved
CONTRIBUTING.rst Outdated Show resolved Hide resolved
@adrn
Apply suggestions from code review
195ad6a 
Co-authored-by: Adrian Price-Whelan <adrianmpw@gmail.com>
@kakirastern kakirastern requested a review from adrn September 2, 2020 15:04
@kakirastern
Copy link
Contributor Author

@adrn I have just committed the changes you have suggested

adrn
adrn approved these changes Sep 2, 2020
View reviewed changes
Copy link
Member

@adrn adrn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks Kris!

@eblur Do you want to have a look at this? Feel free to merge if you are happy

@eblur
Copy link
Contributor

eblur commented Sep 2, 2020

If you're happy, I'm happy. Merging!

@eblur eblur merged commit 21968ff into astropy:master Sep 2, 2020
@kakirastern
Copy link
Contributor Author

Thanks @adrn and @eblur!

@kakirastern kakirastern deleted the update-contributing-doc-for-data-files branch September 2, 2020 15:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@adrn adrn adrn approved these changes

@eblur eblur Awaiting requested review from eblur

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Update Learn Astropy contributing docs with instructions for hosting on Zenodo
3 participants
@kakirastern @eblur @adrn