汎用グラフニューラルネットワーク力場を使うための設定¶
オープンソースの汎用グラフニューラルネットワーク(GNN)力場はPythonで開発されており、Python環境側の設定・インストールは事前に行っていただく必要があります。
NanoLaboに同梱されているLAMMPSからPython環境の各力場パッケージを呼び出し、計算を実行します。
Python環境の準備¶
実際に計算を行うマシン（計算サーバーにジョブ投入する場合には、その計算サーバー上）でインストールを行ってください。
conda環境の用意
Python環境としてcondaを使用します。現在condaをお使いでない場合は、必要最小限の構成であるMinicondaを推奨します。
Minicondaのページから Python 3.11 のインストーラーをダウンロードし、インストールしてください。
Windowsで環境変数
PATHを変更しない設定でインストールした場合、以降の作業はスタートメニューからAnaconda Promptを起動して行ってください。インターネット接続にプロキシが必要な場合は、環境変数の設定等を適宜行ってください。
Windows・認証なしの例¶set HTTP_PROXY=http://host:port set HTTPS_PROXY=http://host:port
Linux・認証ありの例¶export HTTP_PROXY=http://user:pass@host:port export HTTPS_PROXY=http://user:pass@host:port
仮想環境の作成と操作
力場パッケージの依存関係により、同じPython環境に複数の力場パッケージをインストールできないことがあります。condaで仮想環境を作ることにより、別々の環境に力場パッケージをインストールすることができるようになります。
GPUを使う場合
各GNN力場はPyTorchを使って実装されており、GPU版PyTorchを使うことで計算を高速化することができます。
NVIDIAドライバがインストールされていない場合は、あらかじめインストールしてください。
GPUを使う場合のインストール方法は各パッケージのドキュメントで指定されている場合もありますが、説明がない場合は、力場パッケージをインストールする前に（仮想環境を使う場合は力場パッケージと同じ仮想環境に）PyTorchのGPU版をインストールします。最新版は Get Started 、そうでない場合は Previous Versions を参照し、CUDAバージョンに合わせたインストールコマンドを実行してください。PyTorchのバージョンは力場パッケージによって指定されている場合がありますので、それに従ってください。
インストール後、GPUが利用可能になっているかどうかPythonの対話環境で確認できます。
python >>> import torch >>> print(torch.cuda.is_available()) #GPU使用可否 True >>> exit() #Python環境終了
DFT-D3補正を使う場合
（仮想環境を使う場合は力場パッケージと同じ仮想環境に）torch-dftdパッケージをインストールしてください。
pip install torch-dftd
各力場パッケージのインストール¶
ヒント
各パッケージは継続的に更新されており、このページで説明するインストール手順は最新でない場合があります。インストール・実行がうまくいかない場合は元のインストール手順もご参照ください。
MatGL
（仮想環境を使う場合は仮想環境に入ってから）次のコマンドを実行してください。
GPUを使う場合¶pip install torch==2.2.0 --index-url https://download.pytorch.org/whl/cu121 pip install dgl -f https://data.dgl.ai/wheels/cu121/repo.html pip install dglgo -f https://data.dgl.ai/wheels-test/repo.html
pip install matglCHGNet
MACE
Orb
（仮想環境を使う場合は仮想環境に入ってから）次のコマンドを実行してください。
pip install orb-models大きい系（周期境界条件の場合5000原子以上）のシミュレーションにはcuML（GPU使用）をインストールすることが推奨されています。
pip install --extra-index-url=https://pypi.nvidia.com "cuml-cu11==25.2.*" # For cuda versions >=11.4, <11.8 pip install --extra-index-url=https://pypi.nvidia.com "cuml-cu12==25.2.*" # For cuda versions >=12.0, <13.0
MatterSim
FAIR-Chem
FAIR-Chemでは、環境ファイルから仮想環境を作成するインストール手順が示されています。 実行するとfair-chemという名前の仮想環境が作成されます。
GPUを使う場合¶curl -O https://raw.githubusercontent.com/FAIR-Chem/fairchem/main/packages/env.gpu.yml # CUDAバージョンを変える場合はpytorch-cudaのバージョンを編集 conda env create -f env.gpu.yml
GPUを使わない場合¶curl -O https://raw.githubusercontent.com/FAIR-Chem/fairchem/main/packages/env.cpu.yml conda env create -f env.cpu.yml
Open Materialsの学習済みモデル（モデル名にOMatを含むもの）はHugging Faceのアカウント作成と使用条件への同意が必要です。fairchem/OMAT24を参照してください。ダウンロードしたチェックポイントファイルをNanoLaboインストール先の
gnnp/fairchem-omat24フォルダに配置してください。
NanoLaboへの設定¶
ローカル（NanoLaboを使っているマシン）で実行する場合
画面左上のアイコン
から （またはForce Field設定画面の 
ボタン）でpython実行ファイルのパスを設定します。Windowsでは
condaのインストール先\python.exe、Linux・macOSではcondaのインストール先/bin/pythonにあります。また、仮想環境にインストールした場合、Windowsでは
condaのインストール先\envs\仮想環境名\python.exe、Linux・macOSではcondaのインストール先/envs/仮想環境名/bin/pythonを設定してください。リモート（計算サーバー等）で実行する場合
LD_LIBRARY_PATHにPython環境のlibフォルダを追加する必要があります。以下のフォルダはNanoLaboによって自動的にジョブスクリプトに追加されます。※仮想環境名の部分は力場の設定に応じたものが入ります。
${HOME}/miniconda3/lib`${HOME}/anaconda3/lib${HOME}/miniconda3/envs/{m3gnet,chgnet,mace,orb,mattersim,fairchem}/lib${HOME}/anaconda3/envs/{m3gnet,chgnet,mace,orb,mattersim,fairchem}/lib
他の場所にインストールした場合は、画面左上のアイコン
から を開き、ジョブスクリプトに LD_LIBRARY_PATHを追加してください。export LD_LIBRARY_PATH=(condaのインストール先)/lib:$LD_LIBRARY_PATH仮想環境にインストールした場合¶export LD_LIBRARY_PATH=(condaのインストール先)/envs/(仮想環境名)/lib:$LD_LIBRARY_PATH
モデルファイルのインポート¶
ファインチューニングしたモデルや第三者の配布モデルを使う場合など、 Model リストボックスにないモデルを使いたい場合は、画面左上のアイコン から でモデルファイルをインポートしてください。インポートしたモデルは Model リストボックスに追加され、選択できるようになります。
実行時のエラー¶
MatGLで、実行時に次のようなエラーが出る場合があります。
ValueError: No valid model found in pre-trained_models at https://github.com/materialsvirtuallab/matgl/raw/main/pretrained_models/.これは実行に必要な学習済みのモデルデータが存在しないというメッセージです。m3gnetパッケージにはモデルデータが含まれていないため、初回実行時にダウンロードを試みますが、インターネット接続に問題があると実行できません。
代替として、モデルデータを手動でダウンロードすることもできます。matglのリポジトリに各モデル名のフォルダがありますので、使用するモデルのファイルをダウンロードし、
(ホームディレクトリ)/.cache/matgl/(モデル名)に保存してください。
Windowsで、実行時に次のようなエラーが出る場合があります。
OMP: Error #15: Initializing libiomp5md.dll, but found libiomp5md.dll already initialized.この場合、
(condaのインストール先)\Library\bin\libiomp5md.dllをリネーム（例：libiomp5md.dll_）してください。
DFT-D3を有効にして実行した時に次のようなエラーが出る場合があります。
version `GOMP_5.0' not foundこの場合、次の環境変数を設定してください。
export LD_PRELOAD=(condaのインストール先)/lib/libgomp.so
WindowsでGPUを使った場合、次のようなエラーで実行できない場合があります。
FileNotFoundError: Could not find module 'C:\Program Files\NVIDIA Corporation\NVSMI\nvml.dll' (or one of its dependencies). Try using the full path with constructor syntax.pynvml.NVMLError_LibraryNotFound: NVML Shared Library Not Foundこの場合、
C:\Windows\System32\nvml.dllをC:\Program Files\NVIDIA Corporation\NVSMI\nvml.dllにコピー（フォルダがない場合は作成）してから実行してみてください。
pymatgen 2024.8.9以降で、実行時に次のようなエラーが出る場合があります。
ValueError: Buffer dtype mismatch, expected 'const int64_t' but got 'long'ValueError: Buffer dtype mismatch, expected 'const long' but got 'long long'この場合、pymatgenのバージョンを下げることで改善する可能性があります。
pip install -U pymatgen==2024.7.18
LAMMPSを直接実行する場合¶
NanoLaboを使わず、LAMMPS単体で実行する場合の説明です。
NanoLabo Tool同梱の実行ファイル lammps_gnnp を使用します。
MPI並列計算には非対応です。力場によっては、ビリアル応力の計算（NPT・NPHアンサンブル、セル最適化）に非対応のものがあります。
環境変数の設定¶
実行時にPythonの動的ライブラリを使用しますので、Linux・macOSでは環境変数 LD_LIBRARY_PATH 、Windowsでは環境変数 PATH を設定してください。
LinuxではOpenMPIの動的ライブラリが必要ですので、こちらも LD_LIBRARY_PATH に設定してください。
$ export LD_LIBRARY_PATH=(condaのインストール先)/envs/(仮想環境名)/lib:(NanoLabo Toolのインストール先)/exec.LINUX/mpi/lib:$LD_LIBRARY_PATH
> set PATH=(condaのインストール先)/envs/(仮想環境名);%PATH%
また、Linuxでは環境変数 OPAL_PREFIX を設定してください。
$ export OPAL_PREFIX=/opt/AdvanceSoft/NanoLabo/exec.LINUX/mpi
LAMMPSから gnnp_driver.py を呼び出すことで動作しますので、NanoLabo Toolインストール先の gnnp フォルダをPythonのモジュール検索パスに追加してください。例えば、環境変数 PYTHONPATH に追加します。
$ export PYTHONPATH=(NanoLabo Toolのインストール先)/gnnp:$PYTHONPATH
入力ファイルの設定¶
単位系は
units metalを設定してください。X, Y, Z方向とも周期境界条件にしてください。
以下のように
pair_styleを設定します。
pair_style gnnp
pair_coeff * * <gnnptype> <modelname> <元素名1 元素名2 ...> # モデル名を指定する例
pair_style gnnp/d3
pair_coeff * * <gnnptype> path <modelfile> <元素名1 元素名2 ...> # モデルファイルを指定する例
pair_style gnnp/gpu
pair_coeff * * <gnnptype> <modelname> <元素名1 元素名2 ...>
pair_style gnnp/d3/gpu
pair_coeff * * <gnnptype> <modelname> <元素名1 元素名2 ...>
パラメーター
元素名
LAMMPSのatom type毎に、対応する元素名を列挙
使用可能な学習済みモデルの名前
各力場の更新により、使用可能なモデルが追加・削除される場合があります。最新のリストは各力場のドキュメント・GitHubリポジトリをご確認ください。
*:sup
gnnp_driver.pyのあるフォルダ/mace-osaka24にあるモデルファイルを読み込みます。**
gnnp_driver.pyのあるフォルダ/fairchem-omat24にあるモデルファイルを読み込みます。ファイルの入手にはHugging Faceのアカウント作成と使用条件への同意が必要です。fairchem/OMAT24を参照してください。
ヒント
次のようなエラーで実行できない場合があります。
Fatal Python error: init_fs_encoding: failed to get the Python codec of the filesystem encoding
Python runtime state: core initialized
ModuleNotFoundError: No module named 'encodings'
この場合、環境変数 PYTHONHOME が正しく設定されているかご確認ください。
set PYTHONHOME=(condaのインストール先)/envs/(仮想環境名)