[日本語](https://ohara-lab-su.github.io/aenet_env/ja/index.html) | [English](https://ohara-lab-su.github.io/aenet_env/en/index.html) | [GitHub](https://github.com/ohara-lab-su/aenet_env)

# 導入と実行環境

## aenet_env

リポジトリのルートで `python -m pip install -e .` を実行します。依存関係は実際の `pyproject.toml` を参照してください。配布スクリプトを作業ディレクトリに展開する場合は `aenet_env-install` を実行します。既存ファイルは既定で保護され、意図して更新するときだけ `aenet_env-install --force` を指定します。実際に利用できるコマンドはインストール済みバージョンで確認してください。

## ænet本体（公式ソースからのビルド）

一般的なCMakeビルド例：

```bash
git clone https://github.com/atomisticnet/aenet.git
cd aenet
cmake -S . -B build -DBUILD_AENET=ON
cmake --build build --target build_all
```

Intel oneAPI Fortran + MKLを使用する環境例（環境固有のコンパイラパス）：

```bash
cd ~/aenet
git clone https://github.com/atomisticnet/aenet.git build_aenet
cd build_aenet
cmake -S . -B build \
  -DCMAKE_Fortran_COMPILER=/opt/intel/oneapi/compiler/2023.2.1/linux/bin/ifx \
  -DUSE_MKL=ON -DBUILD_AENET=ON
cmake --build build --target build_all -j 8
cmake --install build --prefix /home/hpc/aenet
```

このインストール例では `~/aenet/bin/` に `generate.x`, `train.x`, `predict.x`、`~/aenet/tools/` に `fingerprint.x`, `neighbors.x`, `trnset_info.x`, `trnset2ASCII.x` 等が配置されます。**インストール後**に `aenet config --set-aenet-path /home/hpc/aenet` を実行し、ænet Python側の実行ファイル検出・設定を確認してください。`cmake --install build` だけではインストール先が意図したプレフィックスにならない場合があります。

## 追加ツールと前提条件

VASP（別途ライセンスと実行環境が必要）、VASP用PAWデータ、`vasp_util`、ænet Python API、選択した学習方式に応じたPyTorch等が必要です。`b03` は投入先のジョブ管理システムとジョブファイルを要します。独立ænet-PyTorch経路には別途トレーナー、データ変換器、モデル変換器が必要です。**Fortran版、aenet-pythonのTorch経路、独立ænet-PyTorchは同一の実行環境・モデル形式を保証しません。**

## ドキュメントのローカル生成

```bash
python -m pip install -e .
python -m pip install sphinx myst-parser sphinx-rtd-theme linkify-it-py
bash docs/build.sh
```

生成物は `docs/_build/html/en/` と `docs/_build/html/ja/` に分離されます。


関連資料： [v0.0.3 READMEに基づくプロジェクトガイド](project_readme.md)。