以下は、`outcar2axsf.py` プログラムの解析に基づくドキュメントです。

---

# outcar2axsf.py ドキュメント

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

`outcar2axsf.py` は、VASP (Vienna Ab initio Simulation Package) のMD (分子動力学) 出力ファイルである `OUTCAR` を読み込み、XCrySDen で使用される AXSF (Animation Structure File) 形式のファイルに変換するプログラムです。このプログラムは、VASP の出力から結晶構造を抽出し、アニメーション用のAXSFファイルを生成します。

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

このプログラムは、以下の非標準ライブラリを使用しています：

- `tkfile`, `tkre`, `tkutils`, `tksci`, `tkcrystal`

これらのライブラリは、一般的なPythonパッケージ管理システム（例：`pip`）ではインストールできない可能性があります。これらはおそらくカスタムライブラリであり、特定のディレクトリに配置されていることを前提としています。`sys.path.append` によって、`c:/Programs/python/lib` および `d:/Programs/python/lib` からインポートされるように設定されています。

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

- `OUTCAR`: VASP の出力ファイルで、分子動力学シミュレーションの結果が含まれています。
- `POSCAR`: 初期結晶構造を含むファイル。
- `CONTCAR`: 最終結晶構造を含むファイル。
- `INCAR`: シミュレーションの設定を含むファイル。

これらのファイルは、指定された `outcar_path` ディレクトリ内に存在する必要があります。

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

- `<sample_name>-initial.cif`: 初期結晶構造を含む CIF ファイル。
- `<sample_name>-final.cif`: 最終結晶構造を含む CIF ファイル。
- `<sample_name>-history.csv`: シミュレーション履歴を含む CSV ファイル。
- `<outcar_path>.xsf`: XCrySDen で使用される AXSF ファイル。

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

```bash
python outcar2axsf.py <outcar_path>
```

- `<outcar_path>`: `OUTCAR` ファイルが存在するディレクトリのパスを指定します。

例:

```bash
python outcar2axsf.py /path/to/vasp/output
```

このコマンドは、指定されたディレクトリ内の VASP 出力ファイルを読み込み、XCrySDen で使用するための AXSF ファイルを生成します。