Files
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

179 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>Glossary &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="prev" title="Troubleshooting" href="troubleshooting.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"><a class="reference internal" href="troubleshooting.html">Troubleshooting</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">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">Glossary</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/glossary.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="glossary">
<h1>Glossary<a class="headerlink" href="#glossary" title="Link to this heading"></a></h1>
<dl class="simple glossary">
<dt id="term-MSR">MSR<a class="headerlink" href="#term-MSR" title="Link to this term"></a></dt><dd><p>The <code class="docutils literal notranslate"><span class="pre">musrfit</span></code> input document. A text file made of blocks –
<code class="docutils literal notranslate"><span class="pre">FITPARAMETER</span></code>, <code class="docutils literal notranslate"><span class="pre">THEORY</span></code>, <code class="docutils literal notranslate"><span class="pre">FUNCTIONS</span></code>, <code class="docutils literal notranslate"><span class="pre">GLOBAL</span></code>, <code class="docutils literal notranslate"><span class="pre">RUN</span></code>,
<code class="docutils literal notranslate"><span class="pre">COMMANDS</span></code>, <code class="docutils literal notranslate"><span class="pre">PLOT</span></code>, <code class="docutils literal notranslate"><span class="pre">FOURIER</span></code>, <code class="docutils literal notranslate"><span class="pre">STATISTIC</span></code>. muSRFlow generates,
edits, and fits this file.</p>
</dd>
<dt id="term-fit-document">fit document<a class="headerlink" href="#term-fit-document" title="Link to this term"></a></dt><dd><p>The prepared MSR plus the parameters, constraints, and settings that
describe one fit. The MSR Editor shows it as text.</p>
</dd>
<dt id="term-RUN">RUN<a class="headerlink" href="#term-RUN" title="Link to this term"></a></dt><dd><p>A data set record inside an MSR which names one measured run or a
single <code class="docutils literal notranslate"><span class="pre">ADDRUN</span></code>-joined set of runs.</p>
</dd>
<dt id="term-ADDRUN">ADDRUN<a class="headerlink" href="#term-ADDRUN" title="Link to this term"></a></dt><dd><p>An MSR directive that appends another run to the current data set, so
<code class="docutils literal notranslate"><span class="pre">514+515</span></code> forms one data set from two runs.</p>
</dd>
<dt id="term-independent-series-fit">independent-series fit<a class="headerlink" href="#term-independent-series-fit" title="Link to this term"></a></dt><dd><p>A multi-run fit in which every data set has its own parameters (no
<code class="docutils literal notranslate"><span class="pre">Shared</span></code> entries). muSRFlow treats it specially: it can reuse,
refit, or skip each run independently through the action chips.</p>
</dd>
<dt id="term-global-parameter">global parameter<a class="headerlink" href="#term-global-parameter" title="Link to this term"></a></dt><dd><p>A parameter marked <strong>Shared</strong> in the parameter table. One starting
value, step, and limits apply to all runs, matching musrfit’s
<code class="docutils literal notranslate"><span class="pre">GLOBAL</span></code> mechanism.</p>
</dd>
<dt id="term-par.dat">par.dat<a class="headerlink" href="#term-par.dat" title="Link to this term"></a></dt><dd><p>The parameter table produced from a fitted MSR (by <code class="docutils literal notranslate"><span class="pre">msr2data</span></code>). Each
line is one run and each column one parameter (plus its uncertainty);
the parameter-plot window reads these files.</p>
</dd>
<dt id="term-musrfit">musrfit<a class="headerlink" href="#term-musrfit" title="Link to this term"></a></dt><dd><p>The muon-spin-spectroscopy fitting engine. See the
<a class="reference external" href="https://lmu.web.psi.ch/musrfit/long/intro/">musrfit project pages</a>
for its manual.</p>
</dd>
<dt id="term-musrview">musrview<a class="headerlink" href="#term-musrview" title="Link to this term"></a></dt><dd><p>The reference viewer for muon-spin data and fits. muSRFlow runs it for
the spectra display and for ROOT canvases of fitted data.</p>
</dd>
<dt id="term-msr2data">msr2data<a class="headerlink" href="#term-msr2data" title="Link to this term"></a></dt><dd><p>A companion tool that writes the <code class="docutils literal notranslate"><span class="pre">par.dat</span></code> parameter table from a
fitted MSR.</p>
</dd>
<dt id="term-dump_header">dump_header<a class="headerlink" href="#term-dump_header" title="Link to this term"></a></dt><dd><p>A companion tool that prints run metadata. muSRFlow uses it to resolve
portable run names and to seed initial parameter guesses.</p>
</dd>
<dt id="term-ROOT-plot">ROOT plot<a class="headerlink" href="#term-ROOT-plot" title="Link to this term"></a></dt><dd><p>A plot canvas produced by <code class="docutils literal notranslate"><span class="pre">musrview</span> <span class="pre">--root</span></code>. On the web it is drawn
with JSROOT in the browser; on the desktop it is part of the native
viewer’s output.</p>
</dd>
<dt id="term-RRF">RRF<a class="headerlink" href="#term-RRF" title="Link to this term"></a></dt><dd><p>Rotating reference frame. An optional display transform that subtracts
a reference frequency from the measured signal; configured in the RRF
view settings.</p>
</dd>
<dt id="term-FFT">FFT<a class="headerlink" href="#term-FFT" title="Link to this term"></a></dt><dd><p>Fast Fourier transform. The frequency-domain view of the signal,
configured in the FFT view settings (type, apodization, phase, range,
units, and automatic phase correction).</p>
</dd>
<dt id="term-configuration-link">configuration link<a class="headerlink" href="#term-configuration-link" title="Link to this term"></a></dt><dd><p>A URL carrying the current analysis settings as a compressed fragment.
Both the web share button and the desktop restore dialog use the same
format.</p>
</dd>
</dl>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="troubleshooting.html" class="btn btn-neutral float-left" title="Troubleshooting" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</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>