simepidemic HTTP Server版仕様書 ver. 1.4.3

著者：畝見達夫，作成：令和4年7月27日

このドキュメントでは，感染シミュレータ SimEpidemic の HTTP server 版における，起動オプション，クライアントとの間のプロトコル等の仕様について述べる。以前のバージョンについてはつぎのリンクを参照されたい。 1.4.2， 1.4.1， 1.4.0， 1.3.6， 1.3.5， 1.3.4， 1.3.3， 1.3.2， 1.3， 1.2.2。

SimEpidemic 個体ベース感染シミュレータ 技術文書

• simepidemic HTTP Server版仕様書 ver. 1.4.3
  • サーバプロセスの起動と終了
    • コマンドオプション
    • ログとプロセスID
  • HTTP 要求と応答
    • 稼働中のサーバソフトウェアのバージョン情報の取得 GET /version
    • サーバ情報の取得 GET /sysInfo
    • サーバプロセス起動時設定の取得 GET /getConfig
    • 無用なアクセスのブロック
  • シミュレーション世界の生成と消去
    • 既定値の世界IDの取得 GET /getWorldID
    • 世界の生成 GET /newWorld
    • 世界の消去 GET /closeWorld
  • パラメータ値の取得と設定
    • パラメータ値の取得 GET /getParams
    • パラメータ値の設定 POST /setParams
      • 積載情報: Content-type: multipart/form-data
      • 積載情報: Content-type: application/x-www-form-urlencoded
  • パラメータ名と型
    • 世界パラメータ
    • 移動パラメータ
    • 発症機序パラメータ
    • 対策パラメータ
    • 検査パラメータ
    • ワクチンパラメータ
  • 変異ウイルスとワクチン
    • ワクチンリストの取得 GET /getVaccineList
    • ワクチンリストの設定 POST /setVaccineList
      • 積載情報: Content-type: multipart/form-data
    • 変異ウイルスリストの取得 GET /getVariantList
    • 変異ウイルスリストの設定 POST /setVariantList
      • 積載情報: Content-type: multipart/form-data
    • 変異ウイルスとワクチン情報の読み込み GET /loadVariantsAndVaccines
  • 集会の設定
    • 集会リストの取得 GET /getGatheringsList
    • 集会リストの設定 POST /setGatheringsList
      • 積載情報: Content-type: multipart/form-data
    • 集会情報の読み込み GET /loadGatheringsList
  • 対話型の実行制御
    • 開始: GET /start
    • 停止: GET /stop
    • 初期化: GET /reset
    • 感染個体の追加 GET /addInfected
  • 実行の監視と結果の取得
    • 数値情報の取得 GET /getIndexes
    • 分布情報の取得 GET /getDistribution
  • 実行状況の定期的取得
    • 定期的取得の開始 GET /periodicReport
    • 定期的取得の廃止 GET /quitReport
    • 定期的取得指標の変更 GET /changeReport
  • 統計指標名と型
    • 数値情報
    • 分布情報
    • 重症度分布の推移
    • 変異ウイルス分布の推移
    • ワクチン接種の実施数の推移
  • 個体の位置と健康状態の取得
    • 要求 GET /getPopulation
    • 応答 Content-type: application/json
    • 要求 GET /getPopulation2
  • 集団状態の保存と読み込み
    • サーバ上での保存: GET /saveState
    • 読み込み: GET /loadState
    • サーバ上の保存情報の消去: GET /removeState
  • シナリオの設定
    • 要求 POST /setScenario
      • 積載情報: Content-type: multipart/form-data
      • 積載情報: Content-type: x-www-form-urlencoded
    • シナリオのデータ表現
    • 条件用の統計指標
  • バッチジョブの投入，監視，結果の取得
    • 投入: POST /submitJob
      • 積載情報: Content-type: multipart/form-data
      • 積載情報: Content-type: x-www-form-urlencoded
      • ジョブのデータ表現
    • ジョブ投入時情報の取得: GET /getJobInfo
    • 待ち行列の監視: GET /getJobQueueStatus
    • ジョブの監視: GET /getJobStatus
    • ジョブの中止: GET /stopJob
    • 結果の取得: GET /getJobResults
      • 表形式データの内容
    • 結果記録の消去: GET /deleteJob
    • 結果記録の延命: GET /touchJob
  • JSONフォーマットオプション

サーバプロセスの起動と終了

サーバソフトウェアは macOS 11 以降で動作するコマンドライン・アプリケーションである。 UNIX の標準的な起動方法によりバックグラウンドで実行することを想定している。 終了させるには，kill pid コマンド等によりプロセスに TERM シグナルを送る。 実行モジュールの標準的なファイル名は simepidemic である。

コマンドオプション

• -d, --documentRoot パス : HTML などのファイルが格納されているディレクトリのパス。 / で始まる絶対パスあるいは、simepidemic コマンドを起動したときの作業ディレクトリからの相対パス。 既定値はコマンド起動時の作業ディレクトリ。サーバプロセスによる読み込みが可能でなければならない。
• -D, --dataStorage パス : サーバが使う情報記録用のファイルを格納するディレクトリのパス。 / で始まる絶対パスあるいは、simepidemic コマンドを起動したときの作業ディレクトリからの相対パス。 既定値はコマンド起動時の作業ディレクトリ。 サーバプロセスによる読み込みと書き込みが共に可能でなければならない。
• -DR, --dataStorageR パス : 上記の --dataStorage と同じ。ただし，変異ウイルスとワクチン情報 と 人口密度分布地図 を除くデータは指定したパスの下のホスト名ディレクトリの下に配置する。 ホスト名ディレクトリが存在しない場合は，サーバ内に新たなディレクトリ作られる。 ホスト名はサーバ上で unix コマンドの hostname -s を実行したときに得られる文字列であり， 一般には FQDN の先頭の語である。--hostname オプションが指定されている場合は，そちらが優先される。 複数のサーバ間で共有されるリモートファイルを利用し，一部のデータをサーバ間で共有する場合に有用である。
• -Dr, --dataStorageR2 パス : 上記の --dataStorageR と同じ。ただし， ホスト名は macOS の 「共有」で用いられるマシン名になる。 これは「システム環境設定」の「共有」パネルの上方にある「コンピュータ名」の欄にある名称を 英小文字に変換した文字列である。
• -e, --jobExprHours h : バッチジョブの実行結果の保存時間。既定値は 168 つまり1週間である。
• -E, --stateExprHours h : 集団状態の保存時間。既定値は 168 つまり1週間である。
• -f, --format n : JSON フォーマットオプションの既定値を指定する。 このオプションを指定しない場合の既定値は 0。
• -H, --hostname ディレクトリ名 : 情報記録用のファイルを格納するディレクトリのパスに付加されるサブディレクトリ名。
• -n, --maxNWorlds n : サーバで扱う世界の最大数。既定値は 128。
• -p, --port ポート番号 : HTTP サーバのポート番号を指定する。既定値は 8000。
• -r, --maxRuntime s : 秒数で表す最長実行時間。 既定値は 172,800 つまり2日間。実行開始からこの時間が経過したときに引き続きまだ実行中の場合は強制的に停止する。 実行を一時停止したのちに実行を再開した場合は，再開時点からの時間になる。
• -s, --maxPopSize n : 許容される人口の最大数。既定値は 1,000,000。
• -t, --documentTimeout s : 秒数で表す世界の保持期限。 既定値は 1,200 つまり20分間。最後の動作・操作からこの時間が経過した時点で世界を閉じる。 実行中の場合は，実行の終了後からの時間となり，終了後に操作が行われればさらに延長される。
• -Q, --maxQueuedJobs n : バッチジョブにおいて待ち行列に入るジョブ数の上限。既定値は 256。
• -T, --maxTrials n : バッチジョブにおいて並列に実行する試行の最大数。既定値は物理コア数。
• --version : ソフトウェアのバージョンを表す文字列を表示し終了する。

ポートを他のプロセスが使用していたり，サーバプロセスの停止から数秒以内に再起動した場合などでポートの確保に失敗すると，即座に停止し終了コード 2 を返す。

例：ポート番号 8001番を使用し、JSONのフォーマットに段つけと辞書キーのソートを指定して、 バックグラウンドで実行を開始する。(bash, tcsh などの場合。zsh では末尾を &! にする。)

$ simepidemic -p 8001 -f 3 &

サーバプロセスを起動したマシンで Webブラウザから http://localhost:ポート番号/ へアクセスすると， index.htmlがあれば，その内容が描画される。

ログとプロセスID

UNIX の syslog 機能の拡張である macOS の os_log を利用して，実行状況の記録を取る。 同時に情報記録用ディレクトリの直下の log_p.txt と名付けられたファイルにも出力される。 p は，10進数4桁のポート番号で，999以下の場合，左側に0が必要個数付け加わる。 例えばポート番号が 80 なら 0080，8001 ならそのまま 8001 である。 ログファイルの大きさが 1MByte を超えた場合は， その時点でのファイル名を log_p_t.txt に変更し，新たな空の log_p.txt に次のログを書き込む。 t はファイル名変更時点の年月日時刻を表す14桁の数字列で，4桁の西暦年，4桁の月日，6桁の時分秒からなる。

このディレクトリ直下の pid_p と名付けられたテキストファイルにプロセスIDを示す10進数が書き込まれる。 p はログファイルと同じく4桁のポート番号である。 サーバプログラムをコマンドで停止する場合にプロセスIDを ps コマンドなどで調べずとも， 例えばポート番号が 8000 なら下記のコマンドを使うことができる。

$ kill `cat pid_8000`

HTTP 要求と応答

クライアント側からの要求にサーバが応答する。 クライアントはエンドユーザに対してGUIなどの操作・表示手段を提供するものであり， javascript 等で書かれたコードにより制御されるWEBブラウザ等を想定する。 多くのブラウザでは，HTTPプロトコルに規定されるいくつかのヘッダが自動的に構成されるため， 以下ではプロトコルの詳細は省略し，ブラウザ上で動くプログラムの開発に必要な情報だけを記述する。

パラメータ設定や実行制御など，応答としてデータを返す必要のない要求に 対しては，サーバは text/plain 型のエラー等の情報を示すデータを返す。 特に以下の説明で記述がない場合データは OK のみである。

シミュレータへの要求コマンドではなく、.html，.css，.js，.jpg などのファイル拡張子を伴うパスが指定された場合は． 該当するファイルがホスト側に存在すれば，通常の WEB サーバと同様その内容を応答する。 ただし，動画や音声などのためのストリーミングによる発信は実装されておらず， これらのファイルを指定した場合は 415 (Unsupported Media Type) エラーになる。 .cgi や .php などのサーバサイドプログラムも同様のエラーになる。 HEAD, GET, POST 以外の PUT その他のメソッドの要求は 405 (Method not allowed) エラーになる。

サーバのトップディレクトリを含め，/ で終わるパスの GET 要求に対しては，そのディレクトリに index.html ファイルが存在すれば，その内容を応答する。 トップディレクトリは，既定値では simepidemic コマンドが起動された状態での作業ディレクトリになる。 ディレクトリの位置は コマンドライン・オプション -d で， サーバプロセスの起動時に指定可能である。

稼働中のサーバソフトウェアのバージョン情報の取得 GET /version

応答として，バージョンを表現する text/plain タイプの文字列を返す。

サーバ情報の取得 GET /sysInfo

応答として，サーバの情報を含む JSON 形式の文字列を返す。 情報は辞書形式で表現され，含まれる情報は以下の表のとおりである。

サーバプロセス起動時設定の取得 GET /getConfig

応答として，サーバプロセス起動時の設定情報を含む JSON 形式の文字列を返す。 情報は辞書形式で表現され，含まれるキーは， コマンドオプション に挙げた先頭に -- が付く各キーワードである。 ただし，port と version は除く。

無用なアクセスのブロック

クローラや DoS 攻撃など，外部からの無用なアクセスを抑止するため， 連続するエラーを検知した場合，その種類と頻度に応じて当該 IP アドレスからの接続を一定期間拒否する。

シミュレーション世界の生成と消去

1つのシミュレーション環境をここでは 世界 と呼ぶ。 アクセス元のブラウザまたは IP アドレス1つにつき1つの世界が既定値として割り当てられる。 1つの世界を複数のアクセス元から操作したり，1つのアクセス元での複数の世界の操作を可能とするため， 各世界には固有の文字列で表現される 世界ID が割り当てられ， 操作時にこの世界IDを指定することで，対象となる世界を特定する。 次節以降で述べるパラメータ設定などは，すべて指定されたあるいは既定値の世界に対して実行される。 複数の世界を同時に扱うのでなければ，既定値として割り当てられた世界を用いればよいので， 新たに世界を生成する必要はない。

無用な世界の増加を防ぐため，最後の操作または動作から 一定時間が経過した時点で， 世界を閉じデータを消去する。時間の既定値は20分であるが，サーバ起動時のコマンドオプション -t または --documentTimeout で指定することができる。 その後に同じブラウザまたは IP アドレスからの既定値世界に対する操作の要求があった場合は， 新たに世界が生成される。すでに消去された世界IDを伴う操作要求はエラーになる。

ブラウザの区別は既定値の世界に対するコマンドの問い合わせの中に me=文字列 を含めることで実現される。 文字列 は，他と重複のない適当な文字列でよい。 この情報がない場合はアクセス元の IP アドレスで代替されるが， NAT ルータを介した IP マスカレード等により，サーバ側から見た場合， 複数のマシンが同じ IP アドレスを共有する場合があるため注意が必要である。

既定値の世界IDの取得 GET /getWorldID

• me=ブラウザID 省略可

既定値世界の ID を表す文字列をテキスト text/plain として応答する。 得られた 世界ID を使って，既定値の世界を他のマシンから操作することができる。

世界の生成 GET /newWorld

新たな世界を1つ生成し，その世界 ID を表す文字列をテキスト text/plain として応答する。

世界の消去 GET /closeWorld

• world=世界ID 必須

指定された世界IDを持つ世界を消去する。ただし，既定値世界は消去できない。

パラメータ値の取得と設定

パラメータ値の取得 GET /getParams

• save=ファイル名 省略可。 このオプションが添えられた場合は，ダウンロード形式で応答する。
• format=JSONフォーマットオプション 省略可。
• me=ブラウザID 省略可。
• world=世界ID 省略可。

パラメータ名 をキー，設定するパラメータ値を値とする辞書形式の JSON データが応答される。

例：JSON の辞書形式のデータを myParams.json に保存する。

<form method="get" action="getParams" target="saveResult">
<input type="hidden" name="format" value=0>
<input type="text" name="save" value="myParams">
<input type="submit" value="保存">
</form>
応答: <iframe name="saveResult" height=20></iframe>

パラメータ値の設定 POST /setParams

シミュレーションを実行するときに使われるパラメータ値を設定する。 パラメータは，世界，移動，発症機序，対策，検査，ワクチン の6種類に分類される。 詳細は，パラメータ名と型を参照。 このうち世界に分類されるパラメータは，シミュレーション開始前でなければ適用できない。 シミュレーションの途中で世界パラメータの設定を行うと，新たに指定された値は予約として記録され， 次に世界を初期化したときに反映される。

積載情報: Content-type: multipart/form-data

パラメータ名 をキー，設定するパラメータ値を値とする 辞書形式の JSON データのパートを含まなければならない。このパートのヘッダは例えば，

Content-Disposition: form-data; name="ABCDFEG"; filename="myParams.json"
Content-Type: application/json

のような形式である。ここで "ABCDEFG" は 世界ID を表す文字列である。 文字列が "default" の場合は，既定値世界が操作の対象となる。

例：ユーザが指定したファイルからパラメータを読み込み，"ABCDEFG" というIDを持つ世界に設定する。

<form method="post" action="setParams"
  enctype="multipart/form-data" target="loadParamResult">
<input type="file" name="ABCDEFG" accept="application/json">
<input type="submit" value="読み込む">
</form>
応答: <iframe name="loadParamResult"></iframe>

積載情報: Content-type: application/x-www-form-urlencoded

• パラメータ名=パラメータ値 必須。 複数指定可。
• me=ブラウザID 省略可。
• world=世界ID 省略可。

例：初期人口と世界の広さを設定する。

<form method="post" action="setParams">
<table>
<tr><td align="right">人口</td>
    <td><input type="number" name="populationSize"></td></tr>
<tr><td align="right">世界の大きさ</td>
    <td><input type="number" name="worldSize"></td></tr>
</table><br/>
<input type="submit" value="設定"/>
</form>

パラメータ名と型

分布は最小値，最大値，最頻値の３つの数の組で表現され， JSON形式では３つの要素からなる配列で表現される。 以下，パラメータの種類により，世界，移動，発症機序，対策，検査，ワクチンに分けて表に示す。

世界パラメータ

ワクチン接種戦略 は，ワクチンの種類ごとの接種戦略を表すパラーメータ辞書の配列であり， 配列要素のになる辞書は下記の項目から成る。

変異ウイルスとワクチン

個々の変異ウイルスとワクチンは名前と効果を含む辞書形式のデータで表現される。 変異ウイルスの一覧，および，ワクチンの一覧がそれぞれ配列で表現される。 ここでいう効果とは，それに感染し完治した後に得られる，あるいは，接種した後に得られる免疫による感染予防効果の標準的な強さである。 個々の変異ウイルスには増殖力，個々のワクチンには2回接種の場合の接種間隔日数の情報も含まれる。

ワクチンリストの取得 GET /getVaccineList

• save=ファイル名 省略可。 このオプションが添えられた場合は，ダウンロード形式で応答する。
• format=JSONフォーマットオプション 省略可。
• me=ブラウザID 省略可。
• world=世界ID 省略可。

各ワクチン情報を示す辞書形式からなる配列形式の JSON データが応答される。 辞書形式に含まれる項目は以下のとおり。

ワクチンリストの設定 POST /setVaccineList

積載情報: Content-type: multipart/form-data

ワクチン情報を要素とする配列形式の JSON データのパートを含まなければならない。 JSONデータ以外の仕様はパラメータ値の設定と同じである。

変異ウイルスリストの取得 GET /getVariantList

• save=ファイル名 省略可。 このオプションが添えられた場合は，ダウンロード形式で応答する。
• format=JSONフォーマットオプション 省略可。
• me=ブラウザID 省略可。
• world=世界ID 省略可。

各変異ウイルスの情報を示す辞書形式からなる配列形式の JSON データが応答される。 辞書形式に含まれる項目は以下のとおり。

* 1回目接種の最大効果，2回目接種後の最大効果など， ワクチンの効果に関するパラメータにこの係数を乗じた値を用いてシミュレーションが実行される。 登録されている変異ウイルスの種類数に応じて項目数は増減する。

変異ウイルスリストの設定 POST /setVariantList

積載情報: Content-type: multipart/form-data

変異ウイルスの情報を要素とする配列形式の JSON データのパートを含まなければならない。 JSONデータ以外の仕様はパラメータ値の設定と同じである。

変異ウイルスとワクチン情報の読み込み GET /loadVariantsAndVaccines

• name=サーバ内のファイル名 必須。
• me=ブラウザID 省略可。
• world=世界ID 省略可。

サーバ上のデータ格納用ディレクトリの直下の VariantsAndVaccines というサブディレクトリの下にあらじめ保存された変異ウイルスとワクチンの情報を， 指定された名前のファイルから読み込む。ファイルの内容は辞書の JSON 形式であり， vaccineList というキーに対応する項目に配列形式のワクチンリスト， variantList というキーに対応する項目に配列形式の変異ウイルスリストが書かれている。

集会の設定

パラメータで指定された分布に従いランダムに開催される集会のほかに， 定期的に固定された場所で開催される集会を複数設定することができる。

集会リストの取得 GET /getGatheringsList

• save=ファイル名 省略可。 このオプションが添えられた場合は，ダウンロード形式で応答する。
• format=JSONフォーマットオプション 省略可。
• me=ブラウザID 省略可。
• world=世界ID 省略可。

各集会の情報を示す辞書形式からなる配列形式の JSON データが応答される。 辞書形式に含まれる項目は以下のとおり。

*7 参加対象者の参加の有無は集会の度にランダムに選ばれるわけではない。 参加率に従って選ばれた個体は，その集会にいつも参加しようとする。 *8 7以上では毎日開催。7未満の場合は，想定開始年月日に基づいて曜日を決め， 月曜から開催回数の日数分，連日開催する。

集会リストの設定 POST /setGatheringsList

積載情報: Content-type: multipart/form-data

集会設定の情報を要素とする配列形式の JSON データのパートを含まなければならない。 JSONデータ以外の仕様はパラメータ値の設定と同じである。

集会情報の読み込み GET /loadGatheringsList

• name=サーバ内のファイル名 必須。
• me=ブラウザID 省略可。
• world=世界ID 省略可。

サーバ上のデータ格納用ディレクトリの直下の GatheringsList というサブディレクトリの下にあらじめ保存された集会の情報を， 指定された名前のファイルから読み込む。ファイルの内容は， 1つ以上の集会情報を含む配列の JSON 形式である。

対話型の実行制御

シミュレーションの実行の 開始，停止，および，初期化のコマンド１つを， 要求行に入れた GET メソッドによりクライアントからサーバへ指示する。 サーバからの応答として，問題がなければ OK がテキストとして返る。 操作対象の世界を指定するため， 以下の3つコマンドでは共通して下記の2つの問い合わせ項目のいずれかを含める。

• me=ブラウザID 省略可。
• world=世界ID 省略可。

開始: GET /start

• stopAt=n 省略可。 実行日数が整数 n に到達した時点で停止する。この指定がなければ stop 要求があるか， 感染者が 0 になるか，あるいは，サーバ側で許容される最長実行時間まで実行が継続される。
• maxSPS=s 省略可。 計算速度の上限を秒あたりのステップ数で指定する。 $s\leq 0$ または省略された場合は速度制限はなく最速での計算となる。 サーバが計算能力の高いマシンで稼働している場合，シミュレーションを実時間で観察するときに役立つ。

感染者がいない状態でこのコマンドを実行した場合は，世界を初期化した後に実行を開始する。

停止: GET /stop

対象の世界が実行中の場合は，実行を中断する。再度，start コマンドを発効すると， 中断された状態から続きの実行が開始される。

初期化: GET /reset

世界を初期化し，実行前の状態にする。ただし，個体はランダムに再配置されるので， 以前とは異なる配置となり，まったく同じ実行プロセスが再現されることはない。

例：開始，停止、初期化の3つのボタン

<form method="get" target="result">
<input type="submit" value="開始" formaction="start">
<input type="submit" value="停止" formaction="stop">
<input type="submit" value="初期化" formaction="reset">
</form>
応答: <iframe name="result" width=100 height=20></iframe>

感染個体の追加 GET /addInfected

• n=n 省略可。追加個体数。省略された場合は 1。
• variant=変異ウイルス名称 省略可。 変異ウイルスの種類を名称で指定する。省略された場合は変異ウイルスリストの先頭に登録されている変異ウイルス。

集団内の未感染個体の中からランダムに n 個体を選択し， 指定されたウイルスに感染した無症状感染者に変更する。 その時点で感染したものとし．症状の亢進が開始される。

実行の監視と結果の取得

現在のサーバ側での実行の状況あるいは実行開始からの履歴を取得する。 実行制御と同様に，操作対象の世界を指定するため， 以下の3つコマンドでは共通して me または world を問い合わせ項目のいずれかを含めることができる。

数値情報の取得 GET /getIndexes

• names=[統計指標名1, 統計指標名2, ...] または 統計指標名=1 いずれか必須。 取得したい数値情報の統計指標名を指定する。後者の形式は複数含めても良い。
• fromStep=n または fromDay=n 省略可。 fromStep と fromDay が共に指定された場合は fromDay を優先。 可能なら n ステップ（あるいは日）から現在までの履歴を返す。 共に省略された場合，指定されたステップ（あるいは日）が実行済みのシミュレーション期間より先の場合， および，指標が履歴に対応しない場合は現在の値だけを返す。 n が負の場合は現在から |n | ステップ（あるいは日）前からの履歴を返す。 履歴は、データが日ごとの場合は日ごと、現在数と累積についてはステップごとの数値の配列になる。 ただし，ステップ数（あるいは日数）が 1,280 を超えると，内部の記録データが2ステップ（あるいは日） ずつの平均値に置き換えられ，記録される数値の数が半分の 640 に短縮される。 この操作は記録データの数が 1,280 を超えるたびに実行される。
• window=n 省略可。日ごとの値の移動平均の窓幅の日数。 n が 0 または，この指定が省略された場合は，現在数または累積を返す。 n > 1 について未実装。
• format=JSONフォーマットオプション 省略可。

統計指標名 をキー，指標値を値とする辞書形式の JSON データが応答される。

例：経過日数と各健康状態の現在の人数を取得し、iframe の内容として格納する。

<form method="get" action="/getIndexes" target="currentIndexes">
<input type="hidden" name="day" value=1>
<input type="hidden" name="susceptible" value=1>
<input type="hidden" name="asymptomatic" value=1>
<input type="hidden" name="symptomatic" value=1>
<input type="hidden" name="recovered" value=1>
<input type="hidden" name="died" value=1>
<input type="submit" value="現在の人口構成">
</form>
<iframe name="currentIndexes"></iframe>

分布情報の取得 GET /getDistribution

• names=[統計指標名1, 統計指標名2, ...] または 統計指標名=1 いずれか必須。 取得したい分布情報の統計指標名を指定する。後者の形式は複数含めても良い。
• format=JSONフォーマットオプション 省略可。

統計指標名 をキー，指標値のベクトルを値とする辞書形式の JSON データが応答される。 各ベクトルの第1要素は横軸の最小値，第2要素以降に刻みごとの値が入る。 例えば {"recoveryPeriod":[4,2,5,10,6,3,0,1]} は，快復期間の分布が 4日2人，5日5人，6日10人，7日6人，8日3人，9日0人，10日1人であることを表す。

例：潜伏期間と快復期間の分布を取得し、iframe の内容として格納する。

<form method="get" action="/getDistribution" target="distribution">
<input type="hidden" name="incubasionPeriod" value=1>
<input type="hidden" name="recoveryPeriod" value=1>
<input type="submit" value="日数の分布">
</form>
<iframe name="distribution"></iframe>

実行状況の定期的取得

Server-sent Events の機能を利用しサーバから定期的に実行状況をストリーミングにより送信する。 ストリーミングのプロセスは世界と結び付けられ，1つの世界に複数のプロセスを設定することもできる。

定期的取得の開始 GET /periodicReport

実行の状況を定期的にサーバから受け取る。 報告は実行中にのみ行い，一時停止中には報告しない。 その後に実行を再開すると，以前と同じ定期的報告も再開される。 実行制御と同様に，操作対象の世界を指定するため， me または world を問い合わせ項目のいずれかを含めることができる。

• report=[item_1, item_2, item_3, ...] item_i は，数値情報の統計指標名，または， 日ごと数値情報の統計指標，または，分布情報の統計指標名である。 第1の形式の場合は現在値あるいは累積値である。第2の形式は統計指標名の先頭の文字を大文字に代え， その前に daily を付加した文字列で日ごとのデータを指す。 例えば，日ごとの新たな無症状感染者数は dailyAsymptomatic で表す。 ただし，陽性率は日ごと数値情報のみなので，daily を付加した形式を用いない。 統計指標名の代わりに population を指定すると， 全固体の位置と健康状態の情報を受け取ることができる。 値として空配列 [] を指定した場合は，定期的な報告は行われない。 既に定期的な報告が実行されていた場合，空配列を指定すると報告は中止される。
• interval=s 省略可。 サーバからの送信の時間間隔を指定する。時間間隔は正の実数で単位は秒である。 省略された場合，1秒を指定したものとみなす。
• popFormat=f 省略可。 全固体の位置と健康状態の情報を受け取る場合の JSON のデータ形式を指定する。 f = 2 の場合，/getPopulation2 と同じ形式になる。 それ以外，あるいは省略された場合は /getPopulation と同じ形式である。

サーバからの応答は Content-Type: text/event-stream をヘッダとし， それに続き，イベントタイプ process のデータとしてストリーミングプロセスの識別子となる文字列が送信され， 続いて，指定した時間間隔でデータフィールドに JSON データが入ったイベントタイプのない情報を定期的に送信する。 JSON データの内容は report で指定した統計指標名をキー，指標値の配列を値とする辞書形式になる。 数値情報および日ごとの数値情報の場合は， すべての未送信のステップまたは日付のデータが入った配列になる。 ただし，数値情報の取得 と同様に $1,280\times 2^n (n = 0, 1, 2,\ldots)$ ステップ（または日）を超えた場合は， $2^n$ ステップ（または日）ごとの平均値の配列となる。 分布情報の場合は分布情報の取得 の応答と同じ形式である。 個体群の位置と健康状態の情報は，イベントタイプが population であるデータとして送信する。 データの形式は 個体の位置と健康状態の取得 の節にあるものと同じであり， 最新の状態のみを送信する。 ヘッダ送信後のストリーミングでは，サーバは圧縮されたデータを送信する。

すでに状態の定期的取得が設定されている世界に対して，このコマンドを発行した場合は， 新たな報告のストリーミングが開始される。

定期的取得の廃止 GET /quitReport

• process=プロセスID 必須。

プロセスID で指定された定期的報告を中止する。 ストリーミングのための接続を切るには，ブラウザ側で EventSource.close() を実行する。

定期的取得指標の変更 GET /changeReport

• process=プロセスID 必須。
• report=[item_1, item_2, item_3, ...] 省略可。
• interval=s 省略可。
• popFormat=f 省略可。

プロセスID で指定された定期的報告の内容を，report と interval と popFormat で指定されたものに変更する。省略された項目は変更されない。

例: javascript の EventSource オブジェクトを利用した報告の受け取り

<script type="text/javascript">
const browserID = "" + Date.now();
function startMonitor() {
    let request = "periodicReport?report=";
    const cboxes = document.getElementById("checkBoxes").children;
    for (var i = 0; i < cboxes.length; i ++)
        if (cboxes[i].checked)
            request += ((i == 0)? "[" : ",") + '"' + cboxes[i].name + '"';
    request += "]&interval=" + document.getElementById("interval").value
        + "&me=" + browserID;
    const evntSrc = new EventSource(request);
    evntSrc.onmessage = function (e) {
        document.getElementById("monitorText").innerHTML = e.data;
    } }
</script>
<button onclick="startMonitor()">監視開始</button>
時間間隔:<input id="interval" type="number" value="0.2" step="0.1">秒
<div id="checkBoxes">監視指標:
    <input type="checkbox" name="days" checked>日&nbsp;
    <input type="checkbox" name="asymptomatic" checked>未発症&nbsp;
    <input type="checkbox" name="symptomatic" checked>発症&nbsp;
    <input type="checkbox" name="recovered" checked>快復&nbsp;
    <input type="checkbox" name="died" checked>死亡
</div>
<div id="monitorText" width="95%" style="overflow-wrap:anywhere">
Received data will be shown here.</div>

統計指標名と型

シミュレーション過程で得られる統計指標には，ステップあるいは日ごとに変化する数値情報と， 過程開始以来の指標の分布を表す分布情報がある。

数値情報

指標の性質により，履歴，日ごと，現在数，累積に利用可能性の違いがある。

分布情報

全数累積統計による。 横軸の各値に該当した個体がそれまでに合計何人であったを示すベクトルで表現される。

重症度分布の推移

隔離中の個体の重症度を 均等な50段階に分類し，それぞれの区間にあてはまる個体数をベクトルとし， 経過日数分のベクトルをさらにベクトルにしたデータで表現される。 重症度 とは， 発症からその時点までの日数を各個体に割り振られた発症から死亡までの日数で割った実数値である。 統計指標名は severityStats 。

変異ウイルス分布の推移

隔離中の個体に感染している変異ウイルスについて， 種類別の各時点での感染者数をベクトルで表現し， それらをさらに時系列を表すベクトルにしたデータで表現される。 統計指標名は variantsStats 。

ワクチン接種の実施数の推移

実行ステップにおけるワクチン接種数について， 接種者の年代と接種の種類毎に分けたときのそれぞれの合計数をベクトルにしたデータで表し， 実行開始からの各ステップのデータをさらにベクトルにしたデータで表現する。 各ステップごとのベクトル内のデータは，1回目接種の年代別，2回目接種の年代別，ブースタ接種の年代別の順に 並べられる。年代は 10才間隔で 100才以上を含む 11 の区間で構成する。 つまり，各ステップのデータは $3\times 11 = 33$ 個の整数からなり，さらに先頭にステップの番号が加わる。 ステップ数が $1,280 \times 2^n \; (n = 0,1, \ldots)$ を越えるたびに， $2^{n+1}$ ステップ分のデータを合計しデータ量を圧縮する。 統計指標名は vaccination。

個体の位置と健康状態の取得

現在の全個体の位置と健康状態の一覧を取得する。

要求 GET /getPopulation

• format=JSONフォーマットオプション 省略可。
• me=ブラウザID 省略可。
• world=世界ID 省略可。

応答 Content-type: application/json

個体の XY座標と健康状態の種類を表す計3つの整数からなる配列を個体数分含む配列の形式で表現される。 XおよびYの値は，世界の大きさを 10,000 としたときの座標を表す整数。 健康状態は 0=未感染，1=無症状感染，2=発症，3=快復，4=死亡。 世界はフィールド，病院，墓地 の3つの領域に分かれており， フィールドは一辺の長さが 10,000 の正方形で，その右側に病院と墓地が配置される。 病院と墓地は，横 2,000，縦 5,000 の長方形で，病院が上，墓地が下に隣接した配置である。 病院と墓地の中の X座標は 10,000 以上，病院内の Y 座標は 5,000 以上，墓地内のY 座標は 5,000 未満である。 さらに移動中の個体についは，上の3つの整数に加え，目標位置の XY 座標を表す2つの整数と， 移動モードを表す1つの整数が加わった計6個の整数の配列で表現される。 移動モードの値の意味は，0=フィールド内移動，1=入院，2=フィールドから埋葬，3=病院から埋葬，4=退院 である。

例：現在の全個体の位置と健康状態を iframe に取り込む。

<form method="get" action="getPopulation" target="populationData">
<input type="submit" value="個体情報">
</form>
<iframe name="populationData"></iframe>

人口の大きさに比例してデータサイズが増加する。 サーバからは deflate 形式で圧縮されたデータが送られてくるが， ほとんどのブラウザでは受け取った時点で圧縮を解いてくれるので， クライアント側のプログラムは解凍処理を行う必要はない。 サーバから送出されるデータのサイズは人口1万人の場合，48〜58kバイト程度である。

要求 GET /getPopulation2

問い合わせ情報および応答ともに /getPopulation と同様であるが， 応答データにおける JSON の形式はつぎのようになる。 データ全体は5つの配列からなる配列であり，それぞれの配列は順番に 未感染，無症状感染，発症，快復，死亡に該当する個体の情報で構成される。 移動中の個体は，現在の XY座標，目標地点の XY 座標，移動モードの5つの整数からなる配列で表現される。 移動中でない個体は XY座標を表す 2つの整数からなる配列で表現される。

健康状態を個別に含む代わりに，健康状態ごとの集団として表現するので， 全体のデータ量は 2% ほど少なくなる。 また，健康状態ごとに色分けして表示する場合の計算効率の向上にも役立つ。

集団状態の保存と読み込み

シミュレーション実行を途中停止した状態で，その時点での集団の状態をサーバ内に保存し， 後にその内容を読み込みシミュレーションを続行することができる。 例えば，途中から様々に異なるパラメータ値を設定したときの推移の違いを観る場合などに役立つ。 保存の対象は，集団の状態，初期パラメータ値，および，統計指標の現在までの履歴である。 シナリオが設定されている場合は，シナリオ，シナリオの現在位置，および，現在のパラメータ値も保存される。

サーバ上に保存された状態の情報は，保存あるいは最後のアクセスから一定期間後に消去される。 この期間の長さはサーバプロセスの起動コマンドの -E または --stateExprHours オプションで指定する。 既定値は1週間である。 長期間保存したい場合は，ダウンロード機能を使いクライアント側のマシンに保存し， 使用するときにアップロード機能を用いてサーバ上に保存する。 サーバが複数ある場合，あるサーバからダウンロードした状態の情報を別のサーバにアップロードすることで，複製が可能である。 アップロードされた情報のサーバ上での保持期間も同様にサーバ上で保存された場合と同じである。

サーバ上での保存: GET /saveState

• me=ブラウザID 省略可。
• world=世界ID 省略可。

保存した 状態 ID を表す文字列をテキスト text/plain として応答する。

読み込み: GET /loadState

• ID=状態ID 必須。 保存の返答として得られる 状態 ID を指定する。
• me=ブラウザID 省略可。
• world=世界ID 省略可。

シミュレーションが実行中の場合はエラーになる。 それ以前の状態は，読み込まれた情報で上書きされる。

サーバ上の保存情報の消去: GET /removeState

• ID=状態ID 必須。

シナリオの設定

統計指標の変化を調べる条件とパラメータ値変更等の操作の列で表現される シナリオ を設定する。 シナリオが実行されるとパラメータ値が変化する。シミュレーション開始時点でのパラメータ値は， シナリオを設定した時点でのパラメータ値が初期値として記録され， 世界の初期化が行われるたびに，パラメータ値もその記録された値に戻る。 シナリオの設定は，世界が初期状態で停止中のときにだけ適用され， 実行が進んだ状態の場合はエラーになる。

要求 POST /setScenario

積載情報: Content-type: multipart/form-data

シナリオを表現する JSON データを含む。

例：ユーザが指定したファイルからパラメータを読み込み設定する。

<form method="post" action="setScenario"
     enctype="multipart/form-data" target="loadScenario">
<input type="file" name="upload" accept="application/json">
<input type="submit" value="読み込む">
</form>
応答: <iframe name="loadScenario" height=20></iframe>

積載情報: Content-type: x-www-form-urlencoded

• scenario=JSONデータ 必須。 設定したいシナリオを表現する JSON データの文字列を指定する。
• me=ブラウザID 省略可。
• world=世界ID 省略可。

上記２種類の積載情報のいずれの場合も，シナリオを表現する JSON データが空配列 [] である場合は， シナリオは消去される。

シナリオのデータ表現

シナリオは複数の，条件，追加感染者数，または，操作を要素とする配列である。

• 条件 : 配列または文字列型で表現される。配列の第1要素は文字列または整数，第2要素は文字列である。 配列の場合は，第2要素の文字列が条件を表す。 条件式を表現する文字列の記述は，条件用の統計指標の値と定数値の大小比較を基本述語とする。 比較演算子は ==, !=, >, >=, <, <= の6種類である。 それらを論理和 OR または論理積 AND で結合し，さらにそれらを入れ子にした式の文字列で表現することもできる。 入れ子の結合関係を明確にするため，式を () で囲むことができる。 指標名や演算子の間は空白で区切る。 配列の第1要素が整数の場合，条件が満たされた場合にシナリオ内の該当する要素に移動する。 整数の値は配列内の0から始まるインデックス番号である。 単独の文字列の場合，または，配列の第1要素が文字列の場合は，条件が満足されると，配列内のその次の要素に制御が移る。 配列の第1要素の文字列は注釈である。 いずれの場合も，条件が満足されるまでシミュレーションが実行される。
• 追加感染者数 : 整数または配列で表現される。この要素に実行が渡ると， 現在の世界にいる未感染者から指定された人数を選び，無症状感染者に変更する。 整数の場合は，変異ウイルスリストの先頭に登録されているウイルスに感染する。 配列の場合は，第1要素が新たな感染者の数，第2要素は個体の選択方法を表す整数，第3要素は変異ウイルスの名称である。 個体の選択方法と整数の対応は以下の通りである。 0 = ランダム，1 = 中央のクラスタ，2 = ランダムな位置のクラスタ。
• 操作 : 配列で表現される。配列の第1要素は操作対象のパラメータ名を表す文字列， 第2要素は新たに代入される数値である。値の型が実数または分布の場合，第3要素は第2要素の値になるまでの日数を表し，現在の値から目標の値に向かって経過ステップ数に比例して値が変更される。 第3要素がなければ直ちに第2要素の値に変更される。 操作可能なパラメータは，パラメータと型の表にある「世界」を除く 分類のパラメータである。 ワクチンの種類に依存する接種についてのパラメータ， および集会の種類に依存するパラメータの変更は以下のような特別の形式をとる。
• ワクチンの種類に依存する接種についてのパラメータ変更： 第1要素を，たとえば vaccinePerformRate PfBNT のように， vaccine に続いて先頭が大文字のパラメータ名， 1つの空白文字を挟んでワクチン名称が続く形式で指定する。 空白およびワクチン名が省略された場合は， ワクチンリストの先頭に登録されたワクチンが指定されたものとみなす。 最終ワクチン接種率の場合は，たとえば vaccineFinalRate 3 のように， vaccineFinalRate の後に1つの空白文字を挟んで年齢区間の番号を指定する。 区間番号は 0 から始まる。 もし指定された値がもとの値より大きければ，拒否個体の中から増加分を接種希望に変更する。 もとの値より小さな値が指定された場合は，未接種の個体を優先し接種希望の個体を拒否に変更する。 区間番号が指定されず vaccineFinalRate のみの場合は， 既存の最終接種率が 0 でない区間の年齢層，つまり，接種対象年齢層の最終接種率が配列の第2要素の値 $P'$ になるよう， 年齢区間 $i$ の最終接種率 $P_i$ を以下の式により変更する。 $$P'_i = \begin{cases} 0 & P_i = 0 \\ \displaystyle1-\frac{1-P'}{1-P}\cdot (1-P_i) & \mbox{otherwise} \end{cases}$$ ここで，$P$ は変更前の対象年齢層全体の最終接種率である。 その他のワクチン分類のパラメータはシナリオでの変更はできない。
• 集会の種類に依存するパラメータの変更： 第１要素を，たとえば regGat strength hischool のように， regGat に続いて集会リストに用いられるキーと集会名を空白で区切り指定する。

追加感染者数または操作の要素が配列内で連続して存在する場合は， それらの先頭に制御が移った時点で一気にそれらすべての要素が実行される。 制御がシナリオの最後に達した場合は，それ以上シナリオは実行されない。 世界が初期化された場合は，シナリオの制御は先頭に戻る。

アプリ版の SimEpidemic バージョン 1.6.2 以降では，シナリオを JSON 形式でも保存・読込が可能になっているので、 そのシナリオパネルで編集した内容をファイルに保存し利用することが可能である。 SimEpidemic のシナリオパネルで JSON 形式で保存するには，保存先のファイル名の拡張子を json にする。

条件用の統計指標

シナリオの条件として使える統計指標は以下の表のとおり。

バッチジョブの投入，監視，結果の取得

1つの ジョブ は，複数の 試行 からなる。ジョブごとにパラメータとシナリオと試行の数を指定する。 同じジョブに含まれる各試行は，同じパラメータとシナリオを用いて実行される。 ただし，試行はそれぞれ独立した乱数系列が使われるため，異なる実行結果となる。 試行に使う世界は，システムが必要に応じて生成し，不要になった時点で自動的に消去される。

同時に実行可能な試行の数は，サーバプロセスの実行開始時のコマンドオプション -T あるいは --maxTrials で指定する。 既定値は4である。ジョブは投入された順に実行される。

サーバの混雑度に合わせて適応的に並列化を使えるとよい。 また，ジョブごとの優先度を制御できるとよい。

投入: POST /submitJob

指定されたジョブを投入し，ジョブIDをテキストで返す。

積載情報: Content-type: multipart/form-data

投入したいジョブを表現する JSON データを含む。

積載情報: Content-type: x-www-form-urlencoded

• job=JSONデータ 必須 : 投入したいジョブを表現する JSON データの文字列を指定する。

ジョブのデータ表現

• 形式: {"stopAt": $D$, "params": $P$, "scenario": $S$, "n": $N$, "loadState": $ID$, "popDistMap": $F$, "loadVariantsAndVaccines": $V_f$, "vaccines": $V_a$, "variants": $V_r$, "loadGatherings": $G_f$, "gatherings": $G$, "out": [$O_1,O_2,\ldots,O_m$]}。
  
• パラメータ $P$ とシナリオ $S$ を用いたシミュレーションについて，最長 $D$ 日までの試行を $N$ 回繰り返し， $i\in \{1,2,\ldots,N\}$ なるすべての $i$ について $O_1,O_2\ldots,O_m$ で指定される結果データを ジョブID_タイプ_$i$ を識別子とする表データに格納する。 タイプ は indexes, daily, distribution, のいずれかで表のタイプを表す。 日数$D$が省略された場合は，終息するか最長実行時間に到達するまで実行される。 パラメータ$P$が省略された場合は，既定値世界に設定されているパラメータが使用される。 シナリオ$S$が省略された場合，シナリオの適用はない。 結果データの指定は必須である。
  
• 状態の読み込み: "loadState": $ID$ が指定された場合，状態を読み込み，その続きを実行する。 パラメータが指定された場合は，状態に含まれるパラメータ値がパラメータで指定したものに置き換わる。 シナリオの指定がある場合は，状態として保存されていたシナリオは消去され，指定されたシナリオに置き換わる。 サーバプロセスの起動時に --dataStorageR オプションが指定されていた場合， データがサーバ間の共有ディレクトリに保存されていれば， $ID$ の先頭にホスト名/ を付加することで，ホスト名で指定された他のサーバが保存した状態を読み込むことができる。
• 人口密度分布地図の読み込み: "popDistMap": $F$ が指定された場合は， サーバ上のデータ格納用ディレクトリの直下の PopDistMap というサブディレクトリの下にあらじめ保存された画像ファイル $F$ を，人口密度分布地図として読み込む。
• 変異ウイルスとワクチン情報の読み込み: "loadVariantsAndVaccines": $V_f$ が指定された場合は， サーバ上のデータ格納用ディレクトリの直下の VariantsAndVaccines というサブディレクトリの下にあらじめ JSON 形式で保存されたファイル $V_f$ を，変異ウイルスとワクチンのリストとして読み込む。
• ワクチンリストの設定: "vaccines": $V_a$ が指定された場合は， $V_a$ に含まれるワクチンが追加される。 同じ名前のワクチンが登録されている場合は指定された属性が追加または書き換えられる。 $V_a$ は各ワクチンの情報を表す辞書形式を要素とする配列でなければならない。
• 変異ウイルスリストの設定: "variants": $V_r$ が指定された場合は， $V_r$ に含まれる変異ウイルスが追加される。 同じ名前の変異ウイルスが登録されている場合は指定された属性が追加または書き換えられる。 $V_r$ は各変異ウイルスの情報を表す辞書形式を要素とする配列でなければならない。
• 集会リスト情報の読み込み: "loadGatherings": $G_f$ が指定された場合は， サーバ上のデータ格納用ディレクトリの直下の GatheringsList というサブディレクトリの下にあらじめ JSON 形式で保存されたファイル $G_f$ から集会リストを読み込む。
• 集会リストの設定: "gatherings": $G$ が指定された場合は， $G$ に含まれる集会設定が追加される。 同じ名前の集会が既に登録されている場合は指定された属性が書き換えられる。
• 結果データの指定: $O_i$ は，数値情報の統計指標名， 日ごと数値情報の統計指標，分布情報の統計指標名， または，重症度分布，変異ウイルス分布， ワクチン接種の実施数の推移を表す指標名である。 第1の形式の場合は現在値あるいは累積，第2の形式は統計指標名の先頭の文字を大文字に代え， その前に daily を付加した文字列で日ごとのデータを指す。 例えば，日ごとの新たな無症状感染者数は dailyAsymptomatic で表す。 ただし，陽性率は日ごと数値情報のみなので，daily を付加した形式を用いない。
• $O_i$ として "saveState" を指定すると，ジョブID_試行番号 をIDとして終了時の状態が保存される。

例

<form method="post" action="submitJob" target="submission">
    <textarea name="job" rows="10" cols="60">
{"stopAt":100,"n":3,
"params":{"stepsPerDay":4},
"out":[
    "asymptomatic","symptomatic","recovered","died",
    "dailyTestPositive","dailyTestNegative",
    "incubasionPeriod","recoveryPeriod","fatalPeriod","infects"]}
    </textarea>
    <input type="submit" value="投入">
    </form>
<iframe name="submission" height=24 onload="getJobID(this);"></iframe>

ジョブ投入時情報の取得: GET /getJobInfo

• job=ジョブID 必須

指定したジョブが投入されたときに指定したパラメータ情報を応答する。

待ち行列の監視: GET /getJobQueueStatus

• ジョブID=1 省略可 複数指定可能。

投入されたがまだ実行されていないジョブについての情報を応答する。 応答の形式は {"runningTrials": $T$, "length": $L$, ジョブID$_1$: $l_1$, ジョブID$_2$: $l_2,\ldots$, ジョブID$_n$: $l_n$}。 $T$ は現在実行中の試行数。$L$ は待ち行列の長さ。つまり，未実行のジョブの数。 $l_i$ は，ジョブID$_i$ の待ち行列の中での位置で， 先頭の場合 0 である。問い合わせ情報に指定されたジョブが，存在しないか，終了済みか，実行中の場合は， 応答には含まれない。

ジョブの監視: GET /getJobStatus

• job=ジョブID 必須
• worlds=真偽値 省略可

指定したジョブの進捗を応答する。 進捗: {"notYet":$B$, "nowProcessed":$C$, "finished":$F$} それぞれ $B$=未開始の試行の数，$C$=実行中の試行のステップ数の配列，$F$=終了の試行の数。 $B+|C|+F=N$ である。 worlds が省略されず，真が指定された場合は，さらに "worldIDs" をキーとする項目として， 実行中の試行に使われている世界の ID の配列が加わる。 真偽値は文字列 "on", "yes", "true" あるいは 0 以外の整数の場合「真」とみなされ，それ以外は「偽」となる。 文字列内の文字の大文字・小文字は区別されない。

ジョブの中止: GET /stopJob

• job=ジョブID 必須

指定されたジョブが実行中であれば，実行中の試行を停止し，未実行の試行があれば廃棄する。 終了済みおよび停止された試行の結果は取得可能である。*注

例：状態と実行中止ボタン

<form method="get" target="jobStatus">
    Job ID: <input class="JobID" type="text" name="job">
    <input type="submit" value="状態" formaction="getJobStatus">
    <input type="submit" value="実行中止" formaction="stopJob">
</form>
<iframe name="jobStatus" height=24 width=400></iframe>

結果の取得: GET /getJobResults

• job=ジョブID 必須
• save=ファイル名 省略可 指定された場合は，結果をそれぞれ タイプ_$i$.csv と名付けられた CSV形式のファイルに保存し， それらをまとめて圧縮した zip アーカイブ形式の ファイル名.zip と名付けられたファイルにダウンロードする。 $i$ は試行の番号，タイプ は indexes, daily, distribution のいずれかである。 省略された場合は，JSON データとして応答する。 ジョブ全体がまだ終了していない場合は，終わった試行の結果だけを返す。
• sep=欄区切り 省略可 save オプションが指定された場合， CSV 形式の欄区切り記号を指定する。 指定可能な値は，comma，tab，space の3つである。既定値は comma である。
• nl=行区切り 省略可 save オプションが指定された場合， CSV 形式の行区切り記号を指定する。 指定可能な値は，crlfとlfの2つである。既定値は lf である。*注

表形式データの内容

先頭行は各欄の表題の並びである。左端の欄はデータの内容により， 現在数および累積の場合は経過ステップ数，日ごとデータの場合は経過日数， 分布情報の場合は横軸の値であり，日数または人数である。その他のセルには対応する数値が入る。

JSON データでは {"jobID": ジョブID, "n": $i$, "type": タイプ, "table": $T$} の形式をとる。 $i$ は $1$〜$N$ の試行番号，タイプ は上述の3つのうちの1つで表のタイプを表す。 $T$ は表の本体であり，各行を1つの配列とし，それを行数分含む配列の形式になる。 先頭行の左端の要素は，便宜的に空文字列 "" が入る。 CSV データは，上述のとおり表ごとに別々のファイルに保存されるが， JSON データは表の配列の形式となる。

例：結果の JSON データを iframe に表示する。

<form method="get" action="getJobResults" target="jobResults">
    Job ID: <input class="JobID" type="text" name="job">
    <input type="submit" value="結果">
</form>
<iframe name="jobResults" width=400></iframe>

例：結果の CSV ファイルをダウンロードする。

<form method="get" action="getJobResults" target="jobResultSave">
    Job ID: <input class="JobID" type="text" name="job">
    File to save: <input type="text" name="save" value="MyResult">
    <input type="submit" value="保存">
</form>
<iframe name="jobResultSave" height=24></iframe>

結果記録の消去: GET /deleteJob

• job=ジョブID[,ジョブID2,...] 必須 指定された過去に実行されたジョブの記録と，そのジョブの終了時に保存された状態を消去する。 複数のジョブIDをコンマで区切って指定することもできる。 応答として消去の情報を表す text/pain の文字列が返る。 人口規模の大きなシミュレーションの記録はサーバの二次記憶を消費するので， 短期間に大量の大規模なシミュレーションを実行する場合は，このコマンドにより不要な記録を消去し， 空き領域不足による不具合を回避することができる。 *注

結果記録の延命: GET /touchJob

• job=ジョブID[,ジョブID2,...] 必須 指定された過去に実行されたジョブの記録と，そのジョブの終了時に保存された状態の有効期限を延長する。 複数のジョブIDをコンマで区切って指定することもできる。 応答として延命の情報を表す text/pain の文字列が返る。 ジョブの情報や保存された状態のファイルは有効期限が過ぎると自動的に消去される。 期限は最後のアクセスから既定値では一週間である。 この操作により，アクセス時刻が更新され，操作時点の１週間後まで有効期限が延長される。 保存期間はサーバプロセス起動時のオプションの指定により既定値と異なる期間にできる。 *注

*注 当該要求に対するサーバからの返答の後で結果データが作成されるため， 結果の，取得，消去，延命の要求までに時間を空ける必要がある。

JSONフォーマットオプション

• option として与える整数の意味
  1 ... pretty print ... 入れ子の深さに応じて段つけを行う。
  2 ... sorted keys ... 辞書内の要素をキー文字列のアルファベット順に並び替える。
  4 ... allow fragments ... 配列，辞書以外の要素のみのデータも許可する。このシステムでは無意味。
  8 ... without escaping slashes
  ビットごと論理和を取ることで複数のオプションを同時に設定する。
  既定値は0。

© Tatsuo Unemi, 2020, 2021, 2022. All rights reserved.