インストール

実行環境・必要なパッケージ

  • python 3.9 以上
    • 必要なpythonパッケージ
      • toml
      • numpy (1.17 以上)
    • Optional なパッケージ
      • mpi4py (グリッド探索, モンテカルロ法利用時)
      • scipy (Nelder-Mead法利用時)
      • physbo (ベイズ最適化法利用時, ver. 2.0以上)

インストール

  • PyPI からのインストール(推奨)
$ python3 -m pip install -U ODAT-SE

# 全オプション機能をまとめて入れる場合
$ python3 -m pip install -U "ODAT-SE[all]"
# アルゴリズム別 extras
$ python3 -m pip install -U "ODAT-SE[min-search]" # グリッド探索
$ python3 -m pip install -U "ODAT-SE[exchange]" # レプリカ交換モンテカルロ
$ python3 -m pip install -U "ODAT-SE[bayes]" # ベイズ最適化

# ユーザーローカルにインストールする場合
$ python3 -m pip install --user -U ODAT-SE
  • ソースコードからのインストール(開発者むけ)
$ python3 -m pip install -U pip
$ git clone https://github.com/issp-center-dev/ODAT-SE.git
$ cd ODAT-SE
$ python3 -m pip install .
  • ODAT-SE-template のインストール
$ git clone https://github.com/issp-center-dev/ODAT-SE-template.git
cd ODAT-SE-template
$ python3 -m pip install . 

実行方法

  • ドライバスクリプト odat-se を使う場合:
$ odat-se input.toml
  • Python モジュールとして直接実行する場合:
$ python3 -m odatse_main input.toml

 

入力ファイル input.toml の仕様については マニュアルの入力ファイルを参照してください。

アンインストール

$ python3 -m pip uninstall ODAT-SE
$ python3 -m pip uninstall ODAT-SE-template

東京大学物性研究所 ソフトウェア開発・高度化プロジェクト
Project for advancement of software usability in materials science(PASUMS)