ユーザープログラムによる解析¶

ここでは、odatse-STR モジュールを用いたユーザプログラムを作成し、解析を行う方法を説明します。逆問題アルゴリズムは例としてNelder-Mead法を用います。

サンプルファイルの場所¶

サンプルファイルは sample/single_beam/user_program にあります。フォルダには以下のファイルが格納されています。

simple.py

メインプログラム。パラメータを input.toml ファイルから読み込んで解析を行う。
input.toml

simple.py で利用する入力パラメータファイル
experiment.txt, template.txt

メインプログラムでの計算を進めるための参照ファイル
ref.txt

本チュートリアルで求めたい回答が記載されたファイル
simple2.py

メインプログラムの別バージョン。パラメータを dict 形式でスクリプト内に埋め込んでいる。
prepare.sh , do.sh

本チュートリアルを一括計算するために準備されたスクリプト

以下、これらのファイルについて説明したのち、実際の計算結果を紹介します。

プログラムの説明¶

simple.py は odatse-STR モジュールを用いて解析を行うシンプルなプログラムです。プログラムの全体を以下に示します。

import numpy as np

import odatse
import odatse.algorithm.min_search
from odatse.extra.STR import Solver

info = odatse.Info.from_file("input.toml")

solver = Solver(info)
runner = odatse.Runner(solver, info)
alg = odatse.algorithm.min_search.Algorithm(info, runner)
alg.main()

プログラムではまず、必要なモジュールを import します。

ODAT-SE のメインモジュール odatse
今回利用する逆問題解析アルゴリズム odatse.algorithm.min_search
順問題ソルバーモジュール odatse.extra.STR

次に、解析で利用するクラスのインスタンスを作成します。

odatse.Info クラス

パラメータを格納するクラスです。 from_file クラスメソッドに TOML ファイルのパスを渡して作成することができます。
odatse.extra.STR.Solver クラス

odatse-STR モジュールの順問題ソルバーです。Info クラスのインスタンスを渡して作成します。
odatse.Runner クラス

順問題ソルバーと逆問題解析アルゴリズムを繋ぐクラスです。Solver クラスのインスタンスおよび Info クラスのパラメータを渡して作成します。
odatse.algorithm.min_search.Algorithm クラス

逆問題解析アルゴリズムのクラスです。ここでは Nelder-Mead法による最適化アルゴリズムのクラスモジュール min_search を利用します。Runner のインスタンスを渡して作成します。

Solver, Runner, Algorithm の順にインスタンスを作成した後、Algorithm クラスの main() メソッドを呼んで解析を行います。

上記のプログラムでは、入力パラメータを TOML形式のファイルから読み込む形ですが、パラメータを dict 形式で渡すこともできます。 simple2.py はパラメータをプログラム中に埋め込む形式で記述したものです。以下にプログラムの全体を記載します。

import numpy as np

import odatse
import odatse.algorithm.min_search
from odatse.extra.STR import Solver

params = {
    "base": {
        "dimension": 3,
        "output_dir": "output",
    },
    "solver": {
        "run_scheme": "subprocess",
        "generate_rocking_curve": True,
        "config": {
            "cal_number": [1],
        },
        "param": {
            "string_list": ["value_01", "value_02", "value_03"],
        },
        "reference": {
            "path": "experiment.txt",
            "exp_number": [1],
        },
        "post": {
            "normalization": "TOTAL",
        },
    },
    "algorithm": {
        "label_list": ["z1", "z2", "z3"],
        "param": {
            "min_list": [ 0.0, 0.0, 0.0 ],
            "max_list": [ 10.0, 10.0, 10.0 ],
            "initial_list": [ 5.25, 4.25, 3.50],
        },
    },
}

info = odatse.Info(params)

solver = Solver(info)
runner = odatse.Runner(solver, info)
alg = odatse.algorithm.min_search.Algorithm(info, runner)
alg.main()

dict 形式のパラメータを渡して Info クラスのインスタンスを作成します。同様に、パラメータをプログラム内で生成して渡すこともできます。

入力ファイルの説明¶

メインプログラム用の入力ファイル input.toml は前述のNelder-Mead法による最適化で用いたのと同じファイルを利用できます。なお、アルゴリズムの種類を指定する algorithm.name パラメータの値は無視されます。

その他、 template.txt, experiment.txt ファイルは前述の tutorial と同様です。

計算実行¶

最初にサンプルファイルが置いてあるフォルダへ移動します(以下、本ソフトウェアをダウンロードしたディレクトリ直下にいることを仮定します).

$ cd sample/single_beam/user_program

bulk.exe と surf.exe をコピーします。

$ cp ../../sim-trhepd-rheed/src/bulk.exe .
$ cp ../../sim-trhepd-rheed/src/surf.exe .

bulk.exe を実行し、 bulkP.b を作成します。

$ ./bulk.exe

そのあとに、メインプログラムを実行します(計算時間は通常のPCで数秒程度で終わります)。

$ python3 simple.py | tee log.txt

実行すると、以下の様な出力がされます。

name            : minsearch
label_list      : ['z1', 'z2', 'z3']
param.min_list  : [0.0, 0.0, 0.0]
param.max_list  : [10.0, 10.0, 10.0]
param.initial_list: [5.25, 4.25, 3.5]
eval: x=[5.25 4.25 3.5 ], fun=0.015199252435883206
eval: x=[5.22916667 4.3125     3.64583333], fun=0.013702918645281299
eval: x=[5.22569444 4.40625    3.54513889], fun=0.01263527811899235
eval: x=[5.17997685 4.34895833 3.5943287 ], fun=0.006001659635528168
eval: x=[5.17997685 4.34895833 3.5943287 ], fun=0.006001659635528168
eval: x=[5.22066294 4.33260995 3.60408629], fun=0.005145496928704404
eval: x=[5.22066294 4.33260995 3.60408629], fun=0.005145496928704404
eval: x=[5.2185245  4.32627234 3.56743818], fun=0.0032531465329236025
eval: x=[5.19953437 4.34549482 3.5863457 ], fun=0.0027579225484420356
eval: x=[5.21549776 4.35100199 3.57476018], fun=0.002464573036316852
...

x= に各ステップでの候補パラメータ、その時のR-factorの値が fun= に出力されます。また各ステップでの計算結果は output/0/LogXXXX_YYYY (XXXX, YYYYはステップ数)のフォルダに出力されます。最終的に推定されたパラメータは、 output/res.dat に出力されます。今の場合、

z1 = 5.230524973874179
z2 = 4.370622919269477
z3 = 3.5961444501081647

となります。リファレンス ref.txt が再現されていることが分かります。

なお、一連の計算を行う do.sh スクリプトが用意されています。