Files
muSRFlow/docs/_build/html/preferences.html
salman 184c5b9eb1 Add musrflow:// configuration links and musrfit thread preference
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.
2026-10-10 10:40:41 +02:00

167 lines
9.2 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>Preferences &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="Web and desktop editions" href="platforms.html" />
<link rel="prev" title="Configuration sharing" href="configuration-sharing.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"><a class="reference internal" href="configuration-sharing.html">Configuration sharing</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">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">Preferences</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/preferences.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="preferences">
<h1>Preferences<a class="headerlink" href="#preferences" title="Link to this heading"></a></h1>
<p>The <strong>Preferences</strong> dialog is a desktop (Electron) feature: it opens from the
<strong>File</strong> menu. The web edition derives the same settings from server
configuration and never exposes this dialog.</p>
<dl class="simple">
<dt>Work directory</dt><dd><p>Where generated files, MSR documents, and result artifacts are written.
Defaults to the current directory (<code class="docutils literal notranslate"><span class="pre">.</span></code>).</p>
</dd>
<dt>Data directory</dt><dd><p>The root of the instrument data tree (for example
<code class="docutils literal notranslate"><span class="pre">/psi.ch/group/lmu/public/data</span></code>). Run paths are resolved under it.</p>
</dd>
<dt>musrfit startup XML</dt><dd><p>The <code class="docutils literal notranslate"><span class="pre">musrfit_startup.xml</span></code> used to resolve portable run names. Leave it
as <strong>auto-detect</strong> and muSRFlow looks for the standard installation file;
choose a specific file when you run a specialised setup. A hint under the
field shows the naming mode the detected XML enables.</p>
</dd>
<dt>musrfit binaries</dt><dd><p>The directory that holds the musrfit tools (<code class="docutils literal notranslate"><span class="pre">musrfit</span></code>, <code class="docutils literal notranslate"><span class="pre">musrview</span></code>,
<code class="docutils literal notranslate"><span class="pre">msr2data</span></code>, and <code class="docutils literal notranslate"><span class="pre">dump_header</span></code>). Leave it empty for <strong>auto-detect</strong>
and muSRFlow searches the usual installation locations; choose a
directory when the tools live somewhere non-standard (for example a
developer build tree). The configured directory wins over every
auto-detected location for the tool commands muSRFlow runs, and is put
first on the <code class="docutils literal notranslate"><span class="pre">PATH</span></code> given to them. The setting is a desktop feature:
it is remembered across sessions, while the web edition takes its tools
from the server and never exposes this field.</p>
</dd>
<dt>musrfit threads</dt><dd><p>The number of OpenMP threads passed to a local <code class="docutils literal notranslate"><span class="pre">musrfit</span></code> run (<code class="docutils literal notranslate"><span class="pre">-u</span></code>).
Leave it blank to let musrfit use every available core. Set a lower
number to keep a fit from saturating a shared workstation or login node.
The value is validated by musrfit (<code class="docutils literal notranslate"><span class="pre">1</span> <span class="pre">...</span> <span class="pre">number</span> <span class="pre">of</span> <span class="pre">cores</span></code>) and has no
effect on the web edition, which runs fits on the server.</p>
</dd>
<dt>Initial parameters</dt><dd><p><strong>Guess initial parameters from first-run header</strong> (on by default): when
a run set is added, muSRFlow reads the first run’s metadata to seed
sensible starting values (for example an approximate frequency or
asymmetry) instead of generic defaults.</p>
</dd>
<dt>Output file suffixes</dt><dd><p>The suffixes appended to generated artifacts: <strong>Asymmetry</strong> (default
<code class="docutils literal notranslate"><span class="pre">_asy</span></code>) and <strong>Single histogram</strong> (default <code class="docutils literal notranslate"><span class="pre">_singleHist</span></code>). Change
them to avoid clashing with existing files or to match a naming
convention.</p>
</dd>
</dl>
<p>Save stores the values for the next session; <strong>Cancel</strong> closes the dialog
without changing anything. Directory changes take effect from the next
action that resolves or writes files.</p>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="configuration-sharing.html" class="btn btn-neutral float-left" title="Configuration sharing" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="platforms.html" class="btn btn-neutral float-right" title="Web and desktop editions" 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>