Skip to content

Commit

Permalink
docs: Add CITATION.cff Citation File Format file
Browse files Browse the repository at this point in the history
* 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 tbump control.
  • Loading branch information
matthewfeickert committed Aug 24, 2024
1 parent 1683d9c commit 8d8be09
Show file tree
Hide file tree
Showing 3 changed files with 35 additions and 2 deletions.
6 changes: 4 additions & 2 deletions .zenodo.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"description": "small package to get structured data out of Les Houches Event files",
"description": "A small package to get structured data out of Les Houches Event files",
"license": "Apache-2.0",
"title": "scikit-hep/pylhe: v0.8.0",
"version": "v0.8.0",
Expand All @@ -23,8 +23,10 @@
],
"access_right": "open",
"keywords": [
"lhe",
"physics",
"lhe"
"python",
"scikit-hep",
],
"related_identifiers": [
{
Expand Down
28 changes: 28 additions & 0 deletions CITATION.cff
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
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"
- family-names: "Rodrigues"
given-names: "Eduardo"
orcid: "https://orcid.org/0000-0003-2846-7625"
affiliation: "University of Liverpool"
title: "pylhe: v0.8.0"
version: 0.8.0
doi: 10.5281/zenodo.1217031
repository-code: "https://github.com/scikit-hep/pylhe/releases/tag/v0.8.0"
keywords:
- lhe
- physics
- python
- scikit-hep
license: "Apache-2.0"
abstract: |
A small package to get structured data out of Les Houches Event files.
3 changes: 3 additions & 0 deletions tbump.toml
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,9 @@ src = "README.md"
[[file]]
src = ".zenodo.json"

[[file]]
src = "CITATION.cff"

[[field]]
# the name of the field
name = "candidate"
Expand Down

0 comments on commit 8d8be09

Please sign in to comment.