Skip to main content
このクイックスタートではプロトコルシミュレーションを実行します — Universal Cycler Protocol を用意してモデルに対してシミュレーションし、必要に応じて実験計画法(DOE)としてパラメータをスイープします。スタディ内で(Studies ページのように)シミュレーションを実行するには、スタディ内でのシミュレーション実行 を参照してください — 同じ呼び出しに study_id を渡すだけです。
先にインストールと認証を行います: pip install ionworks-api を実行し、IONWORKS_API_KEYIONWORKS_PROJECT_ID を設定します。Python API クライアント ページを参照してください。
ポイント
  • プロトコルは Universal Cycler Protocol(UCP)YAML で、インラインまたは保存済みプロトコル id で渡します。すべての実行に parameterized_model(パラメータ化モデルの id またはインラインのクイックモデル)が必要です。
  • 単一 = client.simulation.protocol(...)バッチ/DOE = client.simulation.protocol_batch(...)。後者は design_parameters_doe ブロックの rows で、sampling 戦略のもとに名前付きパラメータをスイープします。
  • wait_for_completion(...) は 1 つの id または id のリストを受け付けます。get_result(id).time_series.steps のデータフレーム(Step count で結合可能)と .metrics の dict を返します。
  • データフレームはデフォルトで polars です。pandas を使う場合はセッション開始時に set_dataframe_backend("pandas") を一度呼び出します。

さらに詳しく