Skip to content

Add CITATION.cff#74

Merged
yantosca merged 3 commits intoKineticPreProcessor:mainfrom
zmoon:cff
Mar 21, 2023
Merged

Add CITATION.cff#74
yantosca merged 3 commits intoKineticPreProcessor:mainfrom
zmoon:cff

Conversation

@zmoon
Copy link
Copy Markdown
Contributor

@zmoon zmoon commented Mar 16, 2023

This enables the "Cite this repository" button on GitHub. With the current data, it generates this citation:

Lin, H., Long, M. S., Sander, R., Sandu, A., Yantosca, R. M., Estrada, L., Shen, L., & Jacob, D. J. (2023). An adaptive auto-reduction solver for speeding up integration of chemical kinetics in atmospheric chemistry models: implementation and evaluation within the Kinetic Pre-Processor (KPP) version 3.0.0. JAMES, 15(2). https://doi.org/10.1029/2022MS003293

zmoon added 3 commits March 16, 2023 15:15
I used the online CFF creation tool, following the info
on the RTD site, then added the paper citation
note: could use the auto-latest one here too
10.5281/zenodo.6828025
@jimmielin
Copy link
Copy Markdown
Member

Hi @zmoon, thanks for letting us know about this feature! It's the first time I've seen it.

I checked your fork at https://github.com/zmoon/KPP/tree/cff and looks like it will function correctly. @RolfSander, @yantosca, may I ask your opinion about merging this? Thanks!

@RolfSander
Copy link
Copy Markdown
Contributor

I didn't know this cff format until now. It looks like a nice feature.

Copy link
Copy Markdown
Contributor

@yantosca yantosca left a comment

Choose a reason for hiding this comment

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

This looks good to merge. I would pull it into the dev branch first and then issue a new release KPP 3.0.1.

@yantosca yantosca self-assigned this Mar 21, 2023
@yantosca yantosca added the documentation Improvements or additions to documentation label Mar 21, 2023
@yantosca yantosca modified the milestones: 3.0.0, 3.0.1 Mar 21, 2023
yantosca added a commit that referenced this pull request Mar 21, 2023
This release contains the following updates since KPP 3.0.0

1. PR #67 (change arrays from static allocation to dynamic)
2. PR #74 (Add CITATION.cff to activate "Cite this Repository" on GitHub)
3. Minor updates for ReadTheDocs

Signed-off-by: Bob Yantosca <[email protected]>
@yantosca yantosca merged commit 3e25e88 into KineticPreProcessor:main Mar 21, 2023
@zmoon zmoon deleted the cff branch March 21, 2023 16:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants