Skip to content

Commit

Permalink
Merge pull request #22 from muon-spectroscopy-computational-project/2…
Browse files Browse the repository at this point in the history
…0-update-the-documentation-1

update integer keyword list
  • Loading branch information
subindev-d authored Jun 12, 2024
2 parents 0e58e89 + b7aea59 commit 2ab6c90
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 1 deletion.
1 change: 1 addition & 0 deletions _sources/keywords.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@ Keywords that take an integer number as value.
* :literal:`max_state_iter`: maximum number of iterations to perform when searching for a state. This loop encloses both node-based and energy-based search. Once a state is converged, the program checks again that it has the correct number of nodes. If it does not, the state is stored for future use and to provide an upper or lower limit to the energy of the searches and then the process is repeated. This number represents how much can the process be repeated before failing. Should not generally need to be adjusted. Default is 100.
* :literal:`uehling_steps`: integration steps for the Uehling potential. Higher numbers will make the Uehling energy more precise but increase computation times. Default is 100.
* :literal:`xr_print_precision`: number of digits after the point to use when printing out energies and transition rates in the :literal:`.xr.out` file. Default is -1 (print as many as possible).
* :literal:`state_print_precision`: number of digits after the point to use when printing out energies and transition rates in the :literal:`.{state name}.out` files. Default is -1 (print as many as possible). Only has effect if :literal:`output >= 2`.
* :literal:`verbosity`: verbosity level. Going from 1 to 3 will increase the amount of information printed to the log file. Default is 1.
* :literal:`output`: output level. Going from 1 to 3 will increase the amount of files produced. Specifically:
1. will print out only the transition energies and rates in the :literal:`.xr.out` file;
Expand Down
1 change: 1 addition & 0 deletions keywords.html
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,7 @@ <h2>Integer keywords<a class="headerlink" href="#integer-keywords" title="Link t
<li><p><code class="docutils literal notranslate"><span class="pre">max_state_iter</span></code>: maximum number of iterations to perform when searching for a state. This loop encloses both node-based and energy-based search. Once a state is converged, the program checks again that it has the correct number of nodes. If it does not, the state is stored for future use and to provide an upper or lower limit to the energy of the searches and then the process is repeated. This number represents how much can the process be repeated before failing. Should not generally need to be adjusted. Default is 100.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">uehling_steps</span></code>: integration steps for the Uehling potential. Higher numbers will make the Uehling energy more precise but increase computation times. Default is 100.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">xr_print_precision</span></code>: number of digits after the point to use when printing out energies and transition rates in the <code class="docutils literal notranslate"><span class="pre">.xr.out</span></code> file. Default is -1 (print as many as possible).</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">state_print_precision</span></code>: number of digits after the point to use when printing out energies and transition rates in the <code class="docutils literal notranslate"><span class="pre">.{state</span> <span class="pre">name}.out</span></code> files. Default is -1 (print as many as possible). Only has effect if <code class="docutils literal notranslate"><span class="pre">output</span> <span class="pre">&gt;=</span> <span class="pre">2</span></code>.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">verbosity</span></code>: verbosity level. Going from 1 to 3 will increase the amount of information printed to the log file. Default is 1.</p></li>
<li><dl class="simple">
<dt><code class="docutils literal notranslate"><span class="pre">output</span></code>: output level. Going from 1 to 3 will increase the amount of files produced. Specifically:</dt><dd><ol class="arabic simple">
Expand Down
Loading

0 comments on commit 2ab6c90

Please sign in to comment.