Skip to content

Commit f98a901

Browse files
authored
Add CITATION.cff file (#966)
This basically mirrors the `.zenodo.json` file contents. Per internal discussions, we will not attempt to keep the code contributors list up to date, and instead use "The OpenFermion Developers".
1 parent ad37b47 commit f98a901

2 files changed

Lines changed: 218 additions & 0 deletions

File tree

.github/workflows/ci.yml

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,8 @@ jobs:
8383
python_files: ${{steps.filter.outputs.python_files}}
8484
yaml: ${{steps.filter.outputs.yaml}}
8585
yaml_files: ${{steps.filter.outputs.yaml_files}}
86+
cff: ${{steps.filter.outputs.cff}}
87+
cff_files: ${{steps.filter.outputs.cff_files}}
8688
steps:
8789
# When invoked manually, use the given SHA to figure out the change list.
8890
- if: github.event_name == 'workflow_dispatch'
@@ -125,6 +127,9 @@ jobs:
125127
- added|modified:
126128
- '**/*.yaml'
127129
- '**/*.yml'
130+
cff:
131+
- added|modified:
132+
- '**/CITATION.cff'
128133
129134
setup:
130135
if: needs.changes.outputs.python == 'true'
@@ -398,3 +403,23 @@ jobs:
398403
set -x
399404
# shellcheck disable=SC2086
400405
yamllint $changed_files
406+
407+
cff-validation:
408+
if: needs.changes.outputs.cff == 'true'
409+
name: Validate CITATION.cff file(s)
410+
needs: changes
411+
runs-on: ubuntu-24.04
412+
timeout-minutes: 5
413+
env:
414+
changed_files: ${{needs.changes.outputs.cff_files}}
415+
steps:
416+
- name: Check out a copy of the git repository
417+
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
418+
419+
- name: Install cffconvert
420+
run: |
421+
pip install cffconvert
422+
423+
- name: Run cffconvert in validation mode
424+
run: |
425+
cffconvert --validate

CITATION.cff

Lines changed: 193 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,193 @@
1+
cff-version: 1.2.0
2+
message: If you use OpenFermion, please cite it using this metadata.
3+
4+
title: OpenFermion
5+
6+
abstract: The electronic structure package for quantum computers.
7+
8+
authors:
9+
- name: The OpenFermion Developers
10+
11+
version: 1.7.0
12+
13+
date-released: 2024-02-08
14+
15+
url: https://github.com/quantumlib/openfermion
16+
17+
repository-code: https://github.com/quantumlib/openfermion
18+
19+
license: Apache-2.0
20+
21+
type: software
22+
23+
preferred-citation:
24+
authors:
25+
- family-names: McClean
26+
given-names: Jarrod R.
27+
28+
- family-names: Rubin
29+
given-names: Nicholas C.
30+
31+
- family-names: Sung
32+
given-names: Kevin J.
33+
34+
- family-names: Kivlichan
35+
given-names: Ian D.
36+
37+
- family-names: Bonet-Monroig
38+
given-names: Xavier
39+
40+
- family-names: Cao
41+
given-names: Yudong
42+
43+
- family-names: Dai
44+
given-names: Chengyu
45+
46+
- family-names: Fried
47+
given-names: E. Schuyler
48+
49+
- family-names: Gidney
50+
given-names: Craig
51+
52+
- family-names: Gimby
53+
given-names: Brendan
54+
55+
- family-names: Gokhale
56+
given-names: Pranav
57+
58+
- family-names: Häner
59+
given-names: Thomas
60+
61+
- family-names: Hardikar
62+
given-names: Tarini
63+
64+
- family-names: Havlíček
65+
given-names: Vojtěch
66+
67+
- family-names: Higgott
68+
given-names: Oscar
69+
70+
- family-names: Huang
71+
given-names: Cupjin
72+
73+
- family-names: Izaac
74+
given-names: Josh
75+
76+
- family-names: Jiang
77+
given-names: Zhang
78+
79+
- family-names: Liu
80+
given-names: Xinle
81+
82+
- family-names: McArdle
83+
given-names: Sam
84+
85+
- family-names: Neeley
86+
given-names: Matthew
87+
88+
- family-names: O'Brien
89+
given-names: Thomas
90+
91+
- family-names: O'Gorman
92+
given-names: Bryan
93+
94+
- family-names: Ozfidan
95+
given-names: Isil
96+
97+
- family-names: Radin
98+
given-names: Maxwell D.
99+
100+
- family-names: Romero
101+
given-names: Jhonathan
102+
103+
- family-names: Sawaya
104+
given-names: Nicolas P. D.
105+
106+
- family-names: Senjean
107+
given-names: Bruno
108+
109+
- family-names: Setia
110+
given-names: Kanav
111+
112+
- family-names: Sim
113+
given-names: Sukin
114+
115+
- family-names: Steiger
116+
given-names: Damian S.
117+
118+
- family-names: Steudtner
119+
given-names: Mark
120+
121+
- family-names: Sun
122+
given-names: Qiming
123+
124+
- family-names: Sun
125+
given-names: Wei
126+
127+
- family-names: Wang
128+
given-names: Daochen
129+
130+
- family-names: Zhang
131+
given-names: Fang
132+
133+
- family-names: Babbush
134+
given-names: Ryan
135+
title: "OpenFermion: The Electronic Structure Package for Quantum Computers"
136+
type: article
137+
journal: Quantum Science and Technology
138+
year: 2020
139+
volume: 5
140+
issue: 3
141+
doi: 10.1088/2058-9565/ab8ebc
142+
143+
identifiers:
144+
- description: The home page for OpenFermion
145+
type: url
146+
value: https://github.com/quantumlib/OpenFermion
147+
148+
- description: The GitHub repository for OpenFermion
149+
type: url
150+
value: https://quantumai.google/openfermion
151+
152+
- description: PyPI project for OpenFermion
153+
type: url
154+
value: https://pypi.org/project/openfermion
155+
156+
keywords:
157+
- algorithms
158+
- API
159+
- application programming interface
160+
- chemistry
161+
- Cirq
162+
- electronic structure
163+
- fermion
164+
- fermionic systems
165+
- Hamiltonians
166+
- high performance
167+
- NISQ
168+
- noisy intermediate-scale quantum
169+
- open-source software
170+
- physics
171+
- Python
172+
- quantum algorithms
173+
- quantum chemistry
174+
- quantum circuit simulator
175+
- quantum circuit
176+
- quantum computer simulator
177+
- quantum computing
178+
- quantum information science
179+
- quantum information
180+
- quantum programming language
181+
- quantum programming
182+
- quantum simulation
183+
- quantum state
184+
- quantum system
185+
- quantum theory
186+
- quantum
187+
- qubit Hamiltonians
188+
- qubit
189+
- science
190+
- SDK
191+
- simulation
192+
- software development toolkit
193+
- software

0 commit comments

Comments
 (0)