インストール

必要環境

  • Python >= 3.9

  • numpy >= 1.22

  • ODAT-SE >= 3.0

  • AENET (predict.x, generate.x, train.x)

トレーニングチュートリアルでは以下も必要です:

ODAT-SE のインストール

PyPI からインストールする場合:

pip3 install odat-se[all]

ソースからインストールする場合:

git clone https://github.com/issp-center-dev/ODAT-SE.git
cd ODAT-SE
pip3 install .[all]

AENET のインストール

AENET(Atomic Energy Network)は機械学習ポテンシャルの構築に使用します。 ビルドには Fortran コンパイラ(gfortran)と LAPACK/BLAS が必要です。

macOS の場合の前準備

gfortran が入っていない場合は Homebrew でインストールします:

brew install gcc

これにより gfortran コマンドが利用可能になります。 macOS では LAPACK/BLAS として Accelerate フレームワークが標準で利用できます。

ソースコードの取得

git clone https://github.com/atomisticnet/aenet.git
cd aenet

L-BFGS-B ライブラリのビルド

AENET 本体のビルド前に、同梱されている L-BFGS-B ライブラリを先にビルドする必要があります:

cd lib
make static
cd ..

lib/liblbfgsb.a が生成されていることを確認してください。

AENET 本体のビルド

src/ ディレクトリで、環境に合った Makefile を指定してビルドします:

cd src
make -f makefiles/Makefile.gfortran_serial_MacOS   # macOS (Apple Silicon / Intel)
cd ..

注釈

Linux 環境の場合は、MPI の有無に応じて以下を選択してください:

  • Makefile.gfortran_serial — シリアル版

  • Makefile.gfortran_mpi — MPI 並列版

  • Makefile.gfortran_openblas_serial — OpenBLAS 利用版

利用可能な Makefile 一覧は src/makefiles/ を参照してください。

ビルドが完了すると bin/ 以下に以下の実行ファイルが生成されます:

  • generate.x — 学習データ(構造記述子)の生成

  • train.x — ニューラルネットワークポテンシャルの学習

  • predict.x — 学習済みポテンシャルによるエネルギー予測

注釈

実行ファイル名にはバージョンとコンパイラのサフィックスが付きます (例: predict.x-2.0.4-gfortran_serial)。 必要に応じてシンボリックリンクを作成してください:

cd bin
ln -s predict.x-2.0.4-gfortran_serial predict.x
ln -s generate.x-2.0.4-gfortran_serial generate.x
ln -s train.x-2.0.4-gfortran_serial train.x

パスの設定:

export PATH=/path/to/aenet/bin:$PATH

動作確認:

generate.x
# "generate.x - training set generation" と表示されれば成功

注釈

詳細は AENET 公式サイト を参照してください。

Quantum ESPRESSO のインストール

Quantum ESPRESSO は第一原理計算エンジンで、トレーニングチュートリアルの構造緩和に使用します。

前準備(macOS)

cmake が必要です:

brew install cmake

ソースからビルド

git clone --depth 1 --branch qe-7.4 https://github.com/QEF/q-e.git qe-7.4
cd qe-7.4

警告

v7.3.1 以前は GCC 15 (gfortran 15) で mbd ライブラリのビルドに失敗します。 v7.4 以降の使用を推奨します。

cmake でビルドを構成します。MPI なし・FFTW 内蔵版の場合:

cmake -B build \
  -DCMAKE_Fortran_COMPILER=gfortran \
  -DCMAKE_C_COMPILER=gcc-15 \
  -DQE_ENABLE_MPI=OFF \
  -DQE_FFTW_VENDOR=Internal

注釈

  • gcc-15 の部分は環境に合わせて変更してください (例: Linux で gcc が GNU の場合はそのまま gcc)。

  • MPI 並列版が必要な場合は -DQE_ENABLE_MPI=OFF を外し、 -DCMAKE_Fortran_COMPILER=mpif90 を指定してください。

  • 外部 FFTW3 がインストール済みの場合は -DQE_FFTW_VENDOR=Internal は不要です。

pw.x のみをビルドする場合:

cmake --build build --target pw -j4

全体をビルドする場合:

cmake --build build -j4

ビルド後、pw.x にパスを通します:

export PATH=/path/to/qe-7.4/build/bin:$PATH

動作確認:

pw.x --version
# "Program PWSCF v.7.4" と表示されれば成功

注釈

odatse-aenet のインストール

git clone https://github.com/k-yoshimi/odatse-aenet.git
cd odatse-aenet
pip3 install .

インストール後、odatse-aenet コマンドが利用可能になります。

動作確認

odatse-aenet --version

バージョン番号が表示されれば、正しくインストールされています。