qasm-ts 2.1.0 → 2.1.2

package/CITATION.cff

@@ -0,0 +1,34 @@
+cff-version: "1.2.0"
+authors:
+- family-names: Kim
+  given-names: Sean
+  orcid: "https://orcid.org/0009-0006-1223-1895"
+- family-names: Edwards
+  given-names: Marcus
+  orcid: "https://orcid.org/0000-0001-6591-9585"
+doi: 10.5281/zenodo.17144767
+message: If you use this software, please cite our article in the
+  Journal of Open Source Software.
+preferred-citation:
+  authors:
+  - family-names: Kim
+    given-names: Sean
+    orcid: "https://orcid.org/0009-0006-1223-1895"
+  - family-names: Edwards
+    given-names: Marcus
+    orcid: "https://orcid.org/0000-0001-6591-9585"
+  date-published: 2025-09-17
+  doi: 10.21105/joss.08696
+  issn: 2475-9066
+  issue: 113
+  journal: Journal of Open Source Software
+  publisher:
+    name: Open Journals
+  start: 8696
+  title: Enabling the Verification and Formalization of Hybrid
+    Quantum-Classical Computing with OpenQASM 3.0 compatible QASM-TS 2.0
+  type: article
+  url: "https://joss.theoj.org/papers/10.21105/joss.08696"
+  volume: 10
+title: Enabling the Verification and Formalization of Hybrid
+  Quantum-Classical Computing with OpenQASM 3.0 compatible QASM-TS 2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "qasm-ts",
-  "version": "2.1.0",
+  "version": "2.1.2",
   "description": "QASM, the low-level programming language for quantum circuit specification, implemented in TypeScript.",
   "main": "dist/main.js",
   "scripts": {

package/readme.md

@@ -1,6 +1,7 @@
 # QASM TypeScript
 
 ![NPM Downloads](https://img.shields.io/npm/dy/qasm-ts)
+[![DOI](https://joss.theoj.org/papers/10.21105/joss.08696/status.svg)](https://doi.org/10.21105/joss.08696)
 
 
 OpenQASM, the low-level programming language for quantum circuit specification, implemented in TypeScript.
@@ -11,9 +12,18 @@ The package is aimed at enabling implementations of verification and validation
 
 Language documentation is provided by IBM [here](https://openqasm.com).
 
-## New in Version 2.0.0
+## New in Version 2.1.0
+
+This release includes several improvements made during the review of the repo by reviewers from the Journal of Open Source Software. These improvements include:
+
+- more examples in documentation
+- easier navigation in the documentation
+- files like CONTRIBUTING and LICENSE
+- fix for the compatibility of the test suite with Windows
+- documentation on how to run our benchmarks
+- improvements to the README
+- etc.
 
-- Support for the OpenQASM 3.0 spec while retaining OpenQASM 2.0 backwards compatibility.
 
 ## Usage
 
@@ -44,7 +54,7 @@ The parser is able to recognize and handle 19 distinct types of syntax errors, w
 exported in `errors.ts`. While this is not an advanced semantic or static analysis, it should enable 
 users to basically validate their OpenQASM 2.0 or 3.0 code.
 
-Comprehensive API docs can be found in the `docs/` directory.
+Comprehensive API docs can be found in the `docs/` directory, and the docs are hosted online [here](https://marcusedwards.me/qasm-ts).
 
 ## Example I/O
 
@@ -177,16 +187,20 @@ Unless required by applicable law or agreed to in writing, software distributed
 
 ## How to Cite
 
-If you are using QASM-TS for research we appreciate any citations. Please read and cite our pre-print at https://arxiv.org/abs/2412.12578.
+If you are using QASM-TS for research we appreciate any citations. Please read and cite our [paper](https://doi.org/10.21105/joss.08696) published with the Journal of Open Source Software.
 
 ```
-@misc{kim2024enablingverificationformalizationhybrid,
-      title={Enabling the Verification and Formalization of Hybrid Quantum-Classical Computing with OpenQASM 3.0 compatible QASM-TS 2.0}, 
-      author={Sean Kim and Marcus Edwards},
-      year={2024},
-      eprint={2412.12578},
-      archivePrefix={arXiv},
-      primaryClass={cs.PL},
-      url={https://arxiv.org/abs/2412.12578}, 
+@article{Kim[2025,
+  doi = {10.21105/joss.08696},
+  url = {https://doi.org/10.21105/joss.08696},
+  year = {2025},
+  publisher = {The Open Journal},
+  volume = {10},
+  number = {113},
+  pages = {8696},
+  author = {Kim[, Sean and Edwards[, Marcus},
+  title = {Enabling the Verification and Formalization of Hybrid Quantum-Classical Computing with OpenQASM 3.0 compatible QASM-TS 2.0},
+  journal = {Journal of Open Source Software}
 }
+ 
 ```