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.

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

initial citation and changelog #155

Merged
merged 5 commits into from
Sep 7, 2021
Merged

Conversation

scottyhq
Copy link
Member

@scottyhq scottyhq commented Sep 2, 2021

Addresses #15 and #151 to add GitHub Citation.cff. More detail on the fields you can have in citation.cff are here https://github.com/citation-file-format/citation-file-format/blob/main/schema-guide.md

After merging this we'll create a release linked to a zenodo DOI and then add the DOI to citation.cff

This does not address the tutorial data reproducibility discussed in #151, but at least will give us a citation for the jupyterbook website.

authors:
- family-names: Henderson
given-names: Scott
orcid: "https://orcid.org/0000-0003-0624-4965"
Copy link
Member Author

Choose a reason for hiding this comment

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

I did my best to find everyone on the 'team' page https://snowex-hackweek.github.io/website/team.html by name and affiliation on https://orcid.org, but some are missing.

identifiers:
- description: "collection of archived snapshots of all versions"
type: doi
value: TODO
Copy link
Member Author

Choose a reason for hiding this comment

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

will fill this in after creating a release, planning to use calendar naming scheme (so 2021.07.23, 2021.09.01, etc. for updated versions)

@@ -0,0 +1,124 @@
cff-version: 1.2.0
message: "If you use this book, please cite it as below."
title: "SnowEx Hackweek JupyterBook Tutorials"
Copy link
Member Author

Choose a reason for hiding this comment

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

note this is a single citation for the entire book/website, rather than broken down per tutorial.

@scottyhq
Copy link
Member Author

scottyhq commented Sep 2, 2021

Using pip install git+https://github.com/citation-file-format/cff-converter-python.git cffconvert -f apalike (what will show up on the GitHub repo landing page the citation looks like this):

Henderson S., Arendt A., Meyer J., Setiawan L., Marshall H., Johnson M., Mason M., Lundquist J., Pestana S., Shean D., Durand M., Wrzesien M., McAndrew B., Ofekeze E., Alabi I., Tarricone J., Meehan T., Webb R., McGrath D., Boyd D., Osmanoglu B., Hudson D., Breen K., Lumbrazo C., Webster C., Smith B., Scheick J., Vuyovich C., Steiker A., Haley C., Koh J. (2021). SnowEx Hackweek JupyterBook Tutorials (version 2021.07.23). doi: TODO.

@scottyhq scottyhq merged commit cb52f07 into snowex-hackweek:main Sep 7, 2021
@scottyhq scottyhq deleted the changelog branch September 7, 2021 18:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants