(sim-trhepd-rheed) accept an integer for cal_number / exp_number

doc/en/source/solver/sim-trhepd-rheed.rst

@@ -62,26 +62,20 @@ Input parameters can be specified in subsections ``config``, ``post``, ``param``
 
   Format: integer (default: 5)
 
-  Description: One of the parameters that specifies the range of output files to be read, calculated by the solver. This parameter specifies the first line to be read.
-
-- ``calculated_last_line``
-
-  Format: integer (default: 60)
-
-  Description: One of the parameters that specifies the range of output files to be read, calculated by the solver. This parameter specifies the last line to be read.
+  Description: In the output file, the first line to be read as D(x).
+  The last line is automatically calculated from the number of the reference data.
 
 - ``calculated_info_line``
 
   Format: integer (default: 2)
 
-  Description: One of the parameters that specifies the range of output files to be read, calculated by the solver.
-  This parameter specifies the line to be read, which contains the number of glancing angles (second column) and the number of beams (third column).
+  Description: In the output file, the line contains the information of the calculated data -- the number of glancing angles (second column) and the number of beams (third column).
 
 - ``cal_number``
 
-  Format: List of integers
+  Format: Integer or List of integers
 
-  Description: Columns of dataset to be read. Multiple columns can be specified (many-beam condition).
+  Description: In the output file, the columns to be read as D(x). Multiple columns can be specified (many-beam condition).
 
 
 [``solver.post``] subsection
@@ -188,25 +182,25 @@ This subsection is used to the postprocess -- to specify how to calculate the ob
 
   Format: string (default: ``experiment.txt``)
 
-  Description: Path to the experimental data file.
+  Description: Path to the reference data file.
 
 - ``reference_first_line``
 
-  Format: integer (default: 1)
+  Format: integer
 
-  Description: One of the parameters that specify the range of experimental data files to be read. This parameter specifies the first line of the experimental file to be read.
+  Description: In the reference data file, the first line to be read as Dexp. The default value is 1, that is, the first line of the file.
 
 - ``reference_last_line``
 
-  Format: integer (default: 56)
+  Format: integer
 
-  Description: One of the parameters that specify the range of experimental data files to be read. This parameter specifies the last line of the experimental file to be read.
+  Description: In the reference data file, the last line to be read as Dexp. If omitted, all lines from the first line to the end of the file will be read.
 
 - ``exp_number``
 
-  Format: List of integers
+  Format: Integer or List of integers
 
-  Description: Columns of dataset to be read. Multiple columns can be specified (many-beam condition).
+  Description: In the reference data file, the column numbers to be read. Multiple columns can be specified (many-beam condition).
 
 
 Reference file

doc/ja/source/solver/sim-trhepd-rheed.rst

@@ -63,25 +63,19 @@
 
   形式: 整数型 (default: 5)
 
-  説明: ソルバーにより計算された出力ファイルを読み込む範囲を指定するパラメータ。読み込む最初の行を指定。
-
-- ``calculated_last_line``
-
-  形式: 整数型 (default: 5 + [``reference``] セクション（サブセクション）にて指定した実験データファイルの視写角数 - 1)
-
-  説明: ソルバーにより計算された出力ファイルを読み込む範囲を指定するパラメータ。読み込む最後の行を指定。
+  説明: ``surface_output_file`` ファイル中, D(x) として読み込む最初の行。 なお、最終行は実験データとして読み込んだ行数から自動計算されます。
 
 - ``calculated_info_line``
 
   形式: 整数型 (default: 2)
 
-  説明: ソルバーにより計算された出力ファイルの行を指定するパラメータ。出力ファイル内に記されているglancing angle数やbeam数が記してある行を指定。
+  説明: ``surface_output_file`` ファイル中, glancing angle数やbeam数が記してある行番号。
 
 - ``cal_number``
 
   形式: 整数型のリスト (設定必須)
 
-  説明: ソルバーにより計算された出力ファイルを読み込む範囲を指定するパラメータ。読み込むデータ列を指定。複数指定が可能。設定した値は、後述の ``exp_number`` （[``reference``] セクション）の値とリストの長さを一致させる必要があります。
+  説明: ``surface_output_file`` ファイル中, データとして読み出す列番号。複数指定が可能。設定した値は、後述の ``exp_number`` （[``reference``] セクション）の値とリストの長さを一致させる必要があります。
 
 [``post``] セクション（サブセクション）
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -188,21 +182,21 @@
 
 - ``reference_first_line``
 
-  形式: 整数型 (default: 1)
+  形式: 整数型
 
-  説明: 実験データファイルを読み込む範囲を指定するパラメータ。実験ファイルを読み込む最初の行を指定。
+  説明: 実験データファイル中、実験データを読み出す最初の行の番号。省略時は1, すなわち先頭行から読み出します。
 
 - ``reference_last_line``
 
   形式: 整数型 (default: 実験データファイルの最後の行の行数)
 
-  説明: 実験データファイルを読み込む範囲を指定するパラメータ。実験ファイルを読み込む最後の行を指定。
+  説明: 実験データファイル中、実験データを読み出す最後の行の番号。省略時は最終行まで読み出します。
 
 - ``exp_number``
 
-  形式: 整数型のリスト (default: []、設定必須)
+  形式: 整数型のリスト
 
-  説明: 実験データファイルを読み込む範囲を指定するパラメータ。読み込むデータ列を指定。複数指定が可能。設定した値は、前述の ``cal_number`` （[``config``] セクション）の値とリストの長さを一致させる必要があります。
+  説明: 実験データファイル中、実験データとして読み出す列番号。複数指定が可能。設定した値は、前述の ``cal_number`` （[``config``] セクション）の値とリストの長さを一致させる必要があります。
 
 ソルバー用補助ファイル
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

src/py2dmat/solver/sim_trhepd_rheed.py

@@ -530,7 +530,8 @@ def __init__(self, info, isLogmode, detail_timer):
             self.beam_number_exp_raw = data_experiment.shape[1]
 
             v = info_ref.get("exp_number", [])
-
+            if isinstance(v, int):
+                v = [v]
             if len(v) == 0:
                 raise exception.InputError("ERROR: You have to set the 'solver.reference.exp_number'.")
 
@@ -647,6 +648,8 @@ def __init__(self, info, isLogmode, detail_timer):
             self.calculated_info_line = v
 
             v = info_config.get("cal_number", [])
+            if isinstance(v, int):
+                v = [v]
             if len(v) == 0:
                 raise exception.InputError("ERROR: You have to set the 'solver.config.cal_number'.")