# VASP.pl Documentation

## 1. プログラムの動作

`VASP.pl`は、VASP（Vienna Ab initio Simulation Package）を使用した計算のための補助スクリプトです。このスクリプトは、VASPの入力ファイル（INCAR, POSCAR, KPOINTS, POTCAR）を生成、修正、または解析するためのさまざまな機能を提供します。また、計算結果を解析し、CIFファイルやVESTAファイル、XSFファイルなどの形式に変換することもできます。主な機能は以下の通りです：

- VASP入力ファイルの生成と修正
- CIFファイルからVASP入力ファイルへの変換
- VASP計算結果の解析と出力ファイルの生成
- バンド構造やDOSの解析
- Bader解析結果の要約

## 2. 必要な非標準ライブラリとインストールコマンドとインストール方法

このスクリプトは、以下の非標準Perlモジュールを使用しています：

- `Math::Matrix`
- `Math::MatrixReal`

これらのモジュールはCPANからインストールできます。インストールコマンドは以下の通りです：

```bash
cpan Math::Matrix
cpan Math::MatrixReal
```

## 3. 必要な入力ファイル

`VASP.pl`は、以下の入力ファイルを必要とする場合があります：

- `POSCAR`または`CONTCAR`: 構造情報を含むVASPの入力ファイル
- `INCAR`: 計算パラメータを含むVASPの入力ファイル
- `KPOINTS`: k点情報を含むVASPの入力ファイル
- `POTCAR`: 擬ポテンシャル情報を含むVASPの入力ファイル
- `CIF`ファイル: 結晶構造情報を含むファイル
- `OUTCAR`: VASP計算の出力ファイル
- `DOSCAR`または`PROCAR`: DOS情報を含むVASPの出力ファイル
- `Bader`解析の出力ファイル（`ACF.dat`, `AVF.dat`, `BCF.dat`）

## 4. 実行後に生成される出力ファイル

`VASP.pl`は、以下の出力ファイルを生成することがあります：

- 修正された`INCAR`, `POSCAR`, `KPOINTS`, `POTCAR`ファイル
- CIFファイル（例: `output.cif`）
- VESTAファイル（例: `output.vest`）
- XSFファイル（例: `output.xsf`）
- DOSのCSVファイル（例: `DOS.csv`）
- Bader解析の要約ファイル

## 5. コマンドラインでの使用例 (Usage)

以下に、`VASP.pl`の使用例を示します：

```bash
# CIFファイルからVASP入力ファイルを生成
perl VASP.pl --Action=MakeINCAR input.cif output_dir

# VASPのPOSCARファイルを修正
perl VASP.pl --Action=ModifyPOSCAR --A=5.0 --B=5.0 --C=5.0 POSCAR

# DOSCARファイルからDOSのCSVファイルを生成
perl VASP.pl --Action=MakeDOSCSV DOSCAR DOS.csv

# Bader解析結果を要約
perl VASP.pl --Action=SummarizeBader ACF.dat AVF.dat BCF.dat summary.txt

# VASPの出力ファイルからCIFファイルを生成
perl VASP.pl --Action=MakeCIF output_dir output.cif
```

このスクリプトは、さまざまなオプションを使用して多くの異なるタスクを実行できます。詳細なオプションについては、スクリプト内のコメントやドキュメントを参照してください。