E3SM-Project / zppy

E3SM post-processing toolchain
BSD 3-Clause "New" or "Revised" License
6 stars 15 forks source link

Make Zppy citable with Zenodo #606

Closed chengzhuzhang closed 3 months ago

chengzhuzhang commented 5 months ago

Request criteria

Issue description

I think we should consider use the data archiving tool Zenodo and get a DOI for zpp so it can be cited in papers.https://docs.github.com/en/repositories/archiving-a-github-repository/referencing-and-citing-content

forsyth2 commented 5 months ago

Thanks @chengzhuzhang. I suppose we should do this for zstash too.

forsyth2 commented 5 months ago

Does this apply DOIs to previous releases or would it only be going forward?

chengzhuzhang commented 5 months ago

I think new DOIs will be issued each time a new GitHub release is made, I guess we don't need to worry about previous releases in this case.

Good to have DOIs for both zstash and zppy since we don't have a way to cite at this point.

forsyth2 commented 3 months ago

@chengzhuzhang I just followed the directions at https://docs.github.com/en/repositories/archiving-a-github-repository/referencing-and-citing-content

Before toggling zppy on

Screenshot 2024-08-02 at 12 29 09 PM

Notice zstash apparently already has a DOI. However, it's not showing up on the repo's README: https://github.com/E3SM-Project/zstash. https://gist.github.com/seignovert/ae6771f400ca464d294261f42900823a shows how to add it there.

After toggling zppy on

I ran the "To the right of the name of the repository you want to archive, toggle the button to On." step and got: Screenshot 2024-08-02 at 12 30 25 PM I guess once we make the next zppy release, we'll see if this worked for real.

chengzhuzhang commented 3 months ago

@forsyth2 thank you!

forsyth2 commented 3 months ago

https://github.com/E3SM-Project/zstash/pull/342 adds the DOI badge to zstash.