Skip to content

Commit

Permalink
fixes to the documentation [ci skip]
Browse files Browse the repository at this point in the history
  • Loading branch information
josh146 committed Apr 10, 2018
1 parent a438e9c commit 7bfb6c8
Show file tree
Hide file tree
Showing 5 changed files with 75 additions and 72 deletions.
2 changes: 1 addition & 1 deletion doc/conventions/gates.rst
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ Squeezing

The squeeze gate affects the position and momentum operators as

.. math:: S^\dagger(z) \x S(z) = e^{-r}\x, ~~~ S^\dagger(z) \p S(z) = e^{r}\p
.. math:: S^\dagger(z) \x_{\phi} S(z) = e^{-r}\x_{\phi}, ~~~ S^\dagger(z) \p_{\phi} S(z) = e^{r}\p_{\phi}

The Fock basis decomposition of displacement and squeezing operations was analysed by Krall :cite:`kral1990`, and the following quantity was calculated,

Expand Down
8 changes: 7 additions & 1 deletion doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,10 @@ Features

..
* Powers the `Strawberry Fields Interactive <https://strawberryfields.ai>`_ web app, which allows anyone to run a quantum computing simulation via drag and drop.

..
* Includes a suite of CV **quantum computer simulators** implemented using **NumPy** and **Tensorflow** - these built-in quantum compiler tools convert and optimize Blackbird code for classical simulation

.. * Includes a **quantum machine learning toolbox**, built on top of the Tensorflow backend
Expand All @@ -39,6 +43,8 @@ Features
Getting started
===============

To see Strawberry Fields in action immediately, try out our `Strawberry Fields Interactive <https://strawberryfields.ai>`_ web application. Prepare your initial states, drag and drop gates, and watch your simulation run in real time right in your web browser.

To get Strawberry Fields installed and running on your system, begin at the :ref:`download and installation guide <installation>`. Then, familiarize yourself with the framework of :ref:`continuous-variable quantum computation <introduction>`, the :ref:`conventions <conventions>` used by Strawberry Fields, and check out some important and interesting continuous-variable :ref:`quantum algorithms <algorithms>`.

For getting started with writing your own Strawberry Fields code, have a look at the :ref:`quantum teleportation tutorial <tutorial>` - this beginner's tutorial breaks down an example Strawberry Fields program for implementing state teleportation. More advanced tutorials also provided include :ref:`boson sampling <boson_tutorial>`, :ref:`gaussian boson sampling <gaussian_boson_tutorial>`, and :ref:`machine learning <machine_learning_tutorial>`.
Expand All @@ -51,7 +57,7 @@ Support
- **Source Code:** https://github.com/XanaduAI/strawberryfields
- **Issue Tracker:** https://github.com/XanaduAI/strawberryfields/issues

If you are having issues, please let us know by posting the issue on our Github issue tracker.
If you are having issues, please let us know by posting the issue on our Github issue tracker, or by joining our `Strawberry Fields Slack channel <https://join.slack.com/t/sf-xanadu/shared_invite/enQtMzQ0NzA0NTczNTkxLTJhOWM0MzY4N2U1ODc5NWZmY2JlN2FmOTY3OTE3ZmVjMWFhZjMwZWY0ODRkZDFmMTA5NjA1YjgyYzA3NDg3NGM>`_.

.. We have a mailing list located at: support@xanadu.ai
Expand Down
4 changes: 2 additions & 2 deletions doc/introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -73,8 +73,8 @@ operators**
.. math::
\begin{aligned}
\hat{x} := \sqrt{\frac{1}{\hbar}}(\a + \ad), \\
\hat{p} := -i\sqrt{\frac{2}{\hbar}}(\a - \ad),\end{aligned}
\hat{x} := \sqrt{\frac{\hbar}{2}}(\a + \ad), \\
\hat{p} := -i\sqrt{\frac{\hbar}{2}}(\a - \ad),\end{aligned}
with :math:`[\x,\p]=i \hbar`. These self-adjoint
operators are proportional to the hermitian and antihermitian parts of
Expand Down
10 changes: 4 additions & 6 deletions doc/research.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ Research and contribution
Research
---------------

If you are doing research using Strawberry Fields, please cite this paper.
If you are doing research using Strawberry Fields, please cite our whitepaper.

We are always open for collaboration, and can be contacted at research@xanadu.ai.
We are always open for collaboration, and can be contacted at hello@xanadu.ai.

Contribution
-------------
Expand All @@ -15,11 +15,9 @@ If you would like to get involved with Strawberry Fields, or you would like to c

- **Source Code:** https://github.com/XanaduAI/strawberryfields
- **Issue Tracker:** https://github.com/XanaduAI/strawberryfields/issues


Support
--------

If you are having issues, please let us know by posting the issue on our Github issue tracker.

.. We have a mailing list located at: support@xanadu.ai
If you are having issues, please let us know by posting the issue on our Github issue tracker, or by joining our `Strawberry Fields Slack channel <https://join.slack.com/t/sf-xanadu/shared_invite/enQtMzQ0NzA0NTczNTkxLTJhOWM0MzY4N2U1ODc5NWZmY2JlN2FmOTY3OTE3ZmVjMWFhZjMwZWY0ODRkZDFmMTA5NjA1YjgyYzA3NDg3NGM>`_.

0 comments on commit 7bfb6c8

Please sign in to comment.