From 8c1a77790c4ee242313b9e7d8bca3cad4ba731ba Mon Sep 17 00:00:00 2001 From: Sarah Kaiser Date: Sat, 25 Jul 2020 15:39:19 -0700 Subject: [PATCH] Fixing doc strings and user guide stub --- docs/user-guide.md | 5 +++++ src/jupyter/ChpMagic.cs | 18 +++++++++--------- 2 files changed, 14 insertions(+), 9 deletions(-) create mode 100644 docs/user-guide.md diff --git a/docs/user-guide.md b/docs/user-guide.md new file mode 100644 index 0000000..5bdde2c --- /dev/null +++ b/docs/user-guide.md @@ -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 diff --git a/src/jupyter/ChpMagic.cs b/src/jupyter/ChpMagic.cs index 46c74c3..e91c68d 100644 --- a/src/jupyter/ChpMagic.cs +++ b/src/jupyter/ChpMagic.cs @@ -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 @@ -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[]: ``` ", @" - 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[]: ``` ",