matlantis-featuresとは

はじめに#

matlantis-features では、さまざまな物性値を計算するための高度な関数、 Features を提供しています。

matlantis-features を用いることで、短くシンプルなコードで物性値を計算することができます。
皆さんが計算アルゴリズムの詳細に精通していなくても使用でき、複雑な実装も必要ありません。

Launcherの Examples 内で matlantis-features の実用例を紹介しているのでご参照ください。

Features#

Features は、その処理内容からcalculation featuresとpost-calculation featuresの2種類に分類できます。
calculation featuresは内部的にPFP API serverを呼び出し、PFPから出力されたenergy、force、stressなどの値を用いて原子シミュレーションを行います。
MDFeatures などがこれに該当します。

一方、post-calculation featuresは計算後の結果を分析するための Features であり、内部でのPFP API serverの呼び出しはありません。

名前が Complex から始まる Features は、いくつかの Features を複合させたものです。
たとえば、 ComplexElasticFeature は FireASEOptFeature、 ElasticFeature および PostElasticPropertiesFeature を複合させた Feature です。

matlantis-features はさまざまな物性値やシミュレーション手法をカバーしています。
matlantis-features で実装されている Features および取得できる物性値は以下の表の通りです。

ASEとの関係#

Atomic Simulation Environment (ASE) は原子シミュレーションにおいて広く使われているパッケージです。
matlantis-features は内部的にASEに依存している箇所はあるものの、多くの相違点があります。

• 設計思想:

  • ASEは様々なシミュレーション手法の呼び出しを重視して設計されていますが、 matlantis-features は物性値を求めることを重視して設計されています。

• Calculator:

  • ASEは任意のcalculatorをセットできますが、 matlantis-features はPFP calculator専用に設計されています。

• コーディングスタイル:

  • matlantis-features は深層学習ライブラリ風のコーディングスタイルを採用しています。
    ASEでは物性値を計算するたびに Atoms インスタンスを作成する必要がありますが、
    matlantis-features では1つの Atoms インスタンスに対して複数の物理量を計算することができ、
    ハイスループット計算に適しています。

    • ASEの場合:

      dynamics = Dynamics(atoms)
      result = dynamics()
      

    • matlantis-features の場合:

      feature = Feature()
      result = feature(atoms)
      

  • matlantis-features では、複雑なタスクをこなしたいときなどに独自のfeatureを定義することができます。
    以下に、大量の候補物質に対しスクリーニングすることを想定した独自featureを定義する例を示します。

    # featureの定義: 構造最適化を行った後、弾性特性および熱化学特性を計算します。
    class MyTaskFeature(FeatureBase):
        def __init__(self):
            super().__init__()
            with self.init_scope():
                self.optimization = FireASEOptFeature()
                self.elastic_tensor = ElasticTensorFeature()
                self.elasticity = PostElasticPropertiesFeature()
                self.force_constant = ForceConstantFeature()
                self.thermal = PostPhononThermochemistryFeature()
        def __call__(self, input_atoms):
            opt_result = self.optimization(input_atoms)
            elastic_tensor_result = self.elastic_tensor(opt_result.atoms)
            elasticity_result = self.elasticity(elastic_tensor_result)
            force_constant_result = self.force_constant(opt_result.atoms)
            thermal_result = self.thermal(force_constant_result)
            return opt_result, elastic_tensor_result, 
                elasticity_result, force_constant_result, thermal_result
    
    # 独自定義したfeatureの初期化
    my_task_feature = MyTaskFeature()
    
    # 独自定義したfeatureを用いて、候補物質に対してハイスループット計算を実行
    results = [my_task_feature(atoms) for atoms in material_list]
    

matlantis-featuresで使われるestimatorの設定方法#

matlantis-featuresで使われるestimatorの設定(PFPの計算モードやモデルバージョンなど)は変更可能です。
環境変数を用いる方法と estimator_fn オプションを指定する方法があります。

from ase.build import molecule
import os
from pfp_api_client.pfp.estimator import Estimator
from pfp_api_client.utils.messages import MessageEnum

from matlantis_features.features.common.opt import FireASEOptFeature

import os
os.environ["MATLANTIS_PFP_MODEL_VERSION"] = "v2.0.0"
os.environ["MATLANTIS_PFP_CALC_MODE"] = "crystal_plus_d3"

atoms = molecule("CH3OH")

opt = FireASEOptFeature()
result = opt(atoms)

from ase.build import molecule

from pfp_api_client.pfp.estimator import EstimatorCalcMode

from matlantis_features.features.common.opt import FireASEOptFeature
from matlantis_features.utils.calculators import pfp_estimator_fn


atoms = molecule("CH3OH")

opt = FireASEOptFeature(
    estimator_fn=pfp_estimator_fn(
        model_version="v2.0.0",
        calc_mode=EstimatorCalcMode.CRYSTAL_PLUS_D3,
    ),
)
result = opt(atoms)

from ase.build import molecule
from pfp_api_client.pfp.estimator import Estimator, EstimatorCalcMode
from pfp_api_client.utils.messages import MessageEnum

from matlantis_features.features.common.opt import FireASEOptFeature


def estimator_fn() -> Estimator:
    # change the model version.
    estimator = Estimator(
        model_version="v2.0.0",
        calc_mode=EstimatorCalcMode.CRYSTAL_PLUS_D3,
    )

    # disable the specific type of warning.
    estimator.set_message_status(
        message=MessageEnum.ExperimentalElementWarning,
        message_enable=False,
    )

    return estimator

atoms = molecule("CH3OH")
opt = FireASEOptFeature(estimator_fn=estimator_fn)
result = opt(atoms)

def estimator_fn() -> Estimator:
    return Estimator()

estimator = Estimator()

def estimator_fn() -> Estimator:
    return estimator

Index#