Add CITATION.cff file

[matt-graham]

Part of #330

Adds a CITATION.cff file for this repository with all current contributors included as authors.
The ordering of authors should match the non-bot accounts on https://github.com/UCL-ARC/python-tooling/graphs/contributors

I have added ORCIDs for everyone I could find them for either from GitHub profile or ARC people directory. Similarly I have tried to enter given and family names as listed on GitHub Profile or ARC people directory but add a review comment if I've made any mistakes or you would prefer to be listed differently.

I am requesting a review from everyone who is listed as an author. If you are happy to be included as an author and don't want any changes made to your information please approve. If you need any changes made to your information or want to be removed as an author please add a review and request changes accordingly.

As I ran out of reviewer slots (maximum of 15 😅) I'm manually tagging @paddyroddy and @samcunliffe

[matt-graham]

@sfmig @adamltyson @alessandrofelder I've listed everyones' affiliation as UCL but let me know if you would prefer I change this to Sainsbury Wellcome Centre

[matt-graham]

At the moment this asks people to use this citation for both template and website. In #330 we discussed possibly making website separately citeable so we may want to change this.

[paddyroddy]

If we do then we could use the preferred-citation syntax https://github.com/astro-informatics/sleplet/blob/e3dec589a7f9803100c9aff6bdefa7ef76a6aa52/CITATION.cff#L10

[paddyroddy]

🫐

[alessandrofelder]

@sfmig @adamltyson @alessandrofelder I've listed everyones' affiliation as UCL but let me know if you would prefer I change this to Sainsbury Wellcome Centre

Given we also don't specify ARC/Mech Eng/... the UCL affiliation seems reasonable to me.

[p-j-smith]

As I ran out of reviewer slots (maximum of 15 😅) I'm manually tagging @paddyroddy and @samcunliffe

Perhaps we should make a python-tooling Team?

[paddyroddy]

Perhaps we should make a python-tooling Team?

Nice idea, but in this case @matt-graham wants everyone to review it. As soon as one of the team reviewed, the team wouldn't be visible any more.

[p-j-smith]

Nice idea, but in this case @matt-graham wants everyone to review it. As soon as one of the team reviewed, the team wouldn't be visible any more.

Ah yeah, that's a good point. But at least everyone would be notified that they've been requested to review

[paddyroddy]

@robertvi @mxochicale @yidilozdemir could you have a look? When @dpshelio gets back, we should be good to go - I'll prod him in person if he hasn't done it

[mxochicale]

Hi Matt and all.

This looks good to me.

Perhaps for next iterations:

• try to add some version release and associated doi. From this reference:

version: 2.0.4
doi: 10.5281/zenodo.1234
date-released: 2017-12-18

• Some family-names and give names have quotes. Not sure how this affects the creation of the citation but I guess it should be some kind of consistency.

Thanks, Miguel

[matt-graham]

Thanks for the comments @mxochicale

* try to add some version release and associated doi. From this [reference](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files):

version: 2.0.4
doi: 10.5281/zenodo.1234
date-released: 2017-12-18

We have the Zenodo GitHub integration set up already so can add a DOI once we have made a release and a DOI has been minted. In terms of including a version - I would be reticent to have this included unless we had some automated workflow for ensuring this kept up to date with the latest release version as I suspect otherwise it will quickly end up going out of sync.

* Some family-names and give names have quotes. Not sure how this affects the creation of the citation but I guess it should be some kind of consistency.

I created the CFF file initially with cffinit tool (https://citation-file-format.github.io/cff-initializer-javascript/#/) - it looks like the quotes have been added to names with spaces or non-ASCII characters / characters with accents. We could potentially normalize everything to have quotation marks.

[paddyroddy]

We have the Zenodo GitHub integration set up already so can add a DOI once we have made a release and a DOI has been minted. In terms of including a version - I would be reticent to have this included unless we had some automated workflow for ensuring this kept up to date with the latest release version as I suspect otherwise it will quickly end up going out of sync.

When it comes to the Zenodo release, you get a generic DOI (that refers to the whole record) and one for each new version. IMO it's much easier to stick with the generic one, and then you don't need to change anything.

[matt-graham]

When it comes to the Zenodo release, you get a generic DOI (that refers to the whole record) and one for each new version. IMO it's much easier to stick with the generic one, and then you don't need to change anything.

Yeah I also usually use the non-version-specific DOI - I was referring above to the suggestion to include a version (and release date) in the CITATION.cff itself which is possible but then requires us to keep this up to date with the latest release (and if we're using the non-version specific DOI probably doesn't make sense anyway).