Repository navigation
Change defaults to enable QSim and disable XACC - #43
Merged
Merged
Conversation
for more information, see https://pre-commit.ci
There was a problem hiding this comment.
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.
Member
|
@wongey I'll take a look after the AI-deduced typos are fixed 😄 |
sethrj
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.