AiiDA

注意!!

  1. AiiDAはまだ勉強中なので記述が間違っている可能性あり
  2. 公式のチュートリアルやドキュメントがかなり充実しているのでそちらをよくチェックすること

公式のdoc

公式のtutorials

AiiDA とは？

AiiDAはオープンソースのpythonパッケージで，複雑な計算のワークフローを自動化したり，散らばりがちな計算の入出力結果をまとめて管理してくれる．例えば第一原理計算でバンド計算をやろうと思うと

  1. 結晶構造をどこかから持ってくる
  2. 計算条件を設定，擬ポテンシャルの用意
  3. 結晶構造の最適化計算
  4. scf計算
  5. バンドを計算するパスの設定
  6. バンド計算(nscf計算)

などなど，作業としてはそこそこ面倒くさい．計算条件が適切かどうか（K点メッシュ，エネルギーカットオフなど）の収束計算もやる必要がある． AiiDAを使うとワークフローという自動化の仕組みがあり，これらの一連の流れを自動で行なってくれるだけでなく，結果もデータベースに格納してくれて後からあの時の計算の条件どうだったっけ？ などとあちこちディレクトリを探し回る必要もない．

またssh接続可能なリモートマシン上でも計算を実行できるので，AiiDAを自分のデスクトップやラップトップに入れておいて複数の計算機サーバーなどと連携しながらデータの解析はローカルで行うということが可能である．

AiiDA installation

AiiDAは3つの核となる要素からなる．

  1. aiida-core: pythonパッケージとverdiコマンド
  2. PostgreSQL: AiiDAがデータを保存するために利用する
  3. RabbitMQ: AiiDAとの通信で使うメッセージブローカー

今回はこのうち2と3をシステムに，1をcondaの仮想環境にインストールする．これは公式ではsystem-wide installationと呼ばれている．

# postgreSQLとRabbitMQのinstall
brew install postgresql rabbitmq git python

# データベースの起動
brew services start postgresql
brew services start rabbitmq

注意!! rabbitmqのversionがv3.8.15以上の場合，少し設定をいじる必要がある． https://www.rabbitmq.com/configure.html#config-location を参考にrabbitmqのconfigファイルの場所を探す．macでhomebrewで入れた場合は

/opt/homebrew/etc/rabbitmq/

にある．デフォルトではrabbitmq-env.confファイルしかなかったので同じディレクトリにrabbitmq.confファイルを作成し，

consumer_timeout = 36000000000 # 10,000 hours in milliseconds

と書き込む．この設定をやってからrabbimqを起動しよう．

ついでaiida-coreをcondaの仮想環境内にインストールする．2022/08現在，M1macではcondaを使ったinstallが失敗（circusパッケージが見つからないというエラーが出る）したのでpipを使ってインストールした．conda仮想環境内でpipを利用する際の常として，仮想環境内にインストールされたpythonに付属のpipを利用すること．この場合だと/人による/anaconda3/envs/aiida/bin/pipのpipをちゃんと使っているかを確かめよう．

# intel macの場合
conda create -yn aiida 
conda install -c conda-forge aiida-core
conda activate aiida

# M1 macの場合
conda create -yn aiida 
curl https://bootstrap.pypa.io/get-pip.py -o get-pip.py
python get-pip.py
pip install aiida-core

最後にwhich verdiとして仮想環境下にverdiがインストールされているか確認し，verdi --versionでインストールされているversionを確認しておこう．これでインストールは成功である．

AiiDAのプロファイル設定

無事インストールが終わったらAiiDAのプロファイルを設定する．

$ verdi quicksetup                                   
/opt/homebrew/lib/python3.10/site-packages/aiida/manage/configuration/settings.py:59: UserWarning: Creating AiiDA configuration folder `/Users/amano/.aiida`.
  warnings.warn(f'Creating AiiDA configuration folder `{path}`.')
Report: enter ? for help.
Report: enter ! to ignore the default and set no value.
Profile name [quicksetup]: hoge
Email Address (for sharing data) [()]: example@com
First name [()]: hoge
Last name [()]: hoge
Institution [()]: hoge
Success: created new profile `hoge`.
Report: initialising the profile storage.
Report: initialising empty storage schema
Success: storage initialisation completed.

ついでverdi daemonを起動する．

verdi daemon start 2

最後にセットアップがうまく行っているかを確認する．

$ verdi status
 ✔ version:     AiiDA v2.0.3
 ✔ config:      /Users/amano/.aiida
 ✔ profile:     ta
 ✔ storage:     Storage for 'home' [open] ****
 file://**
Warning: RabbitMQ v3.10.7 is not supported and will cause unexpected problems!
Warning: It can cause long-running workflows to crash and jobs to be submitted multiple times.
Warning: See https://github.com/aiidateam/aiida-core/wiki/RabbitMQ-version-to-use for details.
 rabbitmq:    Incompatible RabbitMQ version detected! Connected to RabbitMQ v3.10.7 as amqp://guest:guest@127.0.0.1:5672?heartbeat=600
 ✔ daemon:      Daemon is running as PID 99029 since 2022-08-13 16:08:36

rabbitmqに関するwarningが出ているが上でconfファイルをいじっていれば問題ない．

optional installation

必須ではないがあると便利なパッケージを同じ仮想環境内にインストールしておく．

# 計算結果のワークフローを可視化してくれる
conda install graphviz

# 言わずと知れた物質計算御用達のpythonパッケージ．AiiDAと相互に結晶構造のやり取りができる．
conda install ase
conda install pymatgen

# aseの構造を可視化してくれるパッケージ.
conda install nglview

# aiida rest apiを起動するのに必要だった
pip install flask_cors
pip install flask_restful

その他あると便利なソフトウェア．

# バンド図を可視化する際に使う場合がある
brew install grace

tutorials, usage

自分の勉強で利用したチュートリアルやusageをいくつかリストアップ．

細かい設定あれこれ

  • コマンドの自動補完

    verdiコマンドの補完の設定が可能．非常に便利なので設定推奨．AiiDAをconda環境内にインストールした場合，.zshrcに設定を書くわけにいかないのでcondaのenvironmentファイルに書くことになる．設定ファイルに書いたら仮想環境を再起動することで自動補完が有効になる．

    # 仮想環境起動
conda activate aiida

# 仮想環境内に設定ファイルを作成
cd $CONDA_PREFIX
mkdir -p ./etc/conda/activate.d
mkdir -p ./etc/conda/deactivate.d
touch ./etc/conda/activate.d/env_vars.sh
touch ./etc/conda/deactivate.d/env_vars.sh

# 設定ファイル./etc/conda/activate.d/env_vars.shに以下の自動保管のためのコマンドを書き込み
eval "$(_VERDI_COMPLETE=zsh_source verdi)"

  • [複数プロファイルの設定]

    全く別のプロジェクトAとプロジェクトBがあってどちらもAiiDAで計算を実行したい場合，AとBのデータが入り乱れてデータベースがぐちゃぐちゃになることが予想できる．これを避ける一つの方法としてAとB用に別々のプロファイルを作成してデータベースを分けるという方法がある．

REST API

https://aiida-tutorials.readthedocs.io/en/tutorial-qe-short/source/sections/qe.html#from-calculations-to-workflows https://www.materialscloud.org/explore/connect

エラー類

エラー類