スタディ内でのシミュレーション実行 - Ionworks Studio

Studies ページでは、保存済みのパラメータ化モデルに対してシミュレーションを実行し、その結果はスタディに紐付けられます。Python では同じ client.simulation.protocol 呼び出しに study_id を渡すだけで、実行結果がそのスタディの Simulations タブに表示されます。

先にインストールと認証を行います: pip install ionworks-api を実行し、IONWORKS_API_KEY と IONWORKS_PROJECT_ID を設定します。Python API クライアントページを参照してください。

from ionworks import Ionworks

client = Ionworks()

# 実行結果を紐付けるスタディ（「新しいプロジェクトのセットアップ」参照）と、
# シミュレーション対象のパラメータ化モデル（「モデルのアップロード」参照）。
study = client.study.create({"name": "Cycling Test"}, project_id="your-project-id")
parameterized_model_id = "your-parameterized-model-id"

protocol = """
global:
  initial_soc: 1
  temperature: 25
steps:
  - Discharge:
      mode: C-rate
      value: 1
      ends:
        - "Voltage < 2.5"
"""

response = client.simulation.protocol({
    "parameterized_model": parameterized_model_id,
    "protocol_experiment": {"protocol": protocol, "name": "1C discharge"},
    "study_id": study.id,
})
client.simulation.wait_for_completion(response.simulation_id, timeout=120)

result = client.simulation.get_result(response.simulation_id)
print(result.time_series)   # DataFrame: 時間点ごとに 1 行
print(result.metrics)       # スカラーメトリクスの dict

ポイント

これはプロトコルシミュレーションと同じ呼び出しです。study_id を渡すと実行結果がスタディに紐付けられ、Studio のそのスタディの Simulations タブに表示されます。
parameterized_model には、作成したモデルの id（モデルのアップロード参照）、または使い捨て実行用に {"capacity": 5.0, "chemistry": "NMC/Graphite"} のようなインラインのクイックモデルを渡します。
結果は get_result(...) で取得します — .time_series、.steps、.metrics。多数の実行にわたってパラメータをスイープするには protocol_batch を使います（プロトコルシミュレーションの実行参照）。

さらに詳しく

⌘I