Added citation metadata file

[MicahGale]

Description

This adds CITATION.cff to the repo. This is a yaml file specified by: https://citation-file-format.github.io/. The advantage of having this is that things like Github, Zenodo, and Zotero can cite the repo more easily. For this I took the CFF file created by Zenodo, and added the preferred citation article as well to the file.

For an example of it working see the right hand side of the GH with this branch

Fixes #3408

Checklist

• I have performed a self-review of my own code
• I have run clang-format (version 15) on any C++ source files (if applicable)
• I have followed the style guidelines for Python source files (if applicable)
• I have made corresponding changes to the documentation (if applicable)
• I have added tests that prove my fix is effective or that my feature works (if applicable)

[shimwell]

I generally like the citation files and have a few on my own repos.

We also went to great lengths to find the names and orcid numbers for all the DAGMC contributors and made this nice citation file https://github.com/svalinn/DAGMC/blob/develop/CITATION.cff . DAGMC if fairly stable these days and the contributor list doesn't change much.

Adding a citation file does introduce a bit of a maintenance overhead as new contributors are constantly joining and the order of contributors is also changing. Something I've considered in the past is to make a github action that updates a citation file automatically with each version release. It could order the contributors at that point in time and update the version tag in the citation file. However I realize that is also quite a lot of work.

Perhaps a short term solution that would be easy to add would be just to have the paper in the citation file. Then in a follow up PR as citation files support multiple entries we could look for ways to add the full contributor list without introducing a maintenance burden.

What do you think @MicahGale is it worth reducing this citation file to just the paper for now and coming back to it in the future with regards to the full contributor list?

[MicahGale]

I agree let's just do the paper. It seems to work with the GH citation system, as well Zotero, so I think that covers all worthwhile use cases.

Long-term automation: I know Zenodo extracts/ asks for a lot of the contribution data as part of the release process, and creates a citation.cff. Probably could make an automation to pull that file after every release and make a PR for updating the file?

[shimwell]

Re: Zenodo, I see it does contain a lot of information,, looks like a good idea to me

Thanks for the changes,

I can see the cite this repo button appears on your branch

If there are no objects I can merge this in tomorrow