# API リファレンス

この Part は**公開 `qc` API の地図** — 呼び出す関数・名前空間・アクセサ — を 1 か所にまとめたものです。*厳選*
された（curated）リファレンスです:これまでのチュートリアルとガイドの章が*どう*・*なぜ*を説明し、この Part は
*何*を、参照用に整理して示します。

:::{note} 自動生成ではなく厳選
これらのページは手書きで、どこでもビルドできます（マニュアルの CI はコンパイル済み `qc` 拡張をインポートしません）。
docstring レベルのライブ autodoc が欲しければ、ローカルで（`qc` が入った環境で）`sphinx.ext.autodoc` を有効化し、
この `90-api/` ディレクトリ配下（マニュアルの規則が autodoc を許す唯一の場所）で `{automodule}` をパッケージに
向けられます。ここの厳選リファレンスは公開サーフェスと同期を保っています。
:::

## API の形

すべてはトップレベルの `qc` パッケージにぶら下がり、3 種類に分かれます:

- **ワークフロー動詞** — 計算を構築・実行する関数:`qc.chk.new`、そして `qc.guess`, `qc.ints`, `qc.scf`,
  `qc.lct`, `qc.casscf`/`fci`/`dmrg`/`td`, `qc.grad`, `.opt()`。各々にチェックポイント上の同一の
  **メソッドチェーン**形式（`mychk.scf(...)`）があります。
- **名前空間** — グループ化された機能:`qc.chk`（チェックポイント）、`qc.prop`（14 群の物性スイート）、
  `qc.iop`（オプションレジストリ）、`qc.basis`（基底データ）、`qc.view`（可視化）、加えて低レベルの
  `qc.array` / `qc.mol` / `qc.utils` / `qc.integrals` と任意の `qc.xc` / `qc.pcm`。
- **センチネル** — 何がコンパイルされたかを報告する真偽値:`qc.XC_ENABLED`, `qc.PCM_ENABLED`,
  `qc.MPI_DIRECT_ENABLED`, `qc.GPU_ENABLED`。

[`qc` パッケージリファレンス](qc.md) が各々を記述します。

## ガイドへの相互参照

すべての API 項目は物語形式の章で説明されます — 本リファレンスは繰り返さず、そこへリンクします:

| API | 説明箇所 |
|---|---|
| `qc.chk.new`, `save`/`load`, アクセサ | [チェックポイント](../40-reference/checkpoints.md) |
| `qc.guess` | [初期推定](../20-guide/initial-guess.md) |
| `qc.ints`（`eri=`） | [ERI / J-K 戦略](../30-hpc/eri-jk-strategies.md) |
| `qc.scf`（`ref`/`xc`/`algorithm`/`pcm`） | [SCF](../20-guide/scf.md) |
| `qc.lct`（`method="mp2"`） | [ポスト SCF](../20-guide/post-scf.md) |
| `qc.grad`, `.opt()` | [勾配と構造最適化](../20-guide/gradients-geomopt.md) |
| `qc.prop.<group>.<leaf>` | [分子物性](../20-guide/properties/index.md) |
| `qc.iop` | [IOP リファレンス](../40-reference/iop.md) |
| `qc.basis` | [同梱基底一覧](../40-reference/basis-list.md) |
| `qc.view` / `mychk.view3d` | [可視化](../20-guide/visualization.md) |

全サーフェスは [`qc` パッケージリファレンス](qc.md) へ続きます。