188 lines
10 KiB
HTML
188 lines
10 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>MSR editor — 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="Results and diagnostics" href="results-diagnostics.html" />
|
|
<link rel="prev" title="t0 / background" href="t0-background.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="lem2025-singlehist-example.html">LEM single-histogram example</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 current"><a class="current reference internal" href="#">MSR editor</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="#ownership-gui-or-editor">Ownership: GUI or editor</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#workflow">Workflow</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#file-handling">File handling</a></li>
|
|
</ul>
|
|
</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">MSR editor</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
<a href="_sources/msr-editor.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="msr-editor">
|
|
<h1>MSR editor<a class="headerlink" href="#msr-editor" title="Link to this heading"></a></h1>
|
|
<p>The <strong>MSR Editor</strong> tab displays the complete MSR file that muSRFlow prepares.
|
|
It is a real editor, not just a preview: you can edit the text by hand, and
|
|
the edited document becomes the source of truth for the next Fit or Plot.</p>
|
|
<figure class="align-default" id="id1">
|
|
<a class="reference internal image-reference" href="_images/msr-editor-tab.png"><img alt="MSR Editor showing a generated unfitted MSR with highlighted block keywords and comments, the GUI to MSR button, and the ownership lock." src="_images/msr-editor-tab.png" style="width: 100%;" />
|
|
</a>
|
|
<figcaption>
|
|
<p><span class="caption-text">A document generated with <strong>GUI -> MSR</strong>, before any fit. Syntax colours
|
|
separate keywords and comments. The open padlock shows that the GUI still
|
|
owns this document; editing it by hand changes that state.</span><a class="headerlink" href="#id1" title="Link to this image"></a></p>
|
|
</figcaption>
|
|
</figure>
|
|
<section id="ownership-gui-or-editor">
|
|
<h2>Ownership: GUI or editor<a class="headerlink" href="#ownership-gui-or-editor" title="Link to this heading"></a></h2>
|
|
<p>Two actors can own the document:</p>
|
|
<ul class="simple">
|
|
<li><p>the <strong>GUI</strong>, which regenerates the MSR from the current tab settings; and</p></li>
|
|
<li><p>the <strong>editor</strong>, once you edit the text by hand.</p></li>
|
|
</ul>
|
|
<p>The lock icon in the editor toolbar shows which one owns the document. An
|
|
open padlock means the GUI owns it and the next GUI generation or fit can
|
|
replace the text; a closed padlock means the editor owns it and Fit and Plot
|
|
use the text as-is.</p>
|
|
</section>
|
|
<section id="workflow">
|
|
<h2>Workflow<a class="headerlink" href="#workflow" title="Link to this heading"></a></h2>
|
|
<dl class="simple">
|
|
<dt><strong>GUI to MSR</strong> (the <code class="docutils literal notranslate"><span class="pre">GUI</span> <span class="pre">-></span> <span class="pre">MSR</span></code> button)</dt><dd><p>Replaces the visible document with one generated fresh from the analysis
|
|
settings. The GUI is the source of the text.</p>
|
|
</dd>
|
|
<dt><strong>Edit by hand</strong></dt><dd><p>Entering text hands ownership to the editor: the lock icon becomes a
|
|
closed padlock. While locked, <strong>Fit</strong> and <strong>Plot</strong> use the document
|
|
as-is and GUI changes do not silently replace it. Any attempt that would
|
|
overwrite the edited text asks for confirmation first.</p>
|
|
</dd>
|
|
<dt><strong>MSR to GUI</strong> (the <code class="docutils literal notranslate"><span class="pre">MSR</span> <span class="pre">-></span> <span class="pre">GUI</span></code> button)</dt><dd><p>Copies the recognised settings of the current document back into the GUI
|
|
fields (run list, fit range, model, parameters, and constraints). This
|
|
does not surrender editor ownership; the editor keeps the document until
|
|
you unlock it.</p>
|
|
</dd>
|
|
<dt><strong>Unlock</strong> (click the closed padlock)</dt><dd><p>Returns control of the document to the GUI, so the next GUI generation
|
|
or fit may replace it.</p>
|
|
</dd>
|
|
</dl>
|
|
</section>
|
|
<section id="file-handling">
|
|
<h2>File handling<a class="headerlink" href="#file-handling" title="Link to this heading"></a></h2>
|
|
<p>On the desktop (Electron), the <strong>File</strong> menu opens and saves MSR files
|
|
directly. The <strong>Save</strong> button in the editor toolbar writes the current
|
|
document to disk. On the web, saving is handled through the server’s result
|
|
artifacts.</p>
|
|
<p>The editor also shows which source document it currently displays. For a
|
|
multiple-run fit it can expose the generated document and the template it
|
|
was built from; the active tab (<strong>MSR</strong> or <strong>Template</strong>) selects which one
|
|
is shown.</p>
|
|
<p>For a complete example using real fitted LEM data and application screenshots,
|
|
see <a class="reference internal" href="lem2025-singlehist-example.html"><span class="doc">LEM single-histogram example</span></a>.</p>
|
|
</section>
|
|
</section>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
|
<a href="t0-background.html" class="btn btn-neutral float-left" title="t0 / background" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
|
<a href="results-diagnostics.html" class="btn btn-neutral float-right" title="Results and diagnostics" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
|
</div>
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<p>© 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> |