API リファレンス#
この Part は公開 qc API の地図 — 呼び出す関数・名前空間・アクセサ — を 1 か所にまとめたものです。厳選
された（curated）リファレンスです:これまでのチュートリアルとガイドの章がどう・なぜを説明し、この Part は
何を、参照用に整理して示します。
注釈
自動生成ではなく厳選
これらのページは手書きで、どこでもビルドできます（マニュアルの 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 パッケージリファレンス が各々を記述します。
ガイドへの相互参照#
すべての API 項目は物語形式の章で説明されます — 本リファレンスは繰り返さず、そこへリンクします:
API |
説明箇所 |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
全サーフェスは qc パッケージリファレンス へ続きます。