Skip to content

Commit

Permalink
Deploy docs to develop by GitHub Actions triggered by 5c47712
Browse files Browse the repository at this point in the history
  • Loading branch information
2DMAT Developers committed Mar 25, 2024
1 parent 51ddf88 commit 8035bf8
Show file tree
Hide file tree
Showing 6 changed files with 42 additions and 62 deletions.
30 changes: 12 additions & 18 deletions manual/develop/en/_sources/solver/sim-trhepd-rheed.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion manual/develop/en/searchindex.js

Large diffs are not rendered by default.

28 changes: 12 additions & 16 deletions manual/develop/en/solver/sim-trhepd-rheed.html
Original file line number Diff line number Diff line change
Expand Up @@ -83,20 +83,16 @@ <h3>[<code class="docutils literal notranslate"><span class="pre">solver.config<
</li>
<li><p><code class="docutils literal notranslate"><span class="pre">calculated_first_line</span></code></p>
<p>Format: integer (default: 5)</p>
<p>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.</p>
</li>
<li><p><code class="docutils literal notranslate"><span class="pre">calculated_last_line</span></code></p>
<p>Format: integer (default: 60)</p>
<p>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.</p>
<p>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.</p>
</li>
<li><p><code class="docutils literal notranslate"><span class="pre">calculated_info_line</span></code></p>
<p>Format: integer (default: 2)</p>
<p>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).</p>
<p>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).</p>
</li>
<li><p><code class="docutils literal notranslate"><span class="pre">cal_number</span></code></p>
<p>Format: List of integers</p>
<p>Description: Columns of dataset to be read. Multiple columns can be specified (many-beam condition).</p>
<p>Format: Integer or List of integers</p>
<p>Description: In the output file, the columns to be read as D(x). Multiple columns can be specified (many-beam condition).</p>
</li>
</ul>
</section>
Expand Down Expand Up @@ -190,19 +186,19 @@ <h3>[<code class="docutils literal notranslate"><span class="pre">solver.referen
<ul>
<li><p><code class="docutils literal notranslate"><span class="pre">path</span></code></p>
<p>Format: string (default: <code class="docutils literal notranslate"><span class="pre">experiment.txt</span></code>)</p>
<p>Description: Path to the experimental data file.</p>
<p>Description: Path to the reference data file.</p>
</li>
<li><p><code class="docutils literal notranslate"><span class="pre">reference_first_line</span></code></p>
<p>Format: integer (default: 1)</p>
<p>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.</p>
<p>Format: integer</p>
<p>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.</p>
</li>
<li><p><code class="docutils literal notranslate"><span class="pre">reference_last_line</span></code></p>
<p>Format: integer (default: 56)</p>
<p>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.</p>
<p>Format: integer</p>
<p>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.</p>
</li>
<li><p><code class="docutils literal notranslate"><span class="pre">exp_number</span></code></p>
<p>Format: List of integers</p>
<p>Description: Columns of dataset to be read. Multiple columns can be specified (many-beam condition).</p>
<p>Format: Integer or List of integers</p>
<p>Description: In the reference data file, the column numbers to be read. Multiple columns can be specified (many-beam condition).</p>
</li>
</ul>
</section>
Expand Down
22 changes: 8 additions & 14 deletions manual/develop/ja/_sources/solver/sim-trhepd-rheed.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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``] セクション(サブセクション)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Expand Down Expand Up @@ -188,21 +182,21 @@

- ``reference_first_line``

形式: 整数型 (default: 1)
形式: 整数型

説明: 実験データファイルを読み込む範囲を指定するパラメータ。実験ファイルを読み込む最初の行を指定
説明: 実験データファイル中、実験データを読み出す最初の行の番号。省略時は1, すなわち先頭行から読み出します

- ``reference_last_line``

形式: 整数型 (default: 実験データファイルの最後の行の行数)

説明: 実験データファイルを読み込む範囲を指定するパラメータ。実験ファイルを読み込む最後の行を指定
説明: 実験データファイル中、実験データを読み出す最後の行の番号。省略時は最終行まで読み出します

- ``exp_number``

形式: 整数型のリスト (default: []、設定必須)
形式: 整数型のリスト

説明: 実験データファイルを読み込む範囲を指定するパラメータ。読み込むデータ列を指定。複数指定が可能。設定した値は、前述の ``cal_number`` ([``config``] セクション)の値とリストの長さを一致させる必要があります。
説明: 実験データファイル中、実験データとして読み出す列番号。複数指定が可能。設定した値は、前述の ``cal_number`` ([``config``] セクション)の値とリストの長さを一致させる必要があります。

ソルバー用補助ファイル
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down
2 changes: 1 addition & 1 deletion manual/develop/ja/searchindex.js

Large diffs are not rendered by default.

20 changes: 8 additions & 12 deletions manual/develop/ja/solver/sim-trhepd-rheed.html
Original file line number Diff line number Diff line change
Expand Up @@ -84,19 +84,15 @@ <h3>[<code class="docutils literal notranslate"><span class="pre">config</span><
</li>
<li><p><code class="docutils literal notranslate"><span class="pre">calculated_first_line</span></code></p>
<p>形式: 整数型 (default: 5)</p>
<p>説明: ソルバーにより計算された出力ファイルを読み込む範囲を指定するパラメータ。読み込む最初の行を指定。</p>
</li>
<li><p><code class="docutils literal notranslate"><span class="pre">calculated_last_line</span></code></p>
<p>形式: 整数型 (default: 5 + [<code class="docutils literal notranslate"><span class="pre">reference</span></code>] セクション(サブセクション)にて指定した実験データファイルの視写角数 - 1)</p>
<p>説明: ソルバーにより計算された出力ファイルを読み込む範囲を指定するパラメータ。読み込む最後の行を指定。</p>
<p>説明: <code class="docutils literal notranslate"><span class="pre">surface_output_file</span></code> ファイル中, D(x) として読み込む最初の行。 なお、最終行は実験データとして読み込んだ行数から自動計算されます。</p>
</li>
<li><p><code class="docutils literal notranslate"><span class="pre">calculated_info_line</span></code></p>
<p>形式: 整数型 (default: 2)</p>
<p>説明: ソルバーにより計算された出力ファイルの行を指定するパラメータ。出力ファイル内に記されているglancing angle数やbeam数が記してある行を指定</p>
<p>説明: <code class="docutils literal notranslate"><span class="pre">surface_output_file</span></code> ファイル中, glancing angle数やbeam数が記してある行番号</p>
</li>
<li><p><code class="docutils literal notranslate"><span class="pre">cal_number</span></code></p>
<p>形式: 整数型のリスト (設定必須)</p>
<p>説明: ソルバーにより計算された出力ファイルを読み込む範囲を指定するパラメータ。読み込むデータ列を指定。複数指定が可能。設定した値は、後述の <code class="docutils literal notranslate"><span class="pre">exp_number</span></code> ([<code class="docutils literal notranslate"><span class="pre">reference</span></code>] セクション)の値とリストの長さを一致させる必要があります。</p>
<p>説明: <code class="docutils literal notranslate"><span class="pre">surface_output_file</span></code> ファイル中, データとして読み出す列番号。複数指定が可能。設定した値は、後述の <code class="docutils literal notranslate"><span class="pre">exp_number</span></code> ([<code class="docutils literal notranslate"><span class="pre">reference</span></code>] セクション)の値とリストの長さを一致させる必要があります。</p>
</li>
</ul>
</section>
Expand Down Expand Up @@ -190,16 +186,16 @@ <h3>[<code class="docutils literal notranslate"><span class="pre">reference</spa
<p>説明: 実験データファイルへのパス。</p>
</li>
<li><p><code class="docutils literal notranslate"><span class="pre">reference_first_line</span></code></p>
<p>形式: 整数型 (default: 1)</p>
<p>説明: 実験データファイルを読み込む範囲を指定するパラメータ。実験ファイルを読み込む最初の行を指定</p>
<p>形式: 整数型</p>
<p>説明: 実験データファイル中、実験データを読み出す最初の行の番号。省略時は1, すなわち先頭行から読み出します</p>
</li>
<li><p><code class="docutils literal notranslate"><span class="pre">reference_last_line</span></code></p>
<p>形式: 整数型 (default: 実験データファイルの最後の行の行数)</p>
<p>説明: 実験データファイルを読み込む範囲を指定するパラメータ。実験ファイルを読み込む最後の行を指定</p>
<p>説明: 実験データファイル中、実験データを読み出す最後の行の番号。省略時は最終行まで読み出します</p>
</li>
<li><p><code class="docutils literal notranslate"><span class="pre">exp_number</span></code></p>
<p>形式: 整数型のリスト (default: []、設定必須)</p>
<p>説明: 実験データファイルを読み込む範囲を指定するパラメータ。読み込むデータ列を指定。複数指定が可能。設定した値は、前述の <code class="docutils literal notranslate"><span class="pre">cal_number</span></code> ([<code class="docutils literal notranslate"><span class="pre">config</span></code>] セクション)の値とリストの長さを一致させる必要があります。</p>
<p>形式: 整数型のリスト</p>
<p>説明: 実験データファイル中、実験データとして読み出す列番号。複数指定が可能。設定した値は、前述の <code class="docutils literal notranslate"><span class="pre">cal_number</span></code> ([<code class="docutils literal notranslate"><span class="pre">config</span></code>] セクション)の値とリストの長さを一致させる必要があります。</p>
</li>
</ul>
</section>
Expand Down

0 comments on commit 8035bf8

Please sign in to comment.