From 7f74c02d3d3c3ec0b73a53e7a0739ca198fc67eb Mon Sep 17 00:00:00 2001 From: Matthew Feickert <matthew.feickert@cern.ch> Date: Mon, 17 Jun 2024 00:40:02 -0500 Subject: [PATCH] docs: Add CITATION.cff Citation File Format file * Add Citation File Format file to repo to get repository cite button on GitHub - c.f. https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/about-citation-files * Add CITATION.cff to bump2version control --- .bumpversion.cfg | 2 ++ CITATION.cff | 45 +++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 47 insertions(+) create mode 100644 CITATION.cff diff --git a/.bumpversion.cfg b/.bumpversion.cfg index 268d2bb..aade313 100644 --- a/.bumpversion.cfg +++ b/.bumpversion.cfg @@ -6,3 +6,5 @@ tag = True [bumpversion:file:setup.cfg] [bumpversion:file:src/recastatlas/config.py] + +[bumpversion:file:CITATION.cff] diff --git a/CITATION.cff b/CITATION.cff new file mode 100644 index 0000000..4fba11d --- /dev/null +++ b/CITATION.cff @@ -0,0 +1,45 @@ +cff-version: 1.2.0 +message: "Please cite the following works when using this software." +type: software +authors: +- family-names: "Heinrich" + given-names: "Lukas" + orcid: "https://orcid.org/0000-0002-4048-7584" + affiliation: "Technical University of Munich" +- family-names: "Feickert" + given-names: "Matthew" + orcid: "https://orcid.org/0000-0003-4124-7862" + affiliation: "University of Wisconsin-Madison" +title: "recast-atlas: v0.4.0" +version: 0.4.0 +doi: 10.5281/zenodo.5854896 +repository-code: "https://github.com/recast-hep/recast-atlas/releases/tag/v0.4.0" +url: "https://github.com/recast-hep/recast-atlas/" +keywords: + - python + - physics + - RECAST + - ATLAS + - reinterpretation + - analysis reuse +license: "Apache-2.0" +references: + - type: article + authors: + - family-names: "Cranmer" + given-names: "Kyle" + orcid: "https://orcid.org/0000-0002-5769-7094" + affiliation: "New York University" + - family-names: "Yavin" + given-names: "Itay" + affiliation: "New York University" + title: "RECAST: Extending the Impact of Existing Analyses" + doi: 10.1007/JHEP04(2011)038 + url: "https://doi.org/10.1007/JHEP04(2011)038" + year: 2011 + publisher: + name: "Springer" + volume: 2011 + number: 38 + pages: 2823 + journal: Journal of High Energy Physics