tkcif2pymatgen プログラム仕様
tkCIF.pyで読み込んだtkCrystalオブジェクトからpymatgenのStructureオブジェクトを生成するためのユーティリティモジュールです。
tkCrystalオブジェクトのデータ構造をpymatgenが扱うことができるStructureオブジェクトへと変換する機能を提供します。 これにより、tkCIF.pyで読み込んだ結晶構造データをpymatgenエコシステムで利用できるようになります。
tkcif2pymatgen.py Library Documentation
- tklib.tkcrystal.tkcif2pymatgen.tkcrystal_to_pmg_structure(cry)[ソース]
tkCrystalオブジェクトをpymatgenのStructureオブジェクトに変換します。
tkCIF.pyで読み込んだtkCrystalオブジェクトから、結晶の格子パラメータ、原子の種類、 およびその分率座標を抽出し、pymatgenのStructureオブジェクトとして再構築します。 部分占有率が設定されている原子サイトに対しても適切に対応し、 pymatgenのSpeciesオブジェクト形式で表現します(占有率が1.0に近い場合は元素名、 それ以外の場合は辞書形式 {Element: occupancy})。
- パラメータ:
cry -- tkCIF.pyで読み込まれたtkCrystalオブジェクト。 LatticeParameters()メソッドとAtomSiteList()メソッドを持ち、 それぞれ格子情報と原子サイト情報を提供する必要があります。
- 戻り値:
tkCrystalオブジェクトから生成されたpymatgen.core.Structureオブジェクト。
- 戻り値の型:
pymatgen.core.Structure