Skip to content
This repository was archived by the owner on Jan 12, 2024. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ The Q# [command line compiler](./src/QsCompiler/CommandLineTool) is included as
- **[VSCodeExtension](./src/VSCodeExtension/)**: Visual Studio Code extension
- **[VisualStudioExtension](./src/VisualStudioExtension/)**: Visual Studio extension

Q# executables can be compiled into an LLVM-based [Quantum Intermediate Representation (QIR)](https://github.com/microsoft/qsharp-language/tree/main/Specifications/QIR). More details on that capability and how to use it can be found in this [README](https://github.com/microsoft/qsharp-compiler/tree/main/src/QsCompiler/QirGeneration).
Q# executables can be compiled into an LLVM-based [Quantum Intermediate Representation (QIR)](https://github.com/qir-alliance/qir-spec). More details on that capability and how to use it can be found in this [README](https://github.com/microsoft/qsharp-compiler/tree/main/src/QsCompiler/QirGeneration).

## New to Quantum? ##

Expand Down
2 changes: 1 addition & 1 deletion examples/QIR/Optimization/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -463,7 +463,7 @@ The driver consists of the following elements:
* header files (to interface with the libraries):

- `QirContext` : used to register the simulator with the QIR runtime
- `QirRuntime` : implements the types and functions defined in the [QIR specification](https://github.com/microsoft/qsharp-language/tree/main/Specifications/QIR)
- `QirRuntime` : implements the types and functions defined in the [QIR specification](https://github.com/qir-alliance/qir-spec)
- `SimFactory` : provides the Q# simulator

* namespaces :
Expand Down
2 changes: 1 addition & 1 deletion examples/QIR/Simulation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ The file `SimulatorTemplate.cpp` in this directory is also good starting point f

## Understanding the QIR Runtime system

The [QIR Runtime](https://github.com/microsoft/qsharp-runtime/tree/main/src/Qir/Runtime) implements the [QIR language specification](https://github.com/microsoft/qsharp-language/tree/main/Specifications/QIR) in LLVM.
The [QIR Runtime](https://github.com/microsoft/qsharp-runtime/tree/main/src/Qir/Runtime) implements the [QIR language specification](https://github.com/qir-alliance/qir-spec) in LLVM.
A quantum program written directly in QIR (or compiled into QIR from Q# e.g.) will expect specific runtime functions to be available, which can include data type management or console output, but also qubit allocation, callable creation, and functor application, such as these QIR/LLVM functions below:

```llvm
Expand Down
8 changes: 4 additions & 4 deletions src/QsCompiler/QirGeneration/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# QIR Emission - Preview Feature

This file contains directions for using the preview feature integrated into the Q# compiler to emit QIR.
QIR is a convention for how to represent quantum programs in LLVM. Its specification can be found [here](https://github.com/microsoft/qsharp-language/tree/main/Specifications/QIR#quantum-intermediate-representation-qir).
QIR is a convention for how to represent quantum programs in LLVM. Its specification can be found [here](https://github.com/qir-alliance/qir-spec#quantum-intermediate-representation-qir).
We aim to ultimately move the Q# compiler to be fully LLVM-based. While the emission is supported starting with the March 2021 release, it is as of this time not yet connected to the runtime. The QIR runtime and instructions for how to execute the emitted QIR can be found [here](https://github.com/microsoft/qsharp-runtime/tree/main/src/Qir/Runtime#the-native-qir-runtime). We are working on a full integration in the future.

## Using the Q# Compiler to Emit QIR
Expand All @@ -26,8 +26,8 @@ For more information about project properties and other Sdk capabilities, see [h

## Limitations

Please be aware that as of this time, it is not possible to both QIR and C#.
Open issues related to QIR emission can be found [here](https://github.com/microsoft/qsharp-compiler/issues?q=is%3Aopen+is%3Aissue+label%3A%22area%3A+QIR%22).
Please be aware that as of this time, it is not possible to both QIR and C#.
Open issues related to QIR emission can be found [here](https://github.com/microsoft/qsharp-compiler/issues?q=is%3Aopen+is%3Aissue+label%3A%22area%3A+QIR%22).
The emitted QIR does currently not contain any debug information. We are planning to add better support in the future. If you are interested in contributing, please indicate your interest on [this issue](https://github.com/microsoft/qsharp-compiler/issues/637).

### Entry Points
Expand Down Expand Up @@ -60,5 +60,5 @@ to be executed from the command line.

## QIR Specification

The QIR specification is on the [Q# language repository](https://github.com/microsoft/qsharp-language/tree/main/Specifications/QIR).
The QIR specification is on the [Q# language repository](https://github.com/qir-alliance/qir-spec).