Skip to content

Commit cae4e9f

Browse files
authored
Add CITATION.cff file (#900)
A file in [CITATION File Format](https://citation-file-format.github.io/) (`CITATION.cff`) can be placed at the top level of a GitHub repo to [provide machine-readable citation information](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files) that helps users correctly cite software. When it detects a `CITATION.cff` file in a repository, GitHub adds a [button to the upper right sidebar](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files#:~:text=added%20to%20the%20repository%20landing%20page%20in%20the%20right%20sidebar%2C%20with%20the%20label%20%22Cite%20this%20repository.%22) that lets users copy a formatted citation. I generated this particular `CITATION.cff` file mostly by hand, with a little initial help from [Citation.js](https://citation-js.github.io/cff-generator/). @Strilanc the abstract and the list of keywords could use a review. I gave it a good try but there may still be errors.
1 parent 9898718 commit cae4e9f

File tree

1 file changed

+71
-0
lines changed

1 file changed

+71
-0
lines changed

CITATION.cff

+71
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
cff-version: 1.2.0
2+
message: If you use Stim, please cite it using this metadata.
3+
4+
preferred-citation:
5+
type: article
6+
authors:
7+
- family-names: Gidney
8+
given-names: Craig
9+
title: 'Stim: a fast stabilizer circuit simulator'
10+
journal: Quantum
11+
year: 2021
12+
month: 7
13+
volume: 5
14+
start: 497
15+
issn: 2521-327X
16+
url: https://doi.org/10.22331/q-2021-07-06-497
17+
publisher:
18+
name: >-
19+
Verein zur Förderung des Open Access Publizierens in den
20+
Quantenwissenschaften
21+
22+
title: Stim
23+
abstract: >-
24+
Stim is a tool for high performance simulation and analysis of quantum
25+
stabilizer circuits, especially quantum error correction (QEC) circuits.
26+
authors:
27+
- family-names: Gidney
28+
given-names: Craig
29+
version: 1.14.0
30+
date-released: 2024-09-24
31+
url: https://github.com/quantumlib/stim
32+
repository-code: https://github.com/quantumlib/stim
33+
license: Apache-2.0
34+
type: software
35+
identifiers:
36+
- description: The GitHub repository for Stim
37+
value: https://quantumai.google/Stim
38+
type: url
39+
- description: PyPI project for Stim
40+
value: https://pypi.org/project/Stim
41+
type: url
42+
keywords:
43+
- algorithms
44+
- API
45+
- application programming interface
46+
- C++
47+
- Clifford gates
48+
- Clifford operations
49+
- high performance
50+
- open-source software
51+
- physics
52+
- Python
53+
- QEC
54+
- quantum
55+
- quantum algorithms
56+
- quantum circuits
57+
- quantum computing
58+
- quantum error correction
59+
- quantum error decoder
60+
- quantum gates
61+
- quantum programming
62+
- quantum simulation
63+
- quantum state
64+
- qubit
65+
- science
66+
- SDK
67+
- simulation
68+
- simulator
69+
- software
70+
- software development toolkit
71+
- stabilizer circuits

0 commit comments

Comments
 (0)