Lang: 日本語 | English

emout

EMSES シミュレーション出力の解析・可視化 Python ライブラリ

emout でできること:

• .h5 グリッド出力と plasma.inp / plasma.toml を 1 行で読み込めるファサード
• データの次元に応じて最適な表示を自動選択する 1D / 2D / 3D プロット
• !!key dx=...,to_c=... ヘッダーから自動生成される EMSES ⇄ SI 単位変換（30 種以上の物理量に対応）
• EMSES の finbound 境界形状を Python オブジェクトとして操作できる API

• ドキュメント: ユーザーガイド (日本語/English) | API リファレンス
• ノートブック例: 月面帯電シミュレーション結果の可視化
• Agent plugins: emout Context — Codex / Claude Code 標準の plugin marketplace で導入し、repo 外でも可視化 script 作成・改善、単位変換、トラブルシュートを agent に相談できます（導入手順）

インストール

pip install emout

# PyVista による 3D 可視化も標準インストールに含まれます

# インストール済み version と PyPI の更新確認
emout version --check-update

Agent plugins

emout の emout Context plugin は、シミュレーション出力ディレクトリや別 repo で Codex / Claude Code を起動したときにも、emout の軸順序・単位変換・可視化・トラブルシュートの文脈を使えるようにします。

codex plugin marketplace add Nkzono99/emout \
  --ref main \
  --sparse .agents/plugins \
  --sparse plugins/emout-context
codex plugin add emout-context@emout

Claude Code では次のように導入します。

claude plugin marketplace add Nkzono99/emout \
  --sparse .claude-plugin plugins/emout-context
claude plugin install emout-context@emout

emout CLI をインストール済みなら、Claude Code 用は emout claude install-plugin、Codex 用は emout codex install-plugin でも導入できます。詳しい導入・更新手順は plugin 導入手順 を参照してください。

クイックスタート

import emout

data = emout.Emout("output_dir")

# 最終ステップの電位を xz 平面（y=ny/2）でプロット — これだけで SI 単位付きカラーマップ
data.phisp[-1, :, data.inp.ny // 2, :].plot()

変数名は EMSES のファイル名から自動解決されます:

data.phisp          # 電位 (GridDataSeries — 時系列)
data.nd1p           # 種1 数密度
data.j1x            # 種1 電流密度 x成分
data.j1xy           # j1x + j1y 自動結合 → 2D ベクトル
data.j1xyz          # 3D ベクトル
data.icur, data.ocur, data.pbody  # テキスト診断出力 (.val_si で SI 変換)

スライスの軸順序は (t, z, y, x) です。

解析・描画で元の系列と座標を保持するためのオプション:

data.phisp.time_series(32, 32, 10, skip_overlap=True)  # 再開点の重複を除外
data.phisp[:].mean(axis="x", keep_metadata=True)[-1].plot()  # yz 平均断面
data.phisp[-1, ::2, ::2, ::2].plot(coordinates="grid", levels=[0.0])

従来の既定動作も維持します。詳しくは クイックスタート と プロットガイド を参照してください。

周期電場の境界補間と、VTK の値・座標配置を修正するオプションも利用できます:

data = emout.Emout("output_dir", electric_relocation="periodic")
data.phisp[-1].to_vtk("phisp.vti", ordering="vtk", coordinates="grid")

穴表面の描画には consistent=True、平面の場の着色には resolution="grid" を使います。 軌跡の透明度・領域・目盛・カメラの調整は PyVista ガイド、 共有ライブラリの診断は バックトレースガイド を参照してください。

機能ガイド

各機能の詳しい使い方はユーザーガイドを参照してください。

代表的な使い方

プロット

data.phisp[-1, 100, :, :].plot()                       # 2D カラーマップ
data.phisp[-1, 100, :, :].contour()                     # 等高線
data.nd1p[-1, 100, :, :].plot(norm="log", vmin=1e-3)    # 対数スケール
data.j1xy[-1, 100, :, :].plot()                          # ストリームライン
data.phisp[-1, :, 32, 32].plot()                         # 1D プロファイル

アニメーション

data.phisp[:, 100, :, :].gifplot()                                  # Jupyter インライン
data.phisp[:, 100, :, :].gifplot(action="save", filename="out.gif") # GIF 保存

単位変換

data.unit.v.trans(1.0)       # SI → EMSES
data.phisp[-1].val_si        # 全 3D 配列を SI [V] で取得

境界メッシュ

data.boundaries[0].mesh()                   # 個別境界の MeshSurface3D
data.phisp[-1].plot_surfaces(               # フィールド上にオーバーレイ
    ax=ax, surfaces=data.boundaries,
)

粒子データ

p4 = data.p4                               # 種4
p4.vx[0].val_si.to_series().hist(bins=200)  # 速度分布

# 継続出力の結合
data = emout.Emout("output_dir", ad="auto")

# 入力ファイルと出力ディレクトリを分離
data = emout.Emout(input_path="/path/to/plasma.toml", output_directory="output_dir")

# ポアソン方程式
from emout.utils import poisson
phi = poisson(rho, dx=dx, btypes=btypes, epsilon_0=cn.epsilon_0)

# バックトレース（要 vdist-solver-fortran）
result = data.backtrace.get_probabilities(x, y, z, vx, vy, vz, ispec=0)
result.vxvz.plot()

コントリビュート

バグ報告・機能提案・PR を歓迎します。

• バグ / 質問: GitHub Issues に再現手順を添えて投稿してください
• PR: main から作業ブランチを切り、pytest -q がグリーンの状態で送ってください
• ドキュメント: README.md（日本語）と README.en.md（英語）は対応する形で維持されています。片方を更新したらもう片方にも反映してください

開発環境のセットアップやディレクトリ構成は AGENTS.md にまとまっています。

ライセンス

MIT License

リンク

• ユーザーガイド（日本語） | User Guide (English)
• API リファレンス
• EMSES (MPIEMSES3D)
• サンプルノートブック