Installation¶
Installation of PennyLane-SF, as well as all required Python packages, can be installed via pip:
$ python -m pip install pennylane-sf
Make sure you are using the Python 3 version of pip.
Alternatively, you can install PennyLane-SF from the source code by navigating to the top directory and running
$ python setup.py install
Dependencies¶
PennyLane-SF requires the following libraries be installed:
Python >=3.8
as well as the following Python packages:
PennyLane >=0.19, <0.30
StrawberryFields >=0.22
If you currently do not have Python 3 installed, we recommend Anaconda for Python 3, a distributed version of Python packaged for scientific computation.
Software tests¶
To ensure that PennyLane-SF is working correctly after installation, the test suite can be run by navigating to the source code folder and running
$ make test
Documentation¶
To build the HTML documentation, go to the top-level directory and run
$ make docs
The documentation can then be found in the doc/_build/html/ directory.