Skip to content
This repository has been archived by the owner on Jan 12, 2024. It is now read-only.

Commit

Permalink
dotnetcli identifier and fix broken link (#264)
Browse files Browse the repository at this point in the history
* dotnetcli identifier and fix broken link

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update README.md

* Update samples/getting-started/teleportation/README.md

Co-Authored-By: Chris Granade <cgranade@gmail.com>
  • Loading branch information
2 people authored and Chris Granade committed Nov 11, 2019
1 parent b4cb3f6 commit 148e2bc
Show file tree
Hide file tree
Showing 7 changed files with 36 additions and 39 deletions.
11 changes: 5 additions & 6 deletions samples/algorithms/chsh-game/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ python host.py

At a terminal, run the following command:

```bash
```dotnetcli
dotnet run
```

Expand All @@ -51,12 +51,11 @@ Press Start in Visual Studio to run the sample.

## Manifest

- [Game.qs](./Game.qs): Q# code implementing the game.
- [host.py](./host.py): Python host program to call into the Q# sample.
- [Host.cs](./Host.cs): C# code to call the operations defined in Q#.
- [CHSHGame.csproj](./CHSHGame.csproj): Main C# project for the sample.
- [Game.qs](https://github.com/microsoft/Quantum/blob/master/samples/algorithms/chsh-game/Game.qs): Q# code implementing the game.
- [host.py](https://github.com/microsoft/Quantum/blob/master/samples/algorithms/chsh-game/host.py): Python host program to call into the Q# sample.
- [Host.cs](https://github.com/microsoft/Quantum/blob/master/samples/algorithms/chsh-game/Host.cs): C# code to call the operations defined in Q#.
- [CHSHGame.csproj](https://github.com/microsoft/Quantum/blob/master/samples/algorithms/chsh-game/CHSHGame.csproj): Main C# project for the sample.

## Further resources

- [Measurement concepts](https://docs.microsoft.com/quantum/concepts/pauli-measurements)

12 changes: 6 additions & 6 deletions samples/algorithms/simple-grover/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,11 @@ description: "This sample implements Grover's search algorithm, an example of a

This sample implements Grover's search algorithm, an example of a quantum development technique known as _amplitude amplification_.
Oracles implementing the database are explicitly constructed together with all steps of the algorithm.
See the [DatabaseSearch](../database-search/README.md) sample for and extended version and the [Grover Search Kata](https://github.com/microsoft/QuantumKatas/tree/master/GroversAlgorithm) to learn more about Grover's algorithm and how to implement it in Q#.
See the [DatabaseSearch](https://github.com/microsoft/Quantum/blob/master/samples/algorithms/database-search/README.md) sample for and extended version and the [Grover Search Kata](https://github.com/microsoft/QuantumKatas/tree/master/GroversAlgorithm) to learn more about Grover's algorithm and how to implement it in Q#.

This sample uses the example of an operation that marks inputs of the form "010101…", then uses Grover's algorithm to find these inputs given only the ability to call that operation.
In this case, the sample uses a hard-coded operation, but operations and functions in the [Microsoft.Quantum.AmplitudeAmplification namespace](https://docs.microsoft.com/qsharp/api/qsharp/microsoft.quantum.amplitudeamplification) can be used to efficiently and easily construct different inputs to Grover's algorithm, and to quickly build up useful variations of amplitude amplification for different applications.
For examples of how to solve more general problems using amplitude amplification, check out the more in-depth [database search sample](../database-search).
For examples of how to solve more general problems using amplitude amplification, check out the more in-depth [database search sample](https://github.com/microsoft/Quantum/tree/master/samples/algorithms/database-search).

## Prerequisites ##

Expand All @@ -39,7 +39,7 @@ python host.py

At a terminal, run the following command:

```bash
```dotnetcli
dotnet run
```

Expand All @@ -50,7 +50,7 @@ Press Start in Visual Studio to run the sample.

## Manifest ##

- [SimpleGrover.qs](./SimpleGrover.qs): Q# code implementing quantum operations for this sample.
- [Host.cs](./Host.cs): C# code to interact with and print out results of the Q# operations for this sample.
- [SimpleGroverSample.csproj](./SimpleGroverSample.csproj): Main C# project for the sample.
- [SimpleGrover.qs](https://github.com/microsoft/Quantum/blob/master/samples/algorithms/simple-grover/SimpleGrover.qs): Q# code implementing quantum operations for this sample.
- [Host.cs](https://github.com/microsoft/Quantum/blob/master/samples/algorithms/simple-grover/Host.cs): C# code to interact with and print out results of the Q# operations for this sample.
- [SimpleGroverSample.csproj](https://github.com/microsoft/Quantum/blob/master/samples/algorithms/simple-grover/SimpleGroverSample.csproj): Main C# project for the sample.

10 changes: 5 additions & 5 deletions samples/characterization/phase-estimation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ python host.py

At a terminal, run the following command:

```bash
```dotnetcli
dotnet run
```

Expand All @@ -47,7 +47,7 @@ Press Start in Visual Studio to run the sample.

## Manifest ##

- [PhaseEstimationSample.csproj](./PhaseEstimationSample.csproj): Main C# project for the example.
- [Host.cs](./Host.cs): C# code to call the operations defined in Q#.
- [host.py](./host.py): a sample Python program to call the Q# phase estimation operation.
- [BayesianPhaseEstimation.qs](./BayesianPhaseEstimation.qs): The Q# implementation of iterative phase estimation and Bayesian inference.
- [PhaseEstimationSample.csproj](https://github.com/microsoft/Quantum/tree/master/samples/characterization/phase-estimation/PhaseEstimationSample.csproj): Main C# project for the example.
- [Host.cs](https://github.com/microsoft/Quantum/tree/master/samples/characterization/phase-estimation/Host.cs): C# code to call the operations defined in Q#.
- [host.py](https://github.com/microsoft/Quantum/tree/master/samples/characterization/phase-estimation/host.py): a sample Python program to call the Q# phase estimation operation.
- [BayesianPhaseEstimation.qs](https://github.com/microsoft/Quantum/tree/master/samples/characterization/phase-estimation/BayesianPhaseEstimation.qs): The Q# implementation of iterative phase estimation and Bayesian inference.
7 changes: 3 additions & 4 deletions samples/getting-started/intro-to-iqsharp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,14 +20,13 @@ This sample demonstrates:

## Running the Sample

From the command line, start Jupyter Notebook and open the [Notebook.ipynb](./Notebook.ipynb) file.
From the command line, start Jupyter Notebook and open the [Notebook.ipynb](https://github.com/microsoft/Quantum/blob/master/samples/getting-started/intro-to-iqsharp/Notebook.ipynb) file.

```
jupyter notebook Notebook.ipynb
```

## Manifest

- [Notebook.ipynb](./Notebook.ipynb): a Jupyter Notebook demonstrating how to simulate Q# operations and functions.
- [Operations.qs](./Operations.qs): Q# code called from the Jupyter Notebook for this sample.

- [Notebook.ipynb](https://github.com/microsoft/Quantum/blob/master/samples/getting-started/intro-to-iqsharp/Notebook.ipynb): a Jupyter Notebook demonstrating how to simulate Q# operations and functions.
- [Operations.qs](https://github.com/microsoft/Quantum/blob/master/samples/getting-started/intro-to-iqsharp/Operations.qs): Q# code called from the Jupyter Notebook for this sample.
11 changes: 5 additions & 6 deletions samples/getting-started/measurement/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ python host.py

At a terminal, run the following command:

```bash
```dotnetcli
dotnet run
```

Expand All @@ -51,13 +51,12 @@ Press Start in Visual Studio to run the sample.

## Manifest

- [Measurement.qs](./Measurement.qs): Q# code preparing and measuring a few qubits.
- [host.py](./host.py): Python host program to call into the Q# sample.
- [Host.cs](./Host.cs): C# code to call the operations defined in Q#.
- [Measurement.csproj](./Measurement.csproj): Main C# project for the sample.
- [Measurement.qs](https://github.com/microsoft/Quantum/blob/master/samples/getting-started/measurement/Measurement.qs): Q# code preparing and measuring a few qubits.
- [host.py](https://github.com/microsoft/Quantum/blob/master/samples/getting-started/measurement/host.py): Python host program to call into the Q# sample.
- [Host.cs](https://github.com/microsoft/Quantum/blob/master/samples/getting-started/measurement/Host.cs): C# code to call the operations defined in Q#.
- [Measurement.csproj](https://github.com/microsoft/Quantum/blob/master/samples/getting-started/measurement/Measurement.csproj): Main C# project for the sample.

## Further resources

- [Measurement concepts](https://docs.microsoft.com/quantum/concepts/pauli-measurements)
- [Logging and assertion techniques](https://docs.microsoft.com/quantum/techniques/testing-and-debugging#logging-and-assertions)

8 changes: 4 additions & 4 deletions samples/getting-started/simple-algorithms/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ This sample can be run in a number of different ways, depending on your preferre

At a terminal, run the following command:

```bash
```dotnetcli
dotnet run
```

Expand All @@ -36,8 +36,8 @@ Press Start in Visual Studio to run the sample.

## Manifest ##

- [SimpleAlgorithms.qs](./SimpleAlgorithms.qs): Q# code implementing quantum operations for this sample.
- [Host.cs](./Host.cs): C# code to interact with and print out results of the Q# operations for this sample.
- [SimpleAlgorithms.csproj](./SimpleAlgorithms.csproj): Main C# project for the sample.
- [SimpleAlgorithms.qs](https://github.com/microsoft/Quantum/blob/master/samples/getting-started/simple-algorithms/SimpleAlgorithms.qs): Q# code implementing quantum operations for this sample.
- [Host.cs](https://github.com/microsoft/Quantum/blob/master/samples/getting-started/simple-algorithms/Host.cs): C# code to interact with and print out results of the Q# operations for this sample.
- [SimpleAlgorithms.csproj](https://github.com/microsoft/Quantum/blob/master/samples/getting-started/simple-algorithms/SimpleAlgorithms.csproj): Main C# project for the sample.


16 changes: 8 additions & 8 deletions samples/getting-started/teleportation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ This sample can be run in a number of different ways, depending on your preferre

### Jupyter Notebook ###

From the command line, start Jupyter Notebook and open the [Notebook.ipynb](./Notebook.ipynb) file.
From the command line, start Jupyter Notebook and open the [Notebook.ipynb](https://github.com/microsoft/Quantum/blob/master/samples/getting-started/teleportation/Notebook.ipynb) file.

```
jupyter notebook Notebook.ipynb
Expand All @@ -48,7 +48,7 @@ python host.py

At a terminal, run the following command:

```bash
```dotnetcli
dotnet run
```

Expand All @@ -59,9 +59,9 @@ Press Start in Visual Studio to run the sample.

## Manifest ##

- [TeleportationSample.qs](./TeleportationSample.qs): Q# code defining how to teleport qubit states.
- [Utils.qs](./Utils.qs): Q# code with some utility operations used to prepare and read |+> and |-> states.
- [Host.cs](./Program.cs): C# code to call the operations defined in Q#.
- [TeleportationSample.csproj](./TeleportationSample.csproj): Main C# project for the example.
- [host.py](./host.py): a sample Python program to call the Q# teleport operation.
- [Notebook.ipynb](./Notebook.ipynb): a Jupyter notebook that shows how to implement the Q# teleport operation.
- [TeleportationSample.qs](https://github.com/microsoft/Quantum/blob/master/samples/getting-started/teleportation/TeleportationSample.qs): Q# code defining how to teleport qubit states.
- [Utils.qs](https://github.com/microsoft/Quantum/blob/master/samples/getting-started/teleportation/Utils.qs): Q# code with some utility operations used to prepare and read |+> and |-> states.
- [Host.cs](https://github.com/microsoft/Quantum/blob/master/samples/getting-started/teleportation/Host.cs): C# code to call the operations defined in Q#.
- [TeleportationSample.csproj](https://github.com/microsoft/Quantum/blob/master/samples/getting-started/teleportation/TeleportationSample.csproj): Main C# project for the example.
- [host.py](https://github.com/microsoft/Quantum/blob/master/samples/getting-started/teleportation/host.py): a sample Python program to call the Q# teleport operation.
- [Notebook.ipynb](https://github.com/microsoft/Quantum/blob/master/samples/getting-started/teleportation/Notebook.ipynb): a Jupyter notebook that shows how to implement the Q# teleport operation.

0 comments on commit 148e2bc

Please sign in to comment.