Skip to content

Conversation

@wongey
Copy link
Collaborator

@wongey wongey commented Nov 3, 2025

Basic refresh of README and docs pages. I have removed XACC as the default backend, but still included its usage and examples. I will add lightning stuff once it is merged.

@wongey wongey requested a review from Copilot November 4, 2025 22:55
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR updates documentation and configuration to shift QIR-EE's focus from XACC to qsim as the primary quantum backend, while fixing a file path comment. The changes improve the user experience by providing clearer installation instructions and usage examples for the qsim interface.

  • Updated default build options to enable qsim and disable XACC by default
  • Added comprehensive documentation for qir-qsim usage and examples
  • Reorganized installation documentation to separate minimal and XACC builds

Reviewed Changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 9 comments.

Show a summary per file
File Description
src/qirqsim/QsimQuantum.cc Corrected file path comment from qirxacc to qirqsim
doc/main/usage.rst Added qir-qsim usage section with examples and reorganized content
doc/main/introduction.rst Streamlined introduction text and removed marketing language
doc/main/installation.rst Split installation into minimal and XACC-specific sections
doc/main/acknowledgments.rst Expanded acknowledgments with MACH-Q project details
doc/_static/references.bib Added new bibliography entry for QIR-EE repository
README.md Updated with qsim-first approach, installation steps, and examples
CMakeLists.txt Changed default build options to enable qsim and disable XACC

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@sethrj
Copy link
Member

sethrj commented Nov 5, 2025

@wongey I'll take a look after the AI-deduced typos are fixed 😄

@wongey wongey requested a review from sethrj November 5, 2025 14:25
@sethrj sethrj changed the title Update QIR-EE docs Change defaults to enable QSim and disable XACC Nov 5, 2025
Copy link
Member

@sethrj sethrj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @wongey ! I've changed the PR title since the most notable change is to switch from XACC to QSim by default (and update the documentation accordingly). Feel free to iterate again on the title and merge when you're ready :)

@wongey wongey merged commit b4bce33 into ORNL-QCI:main Nov 5, 2025
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants