CrySPY 1.3.0 or later

CrySPY

pip

pip install csp-cryspy

PyPIではcryspyではなく，csp-cryspyという名前なので注意． pipでインストールすると，実行スクリプトのcryspyが自動的にPATHが通ったところにインストールされる． 下記コマンドでチェックできる．

which cryspy

編集可能モード

CrySPYのソースコードを編集したい時は，pipの編集可能モード（-e オプション）を使うのが便利．

git clone https://github.com/Tomoki-YAMASHITA/CrySPY.git
pip install -e ./CrySPY

git cloneの代わりに，release pageから圧縮ファイルをダウンロードしてもよい．

PHYSBO and DScribe (option)

ベイズ最適化を使う場合は， PHYSBOと DScribeが必要．

pip3 install physbo dscribe

CrySPY 1.0.0 -- 1.2.5

CrySPY

pip

CrySPY 1.0.0以降はpipを使ってインストール可能になった．

pip install csp-cryspy

pipでインストールすると，実行スクリプトのcryspyが自動的にPATHが通ったところにインストールされる． 下記コマンドでチェックできる．

which cryspy

編集可能モード

CrySPYのソースコードを編集したい時は，pipの編集可能モード（-e オプション）を使うのが便利．

git clone https://github.com/Tomoki-YAMASHITA/CrySPY.git
pip install -e ./CrySPY

git cloneの代わりに，release pageから圧縮ファイルをダウンロードしてもよい．

cal_fingerprint (optional)

cal_fingerprintプログラムは構造記述子を計算するためのもので，アルゴリズにベイズ最適化を使う場合は必須． CrySPY 1.0.0からはcal_fingerprintプログラムはCrySPY utilityに含まれている． コンパイルについてはこちらを参照：Instllation/CrySPY_utility/Compile cal_fingerprint．

実行ファイルcal_fingerprintをPATHが通ったところに置く，もしくは下記のようにcryspy.inで実行ファイルのpathを指定する．

[BO]
fppath = /xxx/xxx/xxx/cal_fingerprint

Arm64 on MacOS (without Rosseta 2)

1. miniforge3をインストール（homebrew pythonでpyshtoolsをインストールする方法が今のところ不明）
2. condaでpymatgen，pyshtoolsをインストール（最近のバージョンのpyshtoolsはconda-forgeからインストール可能になった）

conda install pymatgen
conda install pyshtools

3. CrySPYをインストール

pip3 install csp-cryspy

CrySPY 0.10.3 or earlier

CrySPYのインストールはシンプルで，ダウンロードするだけで良い．

ダウンロード

CrySPYは任意の場所に置いて良い．ここでは例として~/CrySPY_root/CrySPY-x.x.x (x.x.x はバージョン番号)にダウンロードすることにする． gitコマンドを使うか，リリースページから圧縮ファイルをダウンロードする．

Git

mkdir ~/CrySPY_root
cd ~/CrySPY_root
git clone https://github.com/Tomoki-YAMASHITA/CrySPY.git CrySPY-x.x.x

zip or tar.gz file

zip または tar.gz ファイルをここからダウンロードする． GitHub release .
ダウンロードして展開したソースを~/CrySPY_root/CrySPY-x.x.xに置く．

ディレクトリ構成

~/CrySPY_root/CrySPY-x.x.x/のディレクトリ構成:

CrySPY-x.x.x
├── CHANGELOG.md
├── CrySPY/
│   ├── BO/
│   ├── EA/
│   ├── IO/
│   ├── LAQA/
│   ├── RS/
│   ├── __init__.py
│   ├── calc_dscrpt/
│   ├── f-fingerprint/
│   ├── find_wy/
│   ├── gen_struc/
│   ├── interface/
│   ├── job/
│   └── start/
│   └── utility.py
├── LICENSE
├── README.md
├── cryspy.py
├── docs/
├── example/
└── utility/

セットアップ (オプション)

find_wy (オプション)

find_wyを使う時は，find_wyの実行ファイルを（例えば）~/CrySPY_root/CrySPY-x.x.x/CrySPY/find_wy/以下に置く必要がある． つまり~/CrySPY_root/CrySPY-x.x.x/CrySPY/find_wy/find_wy.

cd ~/CrySPY_root/CrySPY-x.x.x/CrySPY/find_wy
cp ~/local/find_wy/find_wy .

cal_fingerprintのコンパイル (オプション)

ベイズ最適化を使う場合は，構造の記述子を計算するためのプログラムであるcal_fingerpirntをコンパイルする必要がある．

cd ~/CrySPY_root/x.x.x/CrySPY/f-fingerprint
emacs Makefile
make

cal_fingerprintの実行ファイルが例えば~/CrySPY_root/x.x.x/CrySPY/f-fingerprint/以下にあるようにする． コンパイルすれば自動的にそうなるはず．