Skip to content

Commit

Permalink
Fixing doc strings and user guide stub
Browse files Browse the repository at this point in the history
  • Loading branch information
crazy4pi314 committed Jul 25, 2020
1 parent b397a04 commit 8c1a777
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 9 deletions.
5 changes: 5 additions & 0 deletions docs/user-guide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# User Guide for the Q# Stabilizer Simulator

The StabilizerSimulator (also referred to as CHP based on the paper that proposes it) allows you to simulate your quantum programs using only the operations supported by the formalism.

TODO: FINISH ME, look at https://docs.microsoft.com/en-us/quantum/user-guide/machines/resources-estimator
18 changes: 9 additions & 9 deletions src/jupyter/ChpMagic.cs
Original file line number Diff line number Diff line change
Expand Up @@ -34,13 +34,13 @@ public ChpMagic(ISymbolResolver resolver, IConfigurationSource configurationSour
"chp",
new Documentation
{
Summary = "Runs a given function or operation on the ToffoliSimulator target machine.",
Summary = "Runs a given function or operation on the StabilizerSimulator target machine.",
Description = @"
This magic command allows executing a given function or operation on the ToffoliSimulator,
which performs a simulation of the given function or operation in which the state is always
a simple product state in the computational basis, and prints the resulting return value.
This magic command allows executing a given function or operation on the StabilizerSimulator,
which performs a simulation of the given function or operation in which the state can always be
represented by a stabilizer of the form described by CHP, and prints the resulting return value.
See the [ToffoliSimulator user guide](https://docs.microsoft.com/quantum/user-guide/machines/toffoli-simulator) to learn more.
See the [StabilizerSimulator user guide](https://github.com/qsharp-community/chp-sim/docs/user-guide.md) to learn more.
#### Required parameters
Expand All @@ -51,18 +51,18 @@ or function name that has been defined either in the notebook or in a Q# file in
Examples = new[]
{
@"
Use the ToffoliSimulator to simulate a Q# operation
Use the StabilizerSimulator to simulate a Q# operation
defined as `operation MyOperation() : Result`:
```
In []: %toffoli MyOperation
In []: %chp MyOperation
Out[]: <return value of the operation>
```
",
@"
Use the ToffoliSimulator to simulate a Q# operation
Use the StabilizerSimulator to simulate a Q# operation
defined as `operation MyOperation(a : Int, b : Int) : Result`:
```
In []: %toffoli MyOperation a=5 b=10
In []: %chp MyOperation a=5 b=10
Out[]: <return value of the operation>
```
",
Expand Down

0 comments on commit 8c1a777

Please sign in to comment.