Skip to content

Commit 4bdf630

Browse files
authored
Remove incorrect entry in "identifiers" in CITATION.cff (#901)
This removes a redundant entry for the GitHub repo in the "identifiers" section -- one that had the wrong URL anyway. It also adds some explanatory comments to help everyone figure out why there seem to 2 similar overall blocks in here.
1 parent 988915b commit 4bdf630

File tree

1 file changed

+21
-1
lines changed

1 file changed

+21
-1
lines changed

CITATION.cff

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,21 @@
1+
# Citation information for this repository. -*- yaml -*-
2+
#
3+
# CITATION.cff files provide human- & machine-readable citation information for
4+
# software and datasets. GitHub, Zenodo, and the Zotero browser plugin all use
5+
# CFF files automatically if provided. https://citation-file-format.github.io/.
6+
# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
7+
18
cff-version: 1.2.0
29
message: If you use Stim, please cite it using this metadata.
310

11+
# CITATION.cff files describe how to cite software or datasets, with the goal of
12+
# making software and data be citable in their own right. However, sometimes
13+
# projects want citations to go to a paper instead. 'Preferred-citation' serves
14+
# to communicate that. The distinction matters in different situations. If this
15+
# field is present, GitHub uses the value for the "cite this repository" button
16+
# and ignores the rest of this file; conversely, the Zenodo-GitHub integration
17+
# ignores this field when creating an entry for a new software release because
18+
# the Zenodo entry is specifically about the software in this repository.
419
preferred-citation:
520
type: article
621
authors:
@@ -19,6 +34,8 @@ preferred-citation:
1934
Verein zur Förderung des Open Access Publizierens in den
2035
Quantenwissenschaften
2136
37+
# The remaining metadata in this file describes the current software release.
38+
2239
title: Stim
2340
abstract: >-
2441
Stim is a tool for high performance simulation and analysis of quantum
@@ -34,11 +51,14 @@ license: Apache-2.0
3451
type: software
3552
identifiers:
3653
- description: The GitHub repository for Stim
37-
value: https://quantumai.google/Stim
54+
value: https://github.com/quantumlib/Stim
3855
type: url
3956
- description: PyPI project for Stim
4057
value: https://pypi.org/project/Stim
4158
type: url
59+
- description: Publication about Stim
60+
value: 10.22331/q-2021-07-06-497
61+
type: doi
4262
keywords:
4363
- algorithms
4464
- API

0 commit comments

Comments
 (0)