スタートガイド#

動作環境#

Qamuyを利用するには、以下の環境が必要です。

  • Python (バージョン3.6以上)

  • インターネット接続

環境の確認方法については、Qamuy Client SDK動作環境の確認方法を参照ください。

Qamuy Client SDKのインストール#

Qamuy Client SDKをインストールするには、次のコマンドを実行します。

$ python -m pip install qamuy-client --extra-index-url https://download.qamuy.qunasys.com/simple/

(管理者としてシステムにインストールする権限がない場合には--userオプションをつけてください。)

ユーザー名とパスワードを求められたら、別途ご案内しているものを入力してください。

すでにインストール済みのQamuy Client SDKを更新するには、以下のように -U を付けて実行します。

$ python -m pip install -U qamuy-client --extra-index-url https://download.qamuy.qunasys.com/simple/

なお、以下のような requirements.txt ファイルを作成しておけば、より簡単にインストール・更新を行えるようになります。

# requirements.txt
--extra-index-url https://[ユーザー名]:[パスワード]@download.qamuy.qunasys.com/simple/
qamuy-client

[ユーザー名][パスワード]は別途ご案内しているものに置き換えてください)

# インストール
$ python -m pip install -r requirements.txt

# 更新
$ python -m pip install -U -r requirements.txt

Qamuy Client SDKのアンインストール#

Qamuy Client SDKをアンインストールするには、次のコマンドを実行します。

$ python -m pip uninstall qamuy_data_model qamuy_client qamuy-public-api-protos

ユーザー登録・パスワード設定#

QunaSysにて、お使いのメールアドレスをQamuyに登録いたします。 初回利用の際は、qamuy reset-passwordコマンドでパスワード設定を行ってください。 このコマンドを実行すると、パスワード設定用のメールが送信されます。 メールに記載の内容にしたがって、パスワード設定を行ってください。

$ qamuy reset-password
Email address: [ご登録のメールアドレスを入力]

Qamuyへのログイン#

計算を実行する際には、ご登録のメールアドレスとパスワードでログインする必要があります。 ログインするには、qamuy loginコマンドを実行してください。 メールアドレスとパスワードを聞かれますので、ご登録のメールアドレスとパスワードを入力してください。

$ qamuy login
Email address: [ご登録のメールアドレスを入力]
Password: [設定されたパスワードを入力]

qamuy logoutコマンドで、ログアウトすることができます。

$ qamuy logout

計算の実行#

計算を実行する際は、qamuy runコマンドを使用します。

次のコマンドでinput.jsonに規定された計算がサーバー上で実行されます。

$ qamuy run input.json

次のように-oオプションを指定することで、実行結果をファイルに書き出すこともできます。

$ qamuy run input.json -o output.json

Qamuyの入力ファイルは、YAML形式で作成することもできます。 2つの形式は、データ記述の形式が異なるだけで内容は等価です。 YAML形式で記述された入力ファイルinput.yamlを指定するには

$ qamuy run input.yaml

とします。

Qamuy Client SDKで使用しているソフトウェアのライセンスについて#

Qamuy Client SDKでは、Apache License 2.0で配布されているProto Plus for Python及びPySCFを一部改変して使用しています。