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

Add CITATION.cff file #749

Closed
durack1 opened this issue Jul 4, 2024 · 10 comments
Closed

Add CITATION.cff file #749

durack1 opened this issue Jul 4, 2024 · 10 comments
Assignees
Milestone

Comments

@durack1
Copy link
Contributor

durack1 commented Jul 4, 2024

See example at https://github.com/WCRP-CMIP/CMIP6_CVs/blob/main/CITATION.cff

@taylor13 @mauzey1 I will add this to my to-do in preparation for the CMOR 3.9.0 release

@durack1 durack1 self-assigned this Jul 4, 2024
@durack1 durack1 added this to the 3.9.0 milestone Jul 4, 2024
@taylor13
Copy link
Collaborator

taylor13 commented Jul 4, 2024

If this is CMOR software, we should decide who should be included.

@durack1
Copy link
Contributor Author

durack1 commented Jul 4, 2024

Exactly, this template can be the definitive "authorship" list which I am assuming is picked up by Zenodo as the DOI is issued. So can cover all contributions CMOR1 through 3

@durack1
Copy link
Contributor Author

durack1 commented Jul 8, 2024

Update the CMOR User Guide - https://cmor.llnl.gov/pdf/mydoc.pdf, as this requires a bit of attention, including listing authors, like is visible in the CMOR1 (here) and CMOR2 (here) documentation

@mauzey1
Copy link
Collaborator

mauzey1 commented Jul 17, 2024

@durack1 So the content of this CITATION.cff should mostly be the same info we have in .zenodo.json?

@durack1
Copy link
Contributor Author

durack1 commented Jul 17, 2024

Sorry @mauzey1 I hadn't made the comments above clear enough. My understanding is that if a CITATION.cff file exists, then Zenodo will pick this up and run with it - so it will overwrite existing settings in zenodo, I think.

@taylor13 is in today, and we wanted to work through this and the CMOR documentation CITATION.cff to make sure that all parties are listed, and the author order makes sense - will submit a PR with recommendations, hopefully later today

@durack1
Copy link
Contributor Author

durack1 commented Jul 22, 2024

@durack1
Copy link
Contributor Author

durack1 commented Aug 15, 2024

@mauzey1 @taylor13 is on vacation until next week, so I will circle and get this into a PR for you next week, apologies for the delay

@durack1
Copy link
Contributor Author

durack1 commented Aug 19, 2024

@mauzey1 we'll also need to update the PDF documentation, which currently is missing the author list - see the CMOR1 documentation (here) and CMOR2 documentation (here).

The order for the CMOR3 documentation should be:
Doutriaux, Charles, Karl E. Taylor, Chris Mauzey, Denis Nadeau, Paul J. Durack - see PCMDI/cmor3_documentation#137

@taylor13 let me know if I have missed anything obvious

@durack1
Copy link
Contributor Author

durack1 commented Aug 21, 2024

@mauzey1 just noting before this issue is closed, we'll need to tweak the 2024-08-xx in both the CITATION.cff and .zenodo.json before 3.9.0 is tagged

@durack1 durack1 mentioned this issue Aug 28, 2024
17 tasks
@mauzey1
Copy link
Collaborator

mauzey1 commented Aug 29, 2024

The publication dates were updated in both files before the 3.9.0 release.

@mauzey1 mauzey1 closed this as completed Aug 29, 2024
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

No branches or pull requests

3 participants