LMU/musrfit
5
0
Fork 0
Code Issues 6 Pull Requests Actions Packages Projects Releases 4 Activity

updated the docu.

Browse Source
This commit is contained in:
suter_a
2024-06-24 09:44:07 +02:00
parent 64d3b6192b
commit ebefcf7af9
20 changed files with 74 additions and 54 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
doc/html/user-manual.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>User manual &mdash; musrfit 1.9.4 documentation</title>
<title>User manual &mdash; musrfit 1.9.5 documentation</title>
@ -257,6 +257,26 @@
<dt><strong>-u, –use-no-of-threads &lt;number&gt;</strong></dt>
<dd>&lt;number&gt;: number of threads to be used (OpenMP). Needs to be &lt;= max. number of cores.
If OpenMP is enable, the maximal number of cores is used, if it is not limited by this option.</dd>
<dt><strong>-r, –reset</strong></dt>
<dd><p class="first">reset startup <code class="docutils literal notranslate"><span class="pre">musrfit_startup.xml</span></code>, i.e. rewrite a default, and quit.
The order of which <code class="docutils literal notranslate"><span class="pre">musrfit_startup.xml</span></code> is reset is:</p>
<blockquote class="last">
<div><ol class="arabic simple">
<li>if present in the current dir.</li>
<li>if present under <code class="docutils literal notranslate"><span class="pre">$HOME/.musrfit/</span></code></li>
<li>if present under <code class="docutils literal notranslate"><span class="pre">$MUSRFITPATH/</span></code></li>
<li>if present under <code class="docutils literal notranslate"><span class="pre">$ROOTSYS/</span></code></li>
</ol>
</div></blockquote>
</dd>
<dt><strong>-y, –yaml</strong></dt>
<dd><p class="first">write fit results (<code class="docutils literal notranslate"><span class="pre">MINUIT2.OUTPUT</span></code>) into a yaml-file. Output <code class="docutils literal notranslate"><span class="pre">&lt;msr-file&gt;.yaml</span></code>.</p>
<p class="last">The motivation for storing parameter information in this (hierarchical) manner is to provide easy access to details that are cumbersome
to store/access in tabular formats (e.g., <code class="docutils literal notranslate"><span class="pre">CSV</span></code> or <code class="docutils literal notranslate"><span class="pre">TSV</span></code>). This is especially true for the parameter covariance/correlation matrices.
The advantage is evident when processing the contents of the <code class="docutils literal notranslate"><span class="pre">.yaml</span></code> output, which can be easily accomplished using one of the
YAML parsers implemented in your favourite programming language (see, e.g., <a class="reference external" href="https://yaml.org/">https://yaml.org/</a> for a list of options). As an example,
this can be achieved in <code class="docutils literal notranslate"><span class="pre">Python</span></code> using the <code class="docutils literal notranslate"><span class="pre">PyYAML</span></code>.</p>
</dd>
<dt><strong>–dump &lt;type&gt;</strong></dt>
<dd>is writing a data file with the fit data and the theory; &lt;type&gt; can be ascii (data in columns) or root (data in ROOT histograms).</dd>
<dt><strong>–timeout &lt;timeout_tag&gt;</strong></dt>
@ -2874,7 +2894,7 @@ The syntax here is attribute driven</li>
<div role="contentinfo">
<p>
&copy; Copyright 2023, Andreas Suter.
Last updated on Jun 08, 2024.
Last updated on Jun 24, 2024.
</p>
</div>
@ -2896,7 +2916,7 @@ The syntax here is attribute driven</li>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'1.9.4',
VERSION:'1.9.5',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',