VASPをパワーアップして快適なVASPライフを送りたい ~Anaconda,vise~

0. まえがき

VASPで計算させるまでの準備や、計算結果を分析したりグラフを作成したりなどの作業が、一つのパッケージの中で行えたらどれだけ楽なことか、、、と物思いにふけっていた頃、viseというpythonで提供されているパッケージがあることを知りました。これは使うしかないということで、それの導入方法や活用法を、記録として載せておこうと思います。

目次

1. Anacondaの導入
2. viseのインストール
3. viseを使ってみる
4. ハンズオン（Bi2Se3）
5. あとがき

1. Anacondaの導入

まず、viseを入れる前に、pythonの環境のセットアップをします。仕方は人によって違うと思いますが、ここではコマンドラインからAnacondaを導入する手順について書いておきます。（筆者側の環境の都合で）

こちらの記事に全て書いてありますが、この記事内でも同様の説明を書いておきます。

1-1. インストーラのダウンロード

以下のリンク先に飛んで、使用しているOSに合ったインストーラのリンクのコピーをしてください。

Anacondaの環境を構築したいディレクトリに移動し、先ほどコピーしたリンクを使ってインストーラのダウンロードをします。

command line

curl -O <link>
# <link>の部分をコピーしたリンクで置き換えて実行してください。
# 例 curl -O https://repo.anaconda.com/archive/Anaconda3-2024.02-1-Linux-x86_64.sh

すると、実行したディレクトリ内に、　.shという拡張子のついたファイルがダウンロードされているはずです。それがAnacondaを導入するためのインストーラになり、実行することでAnaconda環境がセットアップされます。

1-2. Anacondaのセットアップ

次にインストーラを実行しましょう。

command line

bash <installer>
# <installer>の部分をインストーラの名前に変えてください
# 例 bash Anaconda3-2021.05-Linux-x86_64.sh

入力待ちの状態になったら、特別カスタマイズしたいことがない限りは、Enterキーかyesと入力指定していけば問題ないと思います。インストールが完了したら、正常に環境構築ができたかどうかをチェックしましょう。

command line

python --version
# python 3.11.7 的なバージョンに関する出力があればOKです。

これでAnacondaの環境を作成することができました。

2. viseのインストール

ようやくここからviseをインストールしていきます。まず、必要なパッケージをインストールしていきます。（もしかしたら、viseをインストールしてしまえばセットでついてくるかも？）

command line

pip install pymatgen spglib seekpath mp-api phonopy

実行し、正常にインストールができたらviseをインストールします

command line

pip install vise

viseが正常にインストールできているかをチェックします。最終行にバージョンに関する情報が書いてあるはずです。

command line

vise -h
# 最終行に Author: Yu Kumagai Version: 0.9.0

3. viseを使ってみる

ここからは実際にviseを使ってできることについて紹介します。詳しくはviseのドキュメントを参照してください

3-1. Materials Projectと連携

まずは、Materials Projectのアカウントと同期させます。

1. 右上の「API」タブをクリックし、以下の画像のような画面を開く
2. 画面左の「API Key」タブをクリックし、アカウント固有のAPIキーを表示させる。（30桁ぐらいの文字列が表示されるはずです）
3. APIキーをコピーしておく。

command line

pmg config --add PMG_MAPI_KEY <MPのAPIキー>
# <MPのAPIキー> の部分にコピーしたAPIキーを貼り付けてください

これをすることで、Materials Projectとの同期が完了し、以下のようなコマンドで直接POSCARをダウンロードすることができるようになったりします。

command line

vise gp -m <物質のキー>
# 例　vise gp -m mp-2857

3-2. 計算用ファイルのセット

vise vs

3-3. バンド図のプロット

計算結果を元にバンド図を作成したい場合、コマンド１つ叩くだけでバンド図のpdfを作成することができます。計算したファイルのディレクトリ内で以下のように実行してください。すると、名前はオプションで変えることができるのですが、何も指定しない場合はband.pdfという名前のファイルが出力されると思います。

command line

vise pb
vise pb -y -20 20    # y軸方向の幅を指定できる 
vise pb -f hoge      # 出力ファイルの名前を hoge.pdf にできる

4. ハンズオン（Bi2Se3）

vise gp -m mp-541837

POSCARファイルができるはず

vise vs -t band

これでバンド図を作成する用のファイル群を生成することができたので、VASPを回して計算しましょう。
それが終わったら、バンド図を生成します。

vise pb

これで、band.pdfというファイルが生成されるはずです。ここにバンド図がプロットされています。

5. あとがき

便利すぎ！！以上！！