Skip to main content

CHIROpy is a Gaussian binding tool for analyze chiroptical properties.

Project description

CHIROpy

Gaussian TD-DFT 計算のファイル生成とキラル光学特性解析を行うユーティリティプログラムです。

依存関係

Python 3.10 以上と、以下の Python パッケージを必要とします:

  • NumPy
  • RDKit
  • OpenBabel
  • NetworkX
  • Matplotlib

また、OpenBabel 3.1.* のバイナリプログラムを必要とします。

インストール

# PyPI から最新版をインストール
pip install chiropy

# GitHub から最新版をインストール
pip install git+https://github.com/s-inoue0108/chiropy.git
# インストールの確認
pip list | grep chiropy

# CLI のテスト
chiropy --help

Gaussian インプットの生成 (chiropy ginp)

1分子の化学構造ファイルから、TD-DFT 計算用の Gaussian インプットを生成します。

# 化学構造ファイルからインプットを生成する
chiropy ginp -i *.mol

# ヘルプ
chiropy ginp --help

化学構造ソースとして利用可能なファイル形式は以下の通りです。

拡張子 説明 備考
mol MDL mol ファイル (V2000/V3000) 1分子のもの
sdf MDL sdf ファイル (V2000/V3000) mol ファイルと同等/1分子のもの
mol2 mol2 ファイル 1分子のもの
xyz xyz ファイル 1分子のもの
pdb pdb ファイル 1分子のもの
cif cif ファイル 1分子のもの
out Gaussian アウトプットファイル 構造最適化後のアウトプットが適する
log Gaussian アウトプットファイル 構造最適化後のアウトプットが適する

励起状態計算

TD-DFT 計算を用いた励起状態計算を行うためのインプットを生成します。

# 第1励起状態をターゲット・第3励起状態までを探索
# td(root=1, nstate=3) (デフォルト)
chiropy ginp -i *.mol 

# td(root=1, nstate=8)
chiropy ginp -i *.mol --nstate 8

# td(root=2, nstate=4)
chiropy ginp -i *.mol --root 2 --nstate 4

励起状態の構造最適化

--opt オプションを指定すると、--root で指定したターゲットの励起状態を構造最適化します。

# 第1励起状態を最適化
# td(root=1, nstate=3) opt
chiropy ginp -i *.mol --opt

# td(root=1, nstate=8) opt
chiropy ginp -i *.mol --nstate 8 --opt

# td(root=2, nstate=4) opt
chiropy ginp -i *.mol --root 2 --nstate 4 --opt

Gaussian の条件

DFT の汎関数

-f または --functional で指定可能です。デフォルトは b3lyp です。

# CAM-B3LYP に変更
chiropy ginp -i *.mol -f "cam-b3lyp"

基底関数系

-b または --basis で指定可能です。デフォルトは 6-31g(d) です。

# def2-TZVP に変更
chiropy ginp -i *.mol -b "def2tzvp"

# wB97X-D/6-311G(d,p) に変更
chiropy ginp -i *.mol -f "wb97xd" -b "6-311g(d,p)"

有効内殻ポテンシャル

--ecp で指定可能です。指定した ECP を重金属に自動で割り当てます。

# LanL2DZ を指定
chiropy ginp -i *.mol --ecp "lanl2dz"

# def2-SVP/def2-TZVP を指定
chiropy ginp -i *.mol -b "def2svp" --ecp "def2tzvp"

その他のオプション

  • 総電荷の変更: -c [charge] (デフォルトは -c 0)
  • スピン多重度の変更: -m [multiplicity] (デフォルトは -m 1)
  • SCF 収束条件の変更: --scf tight など
  • 出力ファイル名を指定 -o [filename]
  • 出力ファイルの接尾辞の変更 -s [suffix] (デフォルトは -s "_tddft")
  • 出力ファイルの拡張子の変更: -e com (デフォルトは -e gjf)
  • Gaussian 出力のレベルの変更: --verbose 1 (デフォルトは --verbose 0)

Gaussian アウトプットの解析 (chiropy gout)

TD-DFT 計算のアウトプットファイルを読み取り、キラル光学特性に関わる物理量を計算して表示します。

# アウトプットファイルを解析する (*.out または *.log)
chiropy gout -i *.out

# ヘルプ
chiropy gout --help

各種物理量は、アウトプットファイルに含まれる電気遷移双極子モーメントの各成分 $(\mu_x, \mu_y, \mu_z)$ および磁気遷移双極子モーメントの各成分 $(m_x, m_y, m_z)$ から、以下のように算出されます。

物理量 記号 定義または計算式
電気遷移双極子モーメント $\mu$, $\vert \boldsymbol{\mu} \vert$ $(\mu_x, \mu_y, \mu_z)$
磁気遷移双極子モーメント $m$, $\vert \boldsymbol{m} \vert$ $(m_x, m_y, m_z)$
E-M Angle (deg) $\theta_{\mu m}$ $\mathrm{Arccos} ~ \dfrac{\boldsymbol{\mu} \cdot \boldsymbol{m}}{\vert \boldsymbol{\mu} \vert \vert \boldsymbol{m} \vert}$
g 値 $g$ $4 \dfrac{\vert \boldsymbol{\mu} \vert \vert \boldsymbol{m} \vert}{\vert \boldsymbol{\mu} \vert^2 + \vert \boldsymbol{m} \vert^2} \cos \theta_{\mu m}$

ETDM および MTDM についてはベクトルを化学構造上にマッピング表示します。

GUI による表示

3次元化学構造をレンダリングし、ETDM および MTDM ベクトルを描画して GUI を表示します。

# GUI で表示
chiropy gout -i *.out

励起状態の選択

--state を指定することで、励起状態を選択することができます。デフォルトは 1 です。

# 第3励起状態の情報を表示
chiropy gout -i *.out --state 3

表示オプション

  • --symbol: Ball-and-stick モデルの代わりに元素記号を表示 (より軽量にレンダリングできます)
  • --showh: 水素を表示
  • --notext: 各種テキストを非表示
  • --dark: ダークテーマで表示

その他オプション

  • --image: GUI を表示せず、画像をエクスポート
  • --summary: GUI を表示せず、結果の概要を標準出力に表示
# state 2 の結果を水素付きで表示して、画像をエクスポート
chiropy gout -i *.out --state 2 --showh --image

# 結果のサマリーを表示
chiropy gout -i *.out --summary

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

chiropy-1.0.1.tar.gz (172.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

chiropy-1.0.1-py3-none-any.whl (171.3 kB view details)

Uploaded Python 3

File details

Details for the file chiropy-1.0.1.tar.gz.

File metadata

  • Download URL: chiropy-1.0.1.tar.gz
  • Upload date:
  • Size: 172.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.9

File hashes

Hashes for chiropy-1.0.1.tar.gz
Algorithm Hash digest
SHA256 cf41a982014991fa5bf385eac3903188bfd4e8adb0570b4bd5bc434f56e8958f
MD5 4dad287648f9192f2c53bd600f1b39ec
BLAKE2b-256 8abf8c536d27b279fc7b0884619151b059f59bb8b9e5bbe82512676cdfb7bb79

See more details on using hashes here.

File details

Details for the file chiropy-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: chiropy-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 171.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.9

File hashes

Hashes for chiropy-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 25f068dd9ec406301fe058e5d2f025f810ac59ce72240b73f8215079058118fe
MD5 ec09f7056d5ed2677e72330f6a3bfa7f
BLAKE2b-256 2040d941931a2ed7eee02846f5eeb0c6d25606bd57f10a1659bc2da2eb067576

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page