Add documentation

ORNL-QCI · Jun 25, 2024 · 8e479ca · 8e479ca
1 parent ca260bb
commit 8e479ca
Show file tree

Hide file tree

Showing 8 changed files with 21 additions and 13 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -110,7 +110,7 @@ set(QIREE_RUNTIME_OUTPUT_DIRECTORY
 enable_language(C) # Needed for LLVM
 find_package(LLVM REQUIRED)
 if((LLVM_VERSION VERSION_LESS 14)
-  OR (LLVM_VERSION VERSION_GREATER 18.1))
+  OR (LLVM_VERSION VERSION_GREATER_EQUAL 19))
   message(WARNING "QIR-EE is only tested with LLVM 14-18: found version ${LLVM_VERSION}")
 endif()
 

diff --git a/README.md b/README.md
@@ -27,13 +27,6 @@ doc` (user) or `make doxygen` (developer).
 [user-docs]: https://ornl-qci.github.io/qir-ee/user/index.html
 [dev-docs]: https://ornl-qci.github.io/qir-ee/dev/index.html
 
-
-## Introduction
-
-Welcome to the Quantum Intermediate Representation Execution Engine (QIR-EE), a state-of-the-art tool designed to streamline the process of running quantum circuits and algorithms. Whether you're a researcher, student, or enthusiast, QIR-EE (pronounced 'cure-ee') is designed to make your journey into quantum computing as seamless as possible. This implementation is associated to the paper [A Cross-Platform Execution Engine for the Quantum Intermediate Representation](https://doi.org/10.48550/arXiv.2404.14299) and is maintained by the QIR-EE Developers.
-
-At version 0.1, this work represents a proof-of-concept for the feasibility of a modular workflow at the lower end of the quantum software stack. We welcome feedback and ideas for collaborations.
-
 ## Getting Started
 
 There are two dependencies for QIR-EE to work properly. Please make sure to download and install the most current versions of:

diff --git a/doc/_static/references.bib b/doc/_static/references.bib
@@ -0,0 +1,6 @@
+@misc{wong2024,
+  author = {Wong, E. and Leyton Ortega, V. and Claudino, D. and Johnson, S. and Afrose, S. and Gowrishankar, M. and Cabrera, A. M. and Humble, T. S.},
+  title = {A Cross-Platform Execution Engine for the Quantum Intermediate Representation},
+  year = {2024},
+  note = {ar{X}iv print available at \url{https://arxiv.org/abs/2404.14299}}
+}
diff --git a/doc/conf.py b/doc/conf.py
@@ -92,7 +92,6 @@
     extensions.append("sphinxcontrib.bibtex")
     bibtex_bibfiles = [
         "_static/references.bib",
-        "_static/qiree.bib"
     ]
 
 # Add any paths that contain templates here, relative to this directory.

diff --git a/doc/main/installation.rst b/doc/main/installation.rst
@@ -2,8 +2,6 @@
 .. See the doc/COPYRIGHT file for details.
 .. SPDX-License-Identifier: CC-BY-4.0
 
-.. highlight:: cmake
-
 .. _infrastructure:
 
 ************

diff --git a/doc/main/introduction.rst b/doc/main/introduction.rst
@@ -8,6 +8,18 @@
 Introduction
 ************
 
-QIR-EE [#qiree_vers]_ is ...
+Welcome to the Quantum Intermediate Representation Execution Engine (QIR-EE)
+[#qiree_vers]_, a state-of-the-art tool designed to streamline the process of
+running quantum circuits and algorithms. Whether you're a researcher, student,
+or enthusiast, QIR-EE (pronounced 'cure-ee') is designed to make your journey
+into quantum computing as seamless as possible. This implementation is
+associated to the paper "A Cross-Platform Execution Engine for the Quantum
+Intermediate Representation" [#qiree_paper]_ and is maintained by the QIR-EE
+Developers.
+
+At version 0.1, this work represents a proof-of-concept for the feasibility of
+a modular workflow at the lower end of the quantum software stack. We welcome
+feedback and ideas for collaborations.
 
 .. [#qiree_vers] This documentation is generated from QIR-EE |release|.
+.. [#qiree_paper] A preprint of this paper can be found at :cite:t:`wong2024`.
diff --git a/examples/others/pe_onethird_06.ll → examples/pe_onethird_06.ll b/examples/others/pe_onethird_06.ll → examples/pe_onethird_06.ll
diff --git a/src/qiree/RuntimeInterface.hh b/src/qiree/RuntimeInterface.hh
@@ -46,7 +46,7 @@ class RuntimeInterface
     //! Record one result into the progrma output
     virtual void result_record_output(Result result, OptionalCString tag) = 0;
 
-    //! No one uses tuples??
+    //! Prepare to store N tuples
     virtual void tuple_record_output(size_type, OptionalCString tag) = 0;
 
   protected: