Add paper citation to docs #259
Conversation
Codecov Report
@@ Coverage Diff @@
## master #259 +/- ##
=======================================
Coverage 96.98% 96.98%
=======================================
Files 26 26
Lines 3551 3551
Branches 632 632
=======================================
Hits 3444 3444
Misses 64 64
Partials 43 43 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
|
Maybe the best place to put it in the CITATION.cff is as I don't think it hurts to include it in the docs as well; then we have one human-friendly request and one machine-friendly! |
rebeccafair
force-pushed
the
add_citation
branch
from
7642c6c
to
ce798b7
Compare
|
Ah good point, I didn't know about The paper won't show up on the DOI landing page (https://doi.org/10.5286/SOFTWARE/EUPHONIC) unless I make some changes, but I think that's fine as its just the landing page for the software? |
|
That's ok with me |
commit 282cfa2 Author: Rebecca Fair <rebecca.fair@stfc.ac.uk> Date: Thu Jan 12 11:54:50 2023 +0000 258 conda min (#260) * Test Conda on lest-than-latest Numpy version * Just test one environment * Fix workflow syntax * Don't run regular tests * Install Numpy 1.20 * Install Numpy in commands_pre * Install Numpy 1.20 * Change env name * Ensure build is ok with Numpy 1.21 * Revert to Numpy 1.20 * Revert workflow files commit cbf55bd Author: Rebecca Fair <rebecca.fair@stfc.ac.uk> Date: Tue Jan 10 08:29:36 2023 +0000 Add paper citation to docs (#259) * Add citation to docs * Add preferred-citation to CITATION.cff * Update cite.rst commit 47f6a8f Author: Rebecca Fair <rebecca.fair@stfc.ac.uk> Date: Thu Dec 1 13:28:16 2022 +0000 Update add-and-commit version Due to NodeJS 12 deprecation commit 44abb7c Author: Rebecca Fair <rebecca.fair@stfc.ac.uk> Date: Tue Nov 22 11:03:27 2022 +0000 Update actions versions (Node.js 12 deprecation) (#252) * Update actions versions (Node.js 12 deprecation) Currently am getting the following warning on Github Actions runners: Node.js 12 actions are deprecated. For more information see: https://github.blog/changelog/2022-09-22-github-actions-all-actions-will-begin-running-on-node16-instead-of-node12/. Please update the following actions to use Node.js 16: conda-incubator/setup-miniconda, actions/upload-artifact, codecov/codecov-action, conda-incubator/setup-miniconda * Update publish unit test results * Update deprecated 'files' in publish-unit-test-result-action commit b6c94ca Author: Rebecca Fair <rebecca.fair@stfc.ac.uk> Date: Thu Nov 10 11:26:23 2022 +0000 Updates for v1.1.0 release
I wasn't sure what citation style to use for this, so I've just made sure all the information is there.
Alternatively, rather than adding to the citation docs page, we could update the CITATION.cff file so instead of having an overall DOI, we have multiple
identifiers, one for the software itself, and one for the paper, as done here: https://github.com/citation-file-format/citation-file-format/blob/main/README.md#structure. Although that might need a bit more work as that would mean the citation file has a different format and https://github.com/pace-neutrons/Euphonic/tree/gh-pages may need updating.