Skip to content

Add Zenodo DOI to CITATION.cff #23

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Nov 23, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion CITATION.cff
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
cff-version: 1.2.0
message: "If you use this software, please cite it using these metadata."
title: "OQpy: Generating OpenQASM 3 + OpenPulse in Python"
title: "OQpy: OpenQASM 3 + OpenPulse in Python"
abstract: >
The goal of oqpy ("ock-pie") is to make it easy to generate OpenQASM 3 + OpenPulse
in Python. The oqpy library builds off of the openqasm3 and openpulse packages,
Expand Down Expand Up @@ -36,3 +36,4 @@ keywords:
- openqasm
- quantum
repository-code: "https://github.com/openqasm/oqpy"
doi: 10.5281/zenodo.7349265
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -147,3 +147,16 @@ for int shot_index in [0:99] {

We welcome contributions to OQpy including bug fixes, feature requests, etc. To get started, check
out our [contributing guidelines](CONTRIBUTING.md).

## Citation

If you use OQpy in your work or research, please cite it using the metadata in the
[`CITATION.cff`][citation-file] file in the repository (which includes a
[Zenodo DOI][zenodo-doi]). You can copy the citation in BibTeX format using the
["Cite this repository" widget][citation-widget] in the About section of the
[repository page on GitHub][github].

[zenodo-doi]: https://doi.org/10.5281/zenodo.7349265
[citation-file]: https://github.com/openqasm/oqpy/blob/main/CITATION.cff
[citation-widget]: https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files
[github]: https://github.com/openqasm/oqpy
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ version = "0.1.2"
description = "Generating OpenQASM 3 + OpenPulse in Python"
authors = ["OQpy Contributors <[email protected]>"]
license = "Apache-2.0"
include = ["NOTICE"]
include = ["CITATION.cff", "NOTICE"]
readme = "README.md"
repository = "https://github.com/openqasm/oqpy"
keywords = ["openqasm", "quantum"]
Expand Down