Files
muSRFlow/docs/_build/html/overview.html

209 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>Overview &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=1305e836"></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="Getting started" href="getting-started.html" />
<link rel="prev" title="muSRFlow User Manual" href="index.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 current"><a class="current reference internal" href="#">Overview</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#what-you-get">What you get</a></li>
<li class="toctree-l2"><a class="reference internal" href="#under-the-hood">Under the hood</a></li>
<li class="toctree-l2"><a class="reference internal" href="#two-editions">Two editions</a></li>
<li class="toctree-l2"><a class="reference internal" href="#a-first-fit">A first fit</a></li>
</ul>
</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="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"><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">Overview</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/overview.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="overview">
<h1>Overview<a class="headerlink" href="#overview" title="Link to this heading"></a></h1>
<p>muSRFlow provides a modern interface over the classic µSR analysis tools. A
typical session selects the data, chooses a fit model, fits it, inspects the
result, and finally inspects how the fitted parameters vary run by run.</p>
<section id="what-you-get">
<h2>What you get<a class="headerlink" href="#what-you-get" title="Link to this heading"></a></h2>
<ul class="simple">
<li><p>A single window with the full workflow in tabs:</p>
<ul>
<li><p><strong>Runs</strong> – run selection, factorial fit range, fit model, fit options,
and the Plot / FFT / RRF view settings.</p></li>
<li><p><strong>Parameters</strong> – the parameter table with starting values, steps,
limits, and plot selection.</p></li>
<li><p><strong>Constraints</strong> – custom parameters and parameter constraints.</p></li>
<li><p><strong>t0 / Bg</strong> – expert timing and background controls.</p></li>
<li><p><strong>MSR Editor</strong> – the generated MSR document, with GUI-to-MSR and
MSR-to-GUI synchronisation.</p></li>
<li><p><strong>Results</strong> – generated files, execution details, and the full command
log.</p></li>
</ul>
</li>
<li><p>Two one-click workflow actions in the main toolbar:</p>
<ul>
<li><p><strong>Fit</strong> – generate the MSR document and run the fit.</p></li>
<li><p><strong>Plot</strong> – generate the MSR document and display the spectra.</p></li>
</ul>
</li>
<li><p>Interactive parameter plots that show how every fitted parameter evolves
across the selected runs.</p></li>
<li><p>Configuration sharing: the current analysis settings can be encoded into a
link and restored on another machine.</p></li>
</ul>
</section>
<section id="under-the-hood">
<h2>Under the hood<a class="headerlink" href="#under-the-hood" title="Link to this heading"></a></h2>
<p>muSRFlow does not reimplement the physics. It writes MSR files that are fed
to the <a class="reference external" href="https://lmu.web.psi.ch/musrfit/">musrfit</a> package, and renders
spectra with <code class="docutils literal notranslate"><span class="pre">musrview</span></code>:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">musrfit</span></code> – the muon-spectroscopy fitting engine. muSRFlow generates an
MSR file from the GUI and runs <code class="docutils literal notranslate"><span class="pre">musrfit</span></code> on it. The fitted values (a
<code class="docutils literal notranslate"><span class="pre">par.dat</span></code> parameter table) feed the parameter plots.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">musrview</span></code> – the reference data viewer. On the desktop it opens its own
native window; in the browser edition the server produces a ROOT canvas
that is drawn with JSROOT inside the page.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">msr2data</span></code> – converts a fitted MSR file into a parameter table
(<code class="docutils literal notranslate"><span class="pre">par.dat</span></code>) that the parameter plot can read.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">dump_header</span></code> – reads run metadata used to resolve portable run names
and to guess initial parameters.</p></li>
</ul>
</section>
<section id="two-editions">
<h2>Two editions<a class="headerlink" href="#two-editions" title="Link to this heading"></a></h2>
<ul class="simple">
<li><p><strong>Desktop (Electron)</strong> runs the tools directly on your machine, manages its
own data and working directories (set under <strong>File / Preferences</strong>), and
can open and save MSR files from the File menu.</p></li>
<li><p><strong>Web</strong> runs the same interface in a browser. The data tree and the
command-line tools live on the server, so file selection is limited to what
the server exposes, and there is no local Preferences dialog.</p></li>
</ul>
<p>Both editions share the same workflow and produce the same MSR documents.
The differences that matter day to day are collected in
<a class="reference internal" href="platforms.html"><span class="doc">Web and desktop editions</span></a>.</p>
</section>
<section id="a-first-fit">
<h2>A first fit<a class="headerlink" href="#a-first-fit" title="Link to this heading"></a></h2>
<ol class="arabic simple">
<li><p>In the <strong>Runs</strong> tab, choose the instrument and year and enter one or more
run numbers.</p></li>
<li><p>Adjust the fit range and the fit model as needed.</p></li>
<li><p>Press <strong>Fit</strong>.</p></li>
<li><p>Open the <strong>Parameters</strong> tab to verify and adjust starting values, then
press <strong>Fit</strong> again.</p></li>
<li><p>Use <strong>Plot</strong> any time to look at the spectra.</p></li>
<li><p>Select parameters and choose <strong>Plot parameters…</strong> to inspect how they
vary across the run set (see <a class="reference internal" href="parameters-plots.html"><span class="doc">Parameters and parameter plots</span></a>).</p></li>
</ol>
<p>The Quick Start button (<code class="docutils literal notranslate"><span class="pre">?</span></code>) at the right of the tab bar opens a short
guide that highlights the section relevant to the active tab. Its sections
are expanded into the chapters of this manual.</p>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="index.html" class="btn btn-neutral float-left" title="muSRFlow User Manual" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="getting-started.html" class="btn btn-neutral float-right" title="Getting started" 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>