Files
muSRFlow/docs/_build/html/troubleshooting.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

218 lines
13 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>Troubleshooting &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="Glossary" href="glossary.html" />
<link rel="prev" title="Keyboard shortcuts" href="keyboard-shortcuts.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"><a class="reference internal" href="results-diagnostics.html">Results and diagnostics</a></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 current"><a class="current reference internal" href="#">Troubleshooting</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#fit-or-plot-will-not-start">Fit or plot will not start</a></li>
<li class="toctree-l2"><a class="reference internal" href="#nothing-to-fit">“Nothing to fit”</a></li>
<li class="toctree-l2"><a class="reference internal" href="#fitted-parameters-look-wrong-or-unchanged">Fitted parameters look wrong or unchanged</a></li>
<li class="toctree-l2"><a class="reference internal" href="#parameter-plot-is-empty-or-missing-data">Parameter plot is empty or missing data</a></li>
<li class="toctree-l2"><a class="reference internal" href="#parameter-plot-hangs-on-preparing-plot-files">Parameter plot hangs on “Preparing plot files”</a></li>
<li class="toctree-l2"><a class="reference internal" href="#web-page-cannot-load-data">Web page cannot load data</a></li>
<li class="toctree-l2"><a class="reference internal" href="#restored-configuration-differs-from-the-original-machine">Restored configuration differs from the original machine</a></li>
<li class="toctree-l2"><a class="reference internal" href="#some-links-start-with-a-different-prefix">Some links start with a different prefix</a></li>
<li class="toctree-l2"><a class="reference internal" href="#reporting-problems">Reporting problems</a></li>
</ul>
</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">Troubleshooting</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/troubleshooting.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="troubleshooting">
<h1>Troubleshooting<a class="headerlink" href="#troubleshooting" title="Link to this heading"></a></h1>
<p>For Windows setup, WSL startup errors, missing ROOT libraries, and older
runtime updates, see <a class="reference internal" href="install-windows.html"><span class="doc">Windows installation</span></a>. For Linux package/runtime setup,
see <a class="reference internal" href="install-linux.html"><span class="doc">Linux installation</span></a>. The sections below cover analysis workflows.</p>
<section id="fit-or-plot-will-not-start">
<h2>Fit or plot will not start<a class="headerlink" href="#fit-or-plot-will-not-start" title="Link to this heading"></a></h2>
<p>Check the resolution warning under the run row: it reports runs that cannot
be resolved against the current data tree. In the browser edition, confirm
the server exposes those runs; on the desktop, verify the data directory
preference points at the real data root. If a model has no valid run, the
action reports the reason in the outcome dialog and the run log.</p>
</section>
<section id="nothing-to-fit">
<h2>“Nothing to fit”<a class="headerlink" href="#nothing-to-fit" title="Link to this heading"></a></h2>
<p>An independent-series fit (two or more data sets, no shared parameters) where
every run is set to <strong>skip</strong> reports this instead of running. Set at least
one chip to <strong>reuse</strong> or <strong>refit</strong>, or use <strong>Refit all</strong> from the All
dropdown.</p>
</section>
<section id="fitted-parameters-look-wrong-or-unchanged">
<h2>Fitted parameters look wrong or unchanged<a class="headerlink" href="#fitted-parameters-look-wrong-or-unchanged" title="Link to this heading"></a></h2>
<ul class="simple">
<li><p>The parameter table is the source of the <em>starting</em> values. After a fit it
holds the fitted results; run the fit again after editing values.</p></li>
<li><p>Hand-edited MSR documents are authoritative: if the editor lock is closed,
Fit and Plot use the editor text and ignore GUI changes until you unlock
(see <a class="reference internal" href="msr-editor.html"><span class="doc">MSR editor</span></a>).</p></li>
<li><p>A model change rebuilds the parameter table and may reset values; re-check
the rows for every component you use.</p></li>
</ul>
</section>
<section id="parameter-plot-is-empty-or-missing-data">
<h2>Parameter plot is empty or missing data<a class="headerlink" href="#parameter-plot-is-empty-or-missing-data" title="Link to this heading"></a></h2>
<ul class="simple">
<li><p>Click <strong>Refresh</strong> after a new fit – panels reread the parameter file.</p></li>
<li><p>Use <strong>Data…</strong> to change the data set of the active panel.</p></li>
<li><p>A panel that shares the X axis with no plottable column shows its empty
message; activate it and add a parameter or load another file.</p></li>
<li><p>Overlaid files that lack the panel’s X column (or could not be re-read)
are skipped and listed in a striped note under the panel. Fix the X
column (<strong>X</strong> control) or uncheck the file under <strong>Plot options &gt; Overlay
data sets</strong>.</p></li>
</ul>
</section>
<section id="parameter-plot-hangs-on-preparing-plot-files">
<h2>Parameter plot hangs on “Preparing plot files”<a class="headerlink" href="#parameter-plot-hangs-on-preparing-plot-files" title="Link to this heading"></a></h2>
<p>“Preparing plot files” covers the setup performed before the tools run. If
the step never finishes, check the server/work-bench side:</p>
<ul class="simple">
<li><p>The command-line tools must be reachable on the machine that runs them
(local install on the desktop, server-side install for the CGI).</p></li>
<li><p>On the desktop, confirm the work directory is writable.</p></li>
</ul>
<p>The command log records every command line that was attempted; it is the
first place to look.</p>
</section>
<section id="web-page-cannot-load-data">
<h2>Web page cannot load data<a class="headerlink" href="#web-page-cannot-load-data" title="Link to this heading"></a></h2>
<p>The browser edition fetches data and runs fits on the server. If the page
loads but actions fail, verify the CGI endpoint is reachable (see
<code class="docutils literal notranslate"><span class="pre">cgi/README.md</span></code>) and that the server data root matches what the page was
deployed with. The server health endpoint reports the configured data root;
muSRFlow’s resolution warning should agree with it.</p>
</section>
<section id="restored-configuration-differs-from-the-original-machine">
<h2>Restored configuration differs from the original machine<a class="headerlink" href="#restored-configuration-differs-from-the-original-machine" title="Link to this heading"></a></h2>
<p>Configuration links carry analysis settings only, not data or working
directories. On a different machine the same settings resolve against that
machine’s data tree. If runs do not resolve, fix the data/startup-XML
configuration (desktop Preferences; server configuration on the web) and
refit.</p>
</section>
<section id="some-links-start-with-a-different-prefix">
<h2>Some links start with a different prefix<a class="headerlink" href="#some-links-start-with-a-different-prefix" title="Link to this heading"></a></h2>
<p>muSRFlow shares both a compact compressed form (<code class="docutils literal notranslate"><span class="pre">#c=</span></code>) and a readable
legacy form (<code class="docutils literal notranslate"><span class="pre">#cfg=</span></code>). Both are accepted by the web and the desktop
restore dialog.</p>
</section>
<section id="reporting-problems">
<h2>Reporting problems<a class="headerlink" href="#reporting-problems" title="Link to this heading"></a></h2>
<p>Include the command log (open from the status bar or the outcome dialog)
and the versions involved. Contact Zaher Salman
<a class="reference external" href="mailto:zaher&#46;salman&#37;&#52;&#48;psi&#46;ch">mailto:zaher<span>&#46;</span>salman<span>&#64;</span>psi<span>&#46;</span>ch</a> with those details for the fastest help.</p>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="keyboard-shortcuts.html" class="btn btn-neutral float-left" title="Keyboard shortcuts" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="glossary.html" class="btn btn-neutral float-right" title="Glossary" 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>