# DoVASP.sh Documentation

## 1. プログラムの動作
`DoVASP.sh`は、VASP（Vienna Ab initio Simulation Package）を用いた計算を自動化するためのBashスクリプトです。このスクリプトは、電子構造計算やフォノン計算、バンド構造計算、密度状態（DOS）計算など、さまざまな計算タスクを実行するための設定を行い、必要な入力ファイルを生成し、計算を実行します。また、計算結果を整理し、必要に応じてメール通知を行います。

## 2. 必要な非標準ライブラリとインストールコマンドとインストール方法
このスクリプトは、以下の非標準ライブラリやツールを使用します。

- **VASP**: VASPは商用の第一原理計算ソフトウェアであり、ライセンスが必要です。インストール方法はVASPの公式ドキュメントを参照してください。
- **Phonopy**: フォノン計算を行うためのPythonベースのツール。
  - インストールコマンド: `pip install phonopy`
- **Bader**: 電子密度解析ツール。
  - インストール方法: [Baderの公式サイト](http://theory.cm.utexas.edu/henkelman/code/bader/)からダウンロードし、コンパイルしてください。
- **Perl**: スクリプト内でPerlスクリプトを呼び出すために使用。
  - インストールコマンド: `sudo apt-get install perl`（Debian系の場合）
- **Python**: 一部のスクリプトでPythonを使用。
  - インストールコマンド: `sudo apt-get install python`（Python 2.xの場合）

## 3. 必要な入力ファイル
- **CIFファイル**: 結晶構造情報を含むファイル。`CIFFile`変数で指定。
- **INCAR, KPOINTS, POSCAR, POTCAR**: VASPの入力ファイル。
- **hosts**: MPI実行時のホスト情報を含むファイル。

## 4. 実行後に生成される出力ファイル
- **OUTCAR, CONTCAR, DOSCAR, EIGENVAL**: VASPの出力ファイル。
- **Summarize.txt, Summarize-SpinPolarized.txt**: 計算結果の要約。
- **各種CSVファイル**: DOSやバンド構造のデータ。
- **HTMLファイル**: 計算結果のHTML形式の要約。

## 5. コマンドラインでの使用例 (Usage)
```bash
# 初期化: CIFファイルから入力ファイルを生成
./DoVASP.sh init

# 計算結果を削除して初期状態に戻す
./DoVASP.sh scratch

# CIFファイルからスーパーセルを生成
./DoVASP.sh super CIF_FileName nx ny nz

# ヘルプを表示
./DoVASP.sh help
```

このスクリプトは、特定の計算タスクを実行するために、スクリプト内の設定を変更する必要があります。特に、メール通知や並列計算の設定は、ユーザーの環境に合わせて調整してください。