Add citation file

[tbhallett]

Adding file CITATION.CFF to root of repo as per https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files

[tbhallett]

@joehcollins -- this is the citation file that I'm adding the repo. Please could you review and approve the PR? Once we have this is, we can make the repo public.

[joehcollins]

Sorry tim just saw this - having a look now!

[joehcollins]

Looks like checks are failing as "lists of files in version control and sdist do not match!"

[tbhallett]

Looks like checks are failing as "lists of files in version control and sdist do not match!"

I don't really know what I'm doing here. But, I've made another change to the MANIFEST.in file. If it doesn't work, then I'll ask for some help.

[matt-graham]

Looks good other than a few small bits. @tbhallett if you are happy for me to do so, I'll enable the Zenodo GitHub integration for the repository once it's been made public but before we create the 1.0.0 release as then we'll automatically get a DOI created for each new release (and also have the source code separately archived on Zenodo which is good from a long term availability perspective).

Unfortunately there is a bit of a chicken and egg situation with Zenodo / GitHub that we can't get a DOI until we create a release if using the automatic integration, so we can't include the DOI in the citation file until after we have tagged the release but that is a very minor issue!

[tbhallett]

Looks good other than a few small bits. @tbhallett if you are happy for me to do so, I'll enable the Zenodo GitHub integration for the repository once it's been made public but before we create the 1.0.0 release as then we'll automatically get a DOI created for each new release (and also have the source code separately archived on Zenodo which is good from a long term availability perspective).

Unfortunately there is a bit of a chicken and egg situation with Zenodo / GitHub that we can't get a DOI until we create a release if using the automatic integration, so we can't include the DOI in the citation file until after we have tagged the release but that is a very minor issue!

Thanks. So, this is the order of business (to check I understand)

1. I'll finish this PR
2. You review and merge it when you're happy it.
3. I'll make it public
4. You enable the integration with Zenodo
5. ...... WAIT WHILE WE FINALISE THE LAST PRs ......
6. Make the release version 1?

[matt-graham]

Thanks. So, this is the order of business (to check I understand)

1. I'll finish this PR
2. You review and merge it when you're happy it.
3. I'll make it public
4. You enable the integration with Zenodo
5. ...... WAIT WHILE WE FINALISE THE LAST PRs ......
6. Make the release version 1?

Yep that sounds all correct to me

[matt-graham]

A few more minor comments, but other than potential issue with MANIFEST which might cause check to fail, none of these are vital.