Register the musrflow:// URL scheme at startup (electron-builder writes the matching MimeType=x-scheme-handler desktop entry for the packaged Linux builds), accept musrflow://open/#c= links on the launch path and macOS open-url alongside the existing http(s)/bare-fragment forms, and add a web Share button that emits the identical encoded fragment under musrflow://open/ so a browser can hand a configuration to the installed desktop app. Add a musrfit threads field to the Electron Preferences dialog. A set count is passed to local fits as `musrfit -u <n>`; blank keeps the previous all-cores behaviour and the web edition ignores it. Document both features (preferences, runs/fitting, configuration sharing, desktop deployment, CHANGELOG) and rebuild the Sphinx HTML and PDF.
199 lines
11 KiB
HTML
199 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>Configuration sharing — 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="Preferences" href="preferences.html" />
|
|
<link rel="prev" title="Results and diagnostics" href="results-diagnostics.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="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 current"><a class="current reference internal" href="#">Configuration sharing</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="#what-is-shared">What is shared</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#on-the-web">On the web</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#on-the-desktop">On the desktop</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#notes">Notes</a></li>
|
|
</ul>
|
|
</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">Configuration sharing</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
<a href="_sources/configuration-sharing.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="configuration-sharing">
|
|
<h1>Configuration sharing<a class="headerlink" href="#configuration-sharing" title="Link to this heading"></a></h1>
|
|
<p>muSRFlow can encode the current analysis settings into a single link that
|
|
another instance can restore. This is useful for reproducing a session or for
|
|
passing a fit setup to a colleague.</p>
|
|
<section id="what-is-shared">
|
|
<h2>What is shared<a class="headerlink" href="#what-is-shared" title="Link to this heading"></a></h2>
|
|
<p>The link carries the run selection, instrument, year, fit range, model
|
|
components, fit options, parameters and constraints, plot/FFT/RRF view
|
|
settings, the analysis-related preferences, and – when a parameter plot
|
|
configuration was remembered for the current data source – the parameter-plot
|
|
window state (panel arrangement, palette, trace styles, overlay files). When
|
|
the sender’s parameter data is available on the machine that produces the link
|
|
(a completed fit), the actual msr2data table is embedded as well, so the
|
|
recipient can draw the identical plot – fitted values, scan variable, and error
|
|
bars – without reproducing the sender’s <code class="docutils literal notranslate"><span class="pre">*_par.dat</span></code> on its own file system.
|
|
It does <strong>not</strong> carry the raw data files or your local working directories. A restored
|
|
session therefore recreates the analysis on top of whatever data the target
|
|
machine can see.</p>
|
|
</section>
|
|
<section id="on-the-web">
|
|
<h2>On the web<a class="headerlink" href="#on-the-web" title="Link to this heading"></a></h2>
|
|
<p>The share button in the tab bar (the chain-link icon) copies a link such as</p>
|
|
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>http://musruser.psi.ch/muSRFlow/#c=...
|
|
</pre></div>
|
|
</div>
|
|
<p>Anyone who opens the link in a browser gets the same analysis settings, as
|
|
long as the server exposes the same data.</p>
|
|
<p>A visitor who has the desktop build installed can also use the second button
|
|
next to the share button (the monitor icon). It copies the same payload as a
|
|
<code class="docutils literal notranslate"><span class="pre">musrflow://</span></code> link instead:</p>
|
|
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>musrflow://open/#c=...
|
|
</pre></div>
|
|
</div>
|
|
<p>A browser cannot navigate to its own <code class="docutils literal notranslate"><span class="pre">https</span></code> page and then hand the payload
|
|
to an installed application, so this dedicated scheme lets the web page open
|
|
the settings directly in the desktop app. Only the base URL differs; the
|
|
encoded fragment is byte-for-byte the same, so either link restores the same
|
|
analysis.</p>
|
|
</section>
|
|
<section id="on-the-desktop">
|
|
<h2>On the desktop<a class="headerlink" href="#on-the-desktop" title="Link to this heading"></a></h2>
|
|
<p>Electron cannot handle its own browser links, so it ships the same encoding
|
|
backwards as well: open a muSRFlow configuration link (from the web or from a
|
|
colleague) and choose <strong>Restore configuration link</strong> to paste it into the
|
|
restore dialog. The analysis settings are applied while your local data and
|
|
working directories remain untouched.</p>
|
|
<p>The installed application also registers the <code class="docutils literal notranslate"><span class="pre">musrflow://</span></code> scheme, so
|
|
clicking such a link (in a mail client, a document, or the web page above)
|
|
starts muSRFlow and restores the embedded settings directly. The canonical
|
|
<code class="docutils literal notranslate"><span class="pre">http://musruser.psi.ch/muSRFlow/#c=...</span></code> link still works: paste it into the
|
|
restore dialog. See the desktop deployment notes for how the scheme is
|
|
installed, including the AppImage caveat.</p>
|
|
</section>
|
|
<section id="notes">
|
|
<h2>Notes<a class="headerlink" href="#notes" title="Link to this heading"></a></h2>
|
|
<ul class="simple">
|
|
<li><p>The shared payload is a compact, optionally compressed fragment in the URL
|
|
hash; nothing is sent to a third party.</p></li>
|
|
<li><p>A restored configuration may reference data that was never fit on the
|
|
target machine. The parameter table is rebuilt from the restored settings
|
|
and can be populated by running a fit.</p></li>
|
|
<li><p>The parameter-plot stanza is optional and keyed by the data source’s
|
|
identity. When the sender’s parameter table could be read at share time it is
|
|
carried inline as the main source, so on the web the plot opens immediately
|
|
after restore (the browser’s <code class="docutils literal notranslate"><span class="pre">Plot</span> <span class="pre">parameters...</span></code> action applies it the
|
|
first time it is used). Otherwise it is applied when the same source exists
|
|
on the target machine – a matching on-disk parameter-data path or an
|
|
identical inline parameter table (see
|
|
<a class="reference internal" href="parameters-plots.html#remembered-plot-configurations"><span class="std std-ref">Remembered plot configurations</span></a>). If neither applies it is ignored
|
|
harmlessly and the plot opens with the normal dialog.</p></li>
|
|
</ul>
|
|
</section>
|
|
</section>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
|
<a href="results-diagnostics.html" class="btn btn-neutral float-left" title="Results and diagnostics" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
|
<a href="preferences.html" class="btn btn-neutral float-right" title="Preferences" 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> |