Add CITATION.cff file for creating OQpy citation

.github/workflows/test.yml

@@ -34,7 +34,7 @@ jobs:
     strategy:
       matrix:
         os: [ ubuntu-latest ]
-        python-version: [ "3.10" ]
+        python-version: [ "3.11" ]
     runs-on: ${{ matrix.os }}
     steps:
       - name: Check out OQpy
@@ -66,6 +66,9 @@ jobs:
       - name: Run pydocstyle
         run: poetry run make check-pydocstyle
 
+      - name: Run cffconvert
+        run: poetry run make check-citation
+
       - name: Install OQpy using pip
         run: poetry run pip install .
 

CITATION.cff

@@ -0,0 +1,38 @@
+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"
+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,
+  which serve as Python reference implementations of the abstract syntax tree (AST)
+  for the OpenQASM 3 and OpenPulse grammars.
+authors:
+  - family-names: Reinhold
+    given-names: Philip
+    affiliation: "AWS Center for Quantum Computing"
+    orcid: "https://orcid.org/0000-0002-8141-1842"
+  - family-names: Teo
+    given-names: Stephanie
+    affiliation: "AWS Center for Quantum Computing"
+    orcid: "https://orcid.org/0000-0002-6762-7313"
+  - family-names: Jaskula
+    given-names: Jean-Christophe
+    affiliation: "AWS Quantum Technologies"
+    orcid: "https://orcid.org/0000-0002-3379-229X"
+  - family-names: Chen
+    given-names: Li
+    affiliation: "AWS Center for Quantum Computing"
+    orcid: "https://orcid.org/0000-0002-1700-7503"
+  - family-names: Sivarajah
+    given-names: Prasahnt
+    affiliation: "AWS Center for Quantum Computing"
+    orcid: "https://orcid.org/0000-0002-9383-8624"
+  - family-names: Karalekas
+    given-names: Peter
+    affiliation: "AWS Center for Quantum Computing"
+    orcid: "https://orcid.org/0000-0001-6031-4800"
+license: Apache-2.0
+keywords:
+  - openqasm
+  - quantum
+repository-code: "https://github.com/openqasm/oqpy"

Makefile

@@ -39,6 +39,10 @@ open-docs:
 check-tests:
 	pytest --cov=oqpy -vv --color=yes tests
 
+.PHONY: check-citation
+check-citation:
+	cffconvert --validate
+
 .PHONY: install-poetry
 install-poetry:
 	command -v curl >/dev/null 2>&1 || { echo >&2 "please install curl and retry."; exit 1; }