Skip to content

Commit

Permalink
updated readme and installation to mention GPU support [ci skip]
Browse files Browse the repository at this point in the history
  • Loading branch information
josh146 committed Aug 2, 2018
1 parent 35b5b12 commit 0cfef10
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 10 deletions.
9 changes: 8 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Features

* Quantum circuits are written using the easy-to-use and intuitive **Blackbird quantum programming language**

* 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 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

* Future releases will aim to target experimental backends, including **photonic quantum computing chips**

Expand All @@ -56,6 +56,13 @@ Strawberry Fields requires Python version 3.5 and above. Installation of Strawbe
$ python -m pip install strawberryfields
If you are using the ``tensorflow-gpu`` module for TensorFlow GPU support, you can install the following package for GPU support in Strawberry Fields:

.. code-block:: bash
$ python -m pip install strawberryfields-gpu
Getting started
===============

Expand Down
24 changes: 15 additions & 9 deletions doc/installing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,15 +32,21 @@ Installation
Installation of Strawberry Fields, as well as all required Python packages mentioned above, can be installed via ``pip``:
::

python -m pip install strawberryfields
$ python -m pip install strawberryfields


If you are using the ``tensorflow-gpu`` module for TensorFlow GPU support, you can install the following package for GPU support in Strawberry Fields:
::

$ python -m pip install strawberryfields-gpu


Make sure you are using the Python 3 version of pip.

Alternatively, you can install Strawberry Fields from the source code by navigating to the top directory and running
::

python setup.py install
$ python setup.py install


Notebook downloads
Expand All @@ -67,20 +73,20 @@ Software tests
To ensure that Strawberry Fields is working correctly after installation, the test suite can be run by navigating to the source code folder and running
::

make test
$ make test

Note that this runs *all* of the tests, using *all* available backends, so can be quite slow (it should take around 40 minutes to complete). Alternatively, you can run the full test suite for a particular backend by running
::

make test-[backend]
$ make test-[backend]

where ``[backend]`` should be replaced with the :ref:`backend <backends>` you would like to test (``fock``, ``tf``, or ``gaussian``).

Individual test modules are run using

::

python tests/test_gate.py --backend=[backend]
$ python tests/test_gate.py --backend=[backend]


Documentation
Expand All @@ -95,13 +101,13 @@ To build the documentation, the following additional packages are required:
If using Ubuntu, they can be installed via a combination of ``apt`` and ``pip``:
::

sudo apt install graphviz
pip install sphinx --user
pip install sphinxcontrib-bibtex --user
$ sudo apt install graphviz
$ pip install sphinx --user
$ pip install sphinxcontrib-bibtex --user

To build the HTML documentation, go to the top-level directory and run
::

make docs
$ make docs

The documentation can then be found in the :file:`doc/_build/html/` directory.

0 comments on commit 0cfef10

Please sign in to comment.