Quick Start
===========

Python3環境で Fixstars Amplify を使用するための準備について説明します。

ユーザ登録
----------

イジングマシンの実行環境である Amplify Annealing Engine を使用するために、`無料ユーザ登録 <https://amplify.fixstars.com/register>`_ を行いアクセストークンを入手して下さい。

パッケージのインストール
------------------------

事前に pip のバージョンが 19.3 以上であることを確認して、必要ならアップデートしてください。

.. code-block:: bash

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

環境によって Python3 の `pip` コマンドは `pip3` コマンドで提供されます。その場合は適宜読み替えて下さい。

Amplify SDK は次のコマンドでインストールできます。

.. code-block:: bash

    $ pip install amplify

.. note::

    Windows10/11 では `WSL1/2 (Windows Subsystem for Linux) <https://docs.microsoft.com/ja-jp/windows/wsl/about>`_ 環境にてインストール出来ます。

`D-Wave <https://www.dwavesys.com/>`_ マシンを利用する場合や、 `IBM Quantum <https://quantum-computing.ibm.com/>`_ や `Qulacs <https://github.com/qulacs/qulacs>`_ を用いた `QAOA <https://arxiv.org/abs/1411.4028>`_ ソルバーを実行する場合は、次のようにサードパーティの依存パッケージを含めたインストールが必要です。

.. code-block:: bash

    $ pip install amplify[extra]

.. note::

   Amplify SDK は Apple M1 チップ搭載の Mac OS 向けのパッケージを提供していますが、上記のいくつかの依存パッケージが 2022年6月時点では M1 に非対応となっています。
   そのため INTEL アーキテクチャ互換モードでパッケージのインストールと Python の実行を行ってください。

    .. code-block:: bash

        % arch -x86_64 zsh  # x86_64 で zsh を起動
        % uname -m          # 現在のアーキテクチャを確認
        x86_64
        % pip install amplify[extra]
        % python

パッケージのアップデート
------------------------

次のようにしてパッケージのアップデートを実行できます。

.. code-block:: bash

    $ pip install --upgrade amplify

パッケージのインポート
----------------------

インストールに成功すると Python スクリプト内で下記の様にインポートできます。

.. code-block:: python

    import amplify

>>> amplify.__version__    # Amplify SDK のバージョンを確認
'0.9.1'

以降は :doc:`tutorial` に従うことで Amplify SDK を使用したイジングマシン使用の流れを知ることが出来ます。
Amplify SDK を用いた組合せ最適化問題のチュートリアルやサンプルコードについては `こちら <https://amplify.fixstars.com/demo>`_ を参照して下さい。