profile_Ne-T.py ドキュメント

概要

profile_Ne-T.py は、半導体のキャリア濃度と温度の依存性を計算する外部プログラムの計算部分の実行時間を計測するプロファイリングツールです。 元のソースコードを変更することなく、計算機能(フェルミ準位やキャリア濃度の算出)のみを抽出して cProfile でプロファイルを取得し、関数の実行時間や呼び出し回数を出力します。また、計算結果から電荷中性条件の残差を算出し、計算精度の確認も行います。

実行例

コマンドラインからの実行例を以下に示します。

# 基本的な実行方法
python profile_Ne-T.py "Ne-T_sol(1).py"

# 表示件数とモデルパラメータを指定して実行
python profile_Ne-T.py Ne-T_sol.py --top 30 --ND 1e18 --nT 200

# 保存先プロファイルファイル名を指定して実行
python profile_Ne-T.py Ne-T_sol.py --profile custom.prof

入出力仕様

  • 必須ライブラリ

    • 標準ライブラリ: argparse, cProfile, importlib.util, pathlib, pstats, sys, re

    • 非標準ライブラリ: numpy

  • コマンドライン引数

    • program (位置引数) : 測定対象となるPythonスクリプトファイルへのパス。

    • --top : 実行結果のリストで表示する上位の件数。デフォルトは 20。

    • --profile : 測定結果を保存するプロファイルファイルのパス。デフォルトは Ne-T.prof。

    • その他の引数 : 未知の引数はすべて対象プログラムの初期化関数 initialize() に渡されます。

  • 出力

    • 測定結果のプロファイルファイル (デフォルト: Ne-T.prof)。

    • 標準出力へのプロファイル結果(累積時間順、合計時間順、対象プログラム本体に絞った結果、主要関数に絞った結果)。

    • 計算された最大電荷中性残差の相対値。

処理フローとアルゴリズム

  1. 引数と設定の読み込み

    • コマンドライン引数からプロファイリング用の設定(表示件数や保存先)と、対象プログラムに渡す引数を分離します。

  2. モジュールの動的読み込み

    • 指定されたPythonファイルを importlib.util を用いて動的に読み込みます。ファイル名にハイフンや括弧が含まれていても読み込みが可能です。

  3. 計算対象の初期化

    • 対象プログラムの initialize() を呼び出し、設定オブジェクトと計算モデルを取得します。

    • 設定された温度範囲(最小温度から最大温度)と分割数を用いて、計算対象となる温度の配列を生成します。

  4. プロファイリングの実行

    • cProfile.Profile を用いて、計算処理を行う calculate 関数の実行時間を計測します。

    • 各温度において、対象プログラムの solve 関数でフェルミ準位 \(E_F\) を求め、以下の物理量を計算します。

      • 電子濃度 \(n\) : Ne

      • 正孔濃度 \(p\) : Nh

      • イオン化ドナー濃度 \(dp\) : NDp

      • イオン化アクセプタ濃度 \(am\) : NAm

    • 計算の収束性を評価するため、各温度における電荷中性条件の残差(相対値)を以下の式で計算します。

      \[\text{residual} = \frac{p - n + dp - am}{\max(n + p + dp + am, \text{tiny})}\]

      ここで、\(\text{tiny}\) はゼロ除算を防ぐための計算機イプシロン(極小値)です。

  5. プロファイル結果の出力

    • 計測結果を pstats.Stats で集計し、累積時間 (cumulative) と合計時間 (tottime) のそれぞれでソートして上位の関数を表示します。

    • 正規表現を用いて、プログラム本体の処理結果や、キャリア濃度計算に関わる主要関数 (solve, Fj, Ne, Nh, deltaQ, NDp, NAm) のみに絞ったプロファイル結果を出力します。

注意事項

  • 本スクリプトは、測定対象のプログラム内に initialize, solve, Ne, Nh, NDp, NAm の各関数が実装されていることを前提としています。

  • importlib.util を用いて対象スクリプトを _carrier_profile_target という名前で sys.modules に登録した上で実行します。

  • プロファイリングの対象となるのは計算部分のみであり、対象プログラムに実装されているグラフの描画やCSVファイルへの保存処理は実行されません。

  • --top 引数には 1 以上の整数を指定する必要があります。これより小さい値を指定した場合、パースエラーとなります。