Quick Start

This section explains how to prepare for using Fixstars Amplify in a Python 3 environment.

User registration

To use the Amplify Annealing Engine, an execution environment for Ising machines, please register as a free user and obtain an access token.

Module installation

Please make sure you have pip version 19.3 or higher beforehand, and update it if necessary.

$ pip --version
pip 18.1.1
$ pip install --upgrade pip
...
Successfully installed pip-20.1.1

In some environments, the Python3 pip command is provided as the pip3 command. If this is the case, please replace it accordingly.

The Amplify SDK can be installed with the following command:

$ pip install amplify

Note

On Windows 10, it can be installed in the WSL1/2 (Windows Subsystem for Linux) environment.

If you are using the D-Wave machines, you will need to install the dwave-system module. The packages with third party dependency can also be installed at the same time as follows:

$ pip install amplify[extra]

Update module

You can perform a module update in the following way:

$ pip install --upgrade amplify

Import module

If the installation is successful, a module can be imported in your Python script as shown below:

import amplify

You can follow the Tutorial to learn how to use Ising machines with Amplify SDK. For the tutorials and sample code for combinatorial optimization problems using the Amplify SDK, see here.