198 lines
12 KiB
HTML
198 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>Preferences — 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="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="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 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>
|
|
<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>), which can be the application
|
|
installation folder. Choose a separate writable work folder before fitting
|
|
so application upgrades do not affect your results.</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>
|
|
<p>When Fit or Plot needs runs that are missing locally, the desktop can
|
|
download them from <code class="docutils literal notranslate"><span class="pre">musruser.psi.ch</span></code> after confirmation. Downloads go
|
|
into this directory when the instrument/year folder is writable. Otherwise
|
|
they go into <code class="docutils literal notranslate"><span class="pre">run-data</span></code> under your personal muSRFlow application data
|
|
directory. The hint under the Data directory shows that fallback path,
|
|
and the confirmation lists the actual destination and total size.</p>
|
|
<p>Both locations remain available to subsequent fits, including offline.
|
|
Cancelling a transfer discards its incomplete file. Your selected Data
|
|
directory and startup XML are preserved; muSRFlow supplies the additional
|
|
search paths through <code class="docutils literal notranslate"><span class="pre">MUSRFULLDATAPATH</span></code> when launching its tools.</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>, <code class="docutils literal notranslate"><span class="pre">musrt0</span></code>, and <code class="docutils literal notranslate"><span class="pre">dump_header</span></code>). On Linux, the application
|
|
packages do not include these binaries (the runtime is distributed
|
|
separately); leave empty for <strong>auto-detect</strong> and muSRFlow searches, in
|
|
order, the runtime shipped with the packaged app, then a separately
|
|
installed one (<code class="docutils literal notranslate"><span class="pre">/opt/musrflow/runtime</span></code>), then 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>Runtime installation and checks (Linux)</dt><dd><p><strong>Check tools</strong> checks the saved tool selection. <strong>Install runtime…</strong>
|
|
installs a local runtime bundle after confirmation and selects its tools.
|
|
See <a class="reference internal" href="install-linux.html"><span class="doc">Linux installation</span></a> for the required files and installation steps.
|
|
Windows uses its bundled WSL runtime instead; see <a class="reference internal" href="install-windows.html"><span class="doc">Windows installation</span></a>.</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>
|
|
<p><strong>Estimate t0 from the prompt peak (except LEM/HAL)</strong> (on by default): before a
|
|
local fit, muSRFlow runs <code class="docutils literal notranslate"><span class="pre">musrt0</span> <span class="pre">--getT0FromPromptPeak</span></code> to write explicit
|
|
<code class="docutils literal notranslate"><span class="pre">t0</span></code> lines into the generated MSR. This forces musrfit to use the
|
|
histogram peak as the time-zero for instruments whose data-file header t0 is
|
|
unreliable; the step is never applied to LEM or HAL/HIFI data, regardless
|
|
of this preference. RUN and ADDRUN entries are also checked so an expert
|
|
MSR cannot bypass the exclusion through a different GUI selection.
|
|
Uncheck it to preserve the MSR as generated for other instruments too.</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>© 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> |