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

Better support citation of cookbooks #15

Closed
clyne opened this issue Jun 28, 2022 · 6 comments
Closed

Better support citation of cookbooks #15

clyne opened this issue Jun 28, 2022 · 6 comments
Assignees
Labels
infrastructure Infrastructure related issue

Comments

@clyne
Copy link
Contributor

clyne commented Jun 28, 2022

Per the discussion started by @brian-rose there are a few things we might do to facilitate citation and giving credit to authors of cookbooks. Some things we might consider:

  1. Add an author(s) field to the template
  2. Display authors in the gallery "cards"
  3. Facilitate (provide guidance) on optionally creating a DOI for the notebook and display the DOI in cards and template.
@brian-rose
Copy link
Member

I will open a PR to add the author field to the template.

@brian-rose
Copy link
Member

I see that the EarthCube peer-reviewed notebooks use Zenodo to mint DOIs. I've done this for other projects, and it's pretty straightforward to set it up so that a unique DOI is generated for each tagged release of a source repository on GitHub.

This is probably the way to go with Cookbooks too. When a Cookbook is "accepted" following review, a tagged Release can be created for the GitHub repo. This will then trigger the minting of a DOI (and archiving of the tagged version of the repo on Zenodo's archive for posterity). Cookbook authors can decide whether recent revisions to their repo are sufficient to warrant minting a new GitHub release and thus an updated DOI. And users of the Cookbook can easily cite it in their own work using the DOI. This is all pretty straightforward.

On the other hand, it's always struck me as slightly perverse to use this method (citing the code repository) as a stand-in for citing the scientific content. The reason is that the source repository contains all kinds of code and infrastructure for building the book, in addition to the actual content of the book.

In a perfect world, there would be a simple way to cite the rendered book as it appears on https://cookbooks.projectpythia.org (but with a stable-for-all-time citation), and also but seperately a way to cite the infrastructure that builds the book.

I'm probably over-thinking this though.

@brian-rose
Copy link
Member

While I'm on this subject, I should say that all the same thing applies to Foundations. We really ought to set up a DOI for the Foundations repo so that it is citable too. I'll open that issue now.

@clyne
Copy link
Contributor Author

clyne commented Jul 11, 2022

I think automating DOI minting would be another incentive for folks to contribute to our gallery as opposed to putting it up on their own site somewhere. This is another value add that our infrastructure can provide.

@brian-rose
Copy link
Member

Elevating this to high priority so we can get something done on this prior to the summer 2023 hackathon.

We can "practice" the DOI minting mechanism on Foundations: ProjectPythia/pythia-foundations#309, ProjectPythia/pythia-foundations#344

@jukent
Copy link
Contributor

jukent commented May 2, 2023

Will work on this once we've agreed on the citation method for foundations.

@jukent jukent closed this as completed Aug 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
infrastructure Infrastructure related issue
Projects
Status: Done
Development

No branches or pull requests

3 participants