kpath_pymatgen.py ドキュメント

概要

kpath_pymatgen.py は、pymatgen ライブラリを用いて結晶構造の高対称k点経路(k-path)を計算し、標準出力に表示するPythonスクリプトです。 入力されたCIFファイルから結晶構造を読み込み、原始構造(primitive structure)に基づいた第一ブリルアンゾーンの経路を自動で生成します。バンド構造計算などの固体物理学における第一原理計算の入力作成を補助することを目的としています。

動作環境と依存ライブラリ

本スクリプトの実行には、以下の環境および非標準ライブラリが必要です。

  • Python実行環境

  • pymatgen (Python Materials Genomics)

コード内の import 文からは標準ライブラリの sys に加え、非標準ライブラリとして pymatgen.core.Structure および pymatgen.symmetry.bandstructure.HighSymmKpath が使用されています。

理論とアルゴリズム

固体物理学において、結晶中の電子の振る舞い(バンド構造)を解析するためには、逆格子空間における第一ブリルアンゾーン内の高対称な点(k点)を結ぶ経路に沿ってエネルギー固有値を評価します。

実格子ベクトル \(\mathbf{a}_1, \mathbf{a}_2, \mathbf{a}_3\) に対して、逆格子ベクトル \(\mathbf{b}_1, \mathbf{b}_2, \mathbf{b}_3\) は以下のように定義されます。

\[\begin{split}\begin{align} \mathbf{b}_1 &= 2\pi \frac{\mathbf{a}_2 \times \mathbf{a}_3}{\mathbf{a}_1 \cdot (\mathbf{a}_2 \times \mathbf{a}_3)} \\ \mathbf{b}_2 &= 2\pi \frac{\mathbf{a}_3 \times \mathbf{a}_1}{\mathbf{a}_1 \cdot (\mathbf{a}_2 \times \mathbf{a}_3)} \\ \mathbf{b}_3 &= 2\pi \frac{\mathbf{a}_1 \times \mathbf{a}_2}{\mathbf{a}_1 \cdot (\mathbf{a}_2 \times \mathbf{a}_3)} \end{align}\end{split}\]

逆格子空間内の任意の波数ベクトル \(\mathbf{k}\) は、各逆格子ベクトルに対する分数座標 \(u, v, w\) を用いて以下のように表現されます。

\[\mathbf{k} = u\mathbf{b}_1 + v\mathbf{b}_2 + w\mathbf{b}_3\]

本スクリプトでは、読み込んだ結晶構造を原始単位格子(primitive cell)に変換した後、Bravais格子の対称性を判定し、標準化された高対称点と経路を導出します。 経路の選定アルゴリズムとして、以下の2つの手法を切り替えることが可能です。

  • Hinuma–Pizzi–Kumagai–Oba–Tanaka (2017) 方式:空間群に基づく最適な経路を提供する比較的新しい標準化手法。

  • Setyawan–Curtarolo (2010) 方式:AFLOWデータベースなどで広く用いられている従来の標準化手法。

コマンドライン引数とオプション

本スクリプトは、コマンドライン引数(sys.argv)を通じて入力ファイルと経路生成アルゴリズムのタイプを指定します。 引数は位置に依存しており、オプションフラグ(例: -i)は使用しません。

  • 第1引数 (sys.argv[1])

    • 入力となる結晶構造ファイルのパスを指定します。

    • デフォルト値: ZnO.cif

  • 第2引数 (sys.argv[2])

    • 使用する高対称k点経路の計算アルゴリズムを指定します。

    • 選択可能な値:

      • hinuma : Hinuma et al. (2017) の定義を使用(デフォルト値)。

      • sc : Setyawan-Curtarolo (2010) の定義を使用。

入出力ファイル仕様

入力ファイル

  • ファイル形式: CIF (Crystallographic Information File) 形式。

  • 内容: 結晶の格子定数および原子座標が記述されたファイル。スクリプト内部の Structure.from_file() 関数によって読み込まれます。

出力仕様

ファイルの出力は行わず、計算結果はすべて標準出力(コンソール)に表示されます。 出力は以下の2つのセクションで構成されます。

  1. k-path 経路: 高対称k点同士を結ぶセグメントのリスト。記号( \(\Gamma\) など)が矢印で結ばれた形式で表示されます。

  2. 高対称点座標: 経路に含まれる各高対称点の名称と、それに対応する逆格子空間内の分数座標 \((u, v, w)\) の一覧。

実行例

引数を省略した場合、デフォルトの ZnO.cif と hinuma の設定で実行されます。

python kpath_pymatgen.py

入力ファイルとして my_structure.cif を指定し、デフォルトの経路タイプで実行する場合の例です。

python kpath_pymatgen.py my_structure.cif

入力ファイルと経路タイプ(Setyawan-Curtarolo方式)の両方を指定する場合の実行例です。

python kpath_pymatgen.py my_structure.cif sc