Files
muSRFlow/docs/_build/html/results-diagnostics.html
salman 95b0cd8dcc Illustrate user manual and include documentation in web deployment
Add real pre-fit UI screenshots, workflow diagrams, accessible captions, and image maintenance instructions. Correct run-count examples and rebuild the tracked HTML and PDF manuals.

Deploy the complete generated HTML manual with readable permissions. Check for missing documentation before modifying installed files and cover deployment, updates, and missing-doc failures with regression tests.
2026-10-30 16:25:53 +01:00

195 lines
11 KiB
HTML

<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="./">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Results and diagnostics &mdash; muSRFlow User Manual</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=d11f710b" />
<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=8085e645"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Configuration sharing" href="configuration-sharing.html" />
<link rel="prev" title="MSR editor" href="msr-editor.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home">
muSRFlow
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Contents</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="overview.html">Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting-started.html">Getting started</a></li>
<li class="toctree-l1"><a class="reference internal" href="install-windows.html">Windows installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="install-linux.html">Linux installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="runs-fitting.html">Runs and fitting</a></li>
<li class="toctree-l1"><a class="reference internal" href="parameters-plots.html">Parameters and parameter plots</a></li>
<li class="toctree-l1"><a class="reference internal" href="constraints.html">Constraints</a></li>
<li class="toctree-l1"><a class="reference internal" href="t0-background.html">t0 / background</a></li>
<li class="toctree-l1"><a class="reference internal" href="msr-editor.html">MSR editor</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Results and diagnostics</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#result-files">Result files</a></li>
<li class="toctree-l2"><a class="reference internal" href="#execution-details">Execution details</a></li>
<li class="toctree-l2"><a class="reference internal" href="#command-log">Command log</a></li>
<li class="toctree-l2"><a class="reference internal" href="#the-status-bar">The status bar</a></li>
<li class="toctree-l2"><a class="reference internal" href="#run-log-window">Run log window</a></li>
<li class="toctree-l2"><a class="reference internal" href="#outcome-dialog">Outcome dialog</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="configuration-sharing.html">Configuration sharing</a></li>
<li class="toctree-l1"><a class="reference internal" href="preferences.html">Preferences</a></li>
<li class="toctree-l1"><a class="reference internal" href="platforms.html">Web and desktop editions</a></li>
<li class="toctree-l1"><a class="reference internal" href="keyboard-shortcuts.html">Keyboard shortcuts</a></li>
<li class="toctree-l1"><a class="reference internal" href="troubleshooting.html">Troubleshooting</a></li>
<li class="toctree-l1"><a class="reference internal" href="glossary.html">Glossary</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">muSRFlow</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">Results and diagnostics</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/results-diagnostics.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="results-and-diagnostics">
<h1>Results and diagnostics<a class="headerlink" href="#results-and-diagnostics" title="Link to this heading"></a></h1>
<p>The <strong>Results</strong> tab collects what each Fit or Plot produced: the generated
files, the execution details, and the full command log. The status bar at the
bottom of the main window gives the short-lived state without opening the
tab.</p>
<section id="result-files">
<h2>Result files<a class="headerlink" href="#result-files" title="Link to this heading"></a></h2>
<p>The primary artifact is the <strong>Result MSR</strong> – the fitted document that
contains the converged parameter block. Under <strong>Other files</strong> the tab lists:</p>
<ul class="simple">
<li><p><strong>ROOT plot</strong> – the ROOT canvas produced for the spectra display.</p></li>
<li><p><strong>Template MSR</strong> – the template the document was generated from.</p></li>
<li><p><strong>Output log</strong> – the full output of the run.</p></li>
<li><p><strong>Parameter data</strong> – the <code class="docutils literal notranslate"><span class="pre">par.dat</span></code> parameter table that feeds the
parameter plots.</p></li>
<li><p><strong>All files</strong> – a link to the whole artifact package.</p></li>
</ul>
<p>On the desktop the links open the files on your machine; on the web they
download or display the server-side artifact.</p>
</section>
<section id="execution-details">
<h2>Execution details<a class="headerlink" href="#execution-details" title="Link to this heading"></a></h2>
<p>A collapsible <strong>Execution details</strong> block records when the action started and
finished, the process exit code, and whether the GUI parameter table and the
fitted result were synchronised afterwards.</p>
</section>
<section id="command-log">
<h2>Command log<a class="headerlink" href="#command-log" title="Link to this heading"></a></h2>
<p>The command log is the authoritative record: every command line muSRFlow
invoked, in order, with its arguments. It appears in the tab and in the
pop-up run log explained below. Use it to reproduce an analysis by hand or to
diagnose unexpected behaviour.</p>
</section>
<section id="the-status-bar">
<h2>The status bar<a class="headerlink" href="#the-status-bar" title="Link to this heading"></a></h2>
<p>The status bar under the main window keeps a terse permanent status:</p>
<ul class="simple">
<li><p>the <strong>state</strong> button (for example <code class="docutils literal notranslate"><span class="pre">Idle</span></code>, <code class="docutils literal notranslate"><span class="pre">Running</span> <span class="pre">musrfit</span></code>) – click it
to open the run log immediately;</p></li>
<li><p>the <strong>fit statistic</strong> (for example <code class="docutils literal notranslate"><span class="pre">χ²/NDF</span> <span class="pre">1.012</span></code>), kept from the fit
so a later plot does not erase it. For an independent-series fit the button
instead shows the worst/best aggregate of the per-run statistics (or
<code class="docutils literal notranslate"><span class="pre">Series</span> <span class="pre">did</span> <span class="pre">not</span> <span class="pre">converge</span></code> when any run failed); clicking it opens the
per-run statistics table – see <a class="reference internal" href="runs-fitting.html"><span class="doc">Runs and fitting</span></a>;</p></li>
<li><p>the <strong>message</strong> line for transient notices (click it to open the run log);</p></li>
<li><p>the <strong>file</strong> and <strong>directory</strong> the last action operated on.</p></li>
</ul>
<p>Hovering over a shortened value shows the full text. The state, statistic,
message, file, and directory elements appear only when they add context.</p>
</section>
<section id="run-log-window">
<h2>Run log window<a class="headerlink" href="#run-log-window" title="Link to this heading"></a></h2>
<p>The run log dialog shows the same command log as the Results tab, as a large
readable pane. It is opened from the status bar state or message, from the
outcome dialog, or by clicking the log area in Results. It is modeless, so
the main window stays usable while it is open.</p>
</section>
<section id="outcome-dialog">
<h2>Outcome dialog<a class="headerlink" href="#outcome-dialog" title="Link to this heading"></a></h2>
<p>If an action cannot be completed (a failed fit, an invalid run selection), an
outcome dialog explains what went wrong. It offers <strong>Close</strong> and, when
relevant, <strong>Open run log</strong> to inspect the commands that ran. A successful
action does not pop this dialog – it stays out of the way.</p>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="msr-editor.html" class="btn btn-neutral float-left" title="MSR editor" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="configuration-sharing.html" class="btn btn-neutral float-right" title="Configuration sharing" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2026 Zaher Salman.</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>