220 lines
12 KiB
HTML
220 lines
12 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>Web and desktop editions — 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="Keyboard shortcuts" href="keyboard-shortcuts.html" />
|
|
<link rel="prev" title="Preferences" href="preferences.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 current"><a class="current reference internal" href="#">Web and desktop editions</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="#bundled-root-and-musrfit">Bundled ROOT and musrfit</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#downloading-missing-runs">Downloading missing runs</a></li>
|
|
</ul>
|
|
</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">Web and desktop editions</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
<a href="_sources/platforms.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="web-and-desktop-editions">
|
|
<h1>Web and desktop editions<a class="headerlink" href="#web-and-desktop-editions" title="Link to this heading"></a></h1>
|
|
<p>Both editions share the tabs, fit engine, model library, parameter plots, and
|
|
configuration-sharing protocol. The differences come from where the data and
|
|
the command-line tools live.</p>
|
|
<figure class="align-default" id="id1">
|
|
<a class="reference internal image-reference" href="_images/execution-locations.svg"><img alt="Linux runs native tools locally; Windows runs its bundled tools in WSL2; the browser sends work to the CGI server." src="_images/execution-locations.svg" style="width: 100%;" />
|
|
</a>
|
|
<figcaption>
|
|
<p><span class="caption-text">Standard execution paths. Windows can also use explicitly configured
|
|
native binaries instead of the bundled WSL runtime.</span><a class="headerlink" href="#id1" title="Link to this image"></a></p>
|
|
</figcaption>
|
|
</figure>
|
|
<table class="docutils align-default">
|
|
<colgroup>
|
|
<col style="width: 25.0%" />
|
|
<col style="width: 35.0%" />
|
|
<col style="width: 40.0%" />
|
|
</colgroup>
|
|
<thead>
|
|
<tr class="row-odd"><th class="head"><p>Concern</p></th>
|
|
<th class="head"><p>Desktop (Electron)</p></th>
|
|
<th class="head"><p>Web (browser)</p></th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr class="row-even"><td><p>Where the tools run</p></td>
|
|
<td><p>Locally using configured or detected tools; through WSL2 on Windows.</p></td>
|
|
<td><p>On the server behind the CGI endpoint.</p></td>
|
|
</tr>
|
|
<tr class="row-odd"><td><p>Data access</p></td>
|
|
<td><p>Local data plus optional downloads of missing selected runs.</p></td>
|
|
<td><p>What the server data tree exposes.</p></td>
|
|
</tr>
|
|
<tr class="row-even"><td><p>Preferences</p></td>
|
|
<td><p>Per-user, through <strong>File / Preferences</strong>.</p></td>
|
|
<td><p>Fixed by server configuration; no dialog.</p></td>
|
|
</tr>
|
|
<tr class="row-odd"><td><p>Opening / saving MSR files</p></td>
|
|
<td><p>Native <strong>File</strong> menu and editor Save button.</p></td>
|
|
<td><p>Server-side artifacts; no local file dialog.</p></td>
|
|
</tr>
|
|
<tr class="row-even"><td><p>Spectra display</p></td>
|
|
<td><p><code class="docutils literal notranslate"><span class="pre">musrview</span></code> in its own native window.</p></td>
|
|
<td><p>ROOT canvas produced by <code class="docutils literal notranslate"><span class="pre">musrview</span></code> on the server, drawn with
|
|
JSROOT in the page.</p></td>
|
|
</tr>
|
|
<tr class="row-odd"><td><p>Quick Start help</p></td>
|
|
<td><p>Independent auxiliary window.</p></td>
|
|
<td><p>Modeless dialog beside the main window.</p></td>
|
|
</tr>
|
|
<tr class="row-even"><td><p>Configuration links</p></td>
|
|
<td><p>Share webpage links; <strong>Restore configuration link</strong> to paste one.</p></td>
|
|
<td><p>Share button copies a link; opening it restores the settings.</p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<section id="bundled-root-and-musrfit">
|
|
<h2>Bundled ROOT and musrfit<a class="headerlink" href="#bundled-root-and-musrfit" title="Link to this heading"></a></h2>
|
|
<p>On Linux, the application and scientific runtime are separate. The Linux
|
|
application packages contain no musrfit/ROOT binaries—only the muSRFlow
|
|
frontend. Use an existing ROOT + musrfit installation, install an offline
|
|
runtime bundle in Preferences, or install the system/runtime RPM or AppImage
|
|
(containing <code class="docutils literal notranslate"><span class="pre">musrfit</span></code>, <code class="docutils literal notranslate"><span class="pre">musrt0</span></code>, <code class="docutils literal notranslate"><span class="pre">musrview</span></code>, <code class="docutils literal notranslate"><span class="pre">msr2data</span></code>,
|
|
<code class="docutils literal notranslate"><span class="pre">dump_header</span></code>, <code class="docutils literal notranslate"><span class="pre">root-config</span></code> and bundled libraries). An explicitly
|
|
selected binaries directory takes precedence over automatic detection.
|
|
See <a class="reference internal" href="install-linux.html"><span class="doc">Linux installation</span></a> for installation and tool checks.</p>
|
|
<p>On Windows, the application installer includes the runtime. It runs inside
|
|
a WSL2 distribution named <code class="docutils literal notranslate"><span class="pre">muSRFlow-runtime</span></code>. Tools are invoked through
|
|
<code class="docutils literal notranslate"><span class="pre">wsl.exe</span></code>, with paths translated so inputs and outputs stay on the Windows
|
|
side. The separate Linux runtime installer does not apply to Windows.
|
|
See <a class="reference internal" href="install-windows.html"><span class="doc">Windows installation</span></a> for WSL setup, installation, updates, and fixes.</p>
|
|
<p>The workflow chapters of this manual apply to both editions. Where a step is
|
|
specific to one edition (handling files, Preferences), the text says so
|
|
explicitly.</p>
|
|
</section>
|
|
<section id="downloading-missing-runs">
|
|
<h2>Downloading missing runs<a class="headerlink" href="#downloading-missing-runs" title="Link to this heading"></a></h2>
|
|
<p>Fit and Plot check selected main runs and ADDRUN members before preparing MSR
|
|
files. If files are missing, the desktop offers to download them over HTTPS
|
|
from <code class="docutils literal notranslate"><span class="pre">musruser.psi.ch</span></code> and continue. Independent series fits request data
|
|
only for entries that need fitting; reused results and explicit skips do not
|
|
trigger downloads. Runs absent from the server are still reported as missing.</p>
|
|
<p>The writable Data directory is preferred. When it is read-only, a persistent
|
|
folder under the user’s application data directory is used instead. Exact
|
|
filenames and formats are remembered across sessions, and incomplete downloads
|
|
are never published as run files. Expert MSRs with manually specified RUN
|
|
paths continue to use their existing file-resolution rules.</p>
|
|
<p>Generated download RUN paths are relative to the stored data tree. muSRFlow
|
|
passes the matching search roots to its tools through <code class="docutils literal notranslate"><span class="pre">MUSRFULLDATAPATH</span></code>,
|
|
including translated paths for Windows/WSL2. To run such an MSR from a terminal
|
|
outside muSRFlow, set that variable to the download root or add the root to
|
|
your own musrfit startup XML.</p>
|
|
</section>
|
|
</section>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
|
<a href="preferences.html" class="btn btn-neutral float-left" title="Preferences" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
|
<a href="keyboard-shortcuts.html" class="btn btn-neutral float-right" title="Keyboard shortcuts" 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> |