258 lines
16 KiB
HTML
258 lines
16 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>Linux installation — 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="Runs and fitting" href="runs-fitting.html" />
|
|
<link rel="prev" title="Windows installation" href="install-windows.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 current"><a class="current reference internal" href="#">Linux installation</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="#install-the-application">Install the application</a><ul>
|
|
<li class="toctree-l3"><a class="reference internal" href="#rpm">RPM</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="#appimage">AppImage</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#set-up-root-and-musrfit">Set up ROOT and musrfit</a><ul>
|
|
<li class="toctree-l3"><a class="reference internal" href="#use-an-existing-installation">Use an existing installation</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="#install-the-separate-runtime-from-a-local-bundle">Install the separate runtime from a local bundle</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="#alternative-system-runtime-rpm">Alternative: system runtime RPM</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="#alternative-runtime-appimage">Alternative: runtime AppImage</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#choose-folders-and-test">Choose folders and test</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#updating-and-troubleshooting">Updating and troubleshooting</a></li>
|
|
</ul>
|
|
</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"><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">Linux installation</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
<a href="_sources/install-linux.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="linux-installation">
|
|
<span id="id1"></span><h1>Linux installation<a class="headerlink" href="#linux-installation" title="Link to this heading"></a></h1>
|
|
<p>Install the muSRFlow application, then select a working ROOT + musrfit
|
|
installation. <strong>The Linux application package does not include the scientific
|
|
runtime.</strong> The application bundles no musrfit binaries; use an existing
|
|
ROOT + musrfit installation, install the separate runtime (AppImage/RPM or
|
|
the offline bundle in Preferences), or provide tools via the configured
|
|
binaries directory. Node.js and npm are not needed on the target PC.</p>
|
|
<p>The current application packages are for x86_64 Linux. Examples below use
|
|
<code class="docutils literal notranslate"><span class="pre">1.0.0-rc.6</span></code>; substitute the version of the package you obtained. Run the
|
|
commands from the folder containing the downloaded files.</p>
|
|
<section id="install-the-application">
|
|
<h2>Install the application<a class="headerlink" href="#install-the-application" title="Link to this heading"></a></h2>
|
|
<p>Choose one application format.</p>
|
|
<section id="rpm">
|
|
<h3>RPM<a class="headerlink" href="#rpm" title="Link to this heading"></a></h3>
|
|
<p>On an RPM-based distribution with dnf:</p>
|
|
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo<span class="w"> </span>dnf<span class="w"> </span>install<span class="w"> </span>./musrflow-1.0.0-rc.6-x86_64.rpm
|
|
musrflow
|
|
</pre></div>
|
|
</div>
|
|
<p>On other RPM systems, use the distribution’s package manager. The application
|
|
RPM filename starts with lowercase <code class="docutils literal notranslate"><span class="pre">musrflow</span></code>.</p>
|
|
</section>
|
|
<section id="appimage">
|
|
<h3>AppImage<a class="headerlink" href="#appimage" title="Link to this heading"></a></h3>
|
|
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>chmod<span class="w"> </span>+x<span class="w"> </span>muSRFlow-1.0.0-rc.6-x86_64.AppImage
|
|
./muSRFlow-1.0.0-rc.6-x86_64.AppImage
|
|
</pre></div>
|
|
</div>
|
|
<p>The application AppImage filename starts with <code class="docutils literal notranslate"><span class="pre">muSRFlow</span></code>. It requires a
|
|
compatible Linux desktop and AppImage/FUSE support. If it cannot start,
|
|
check the terminal output or use the RPM on a supported RPM distribution.</p>
|
|
</section>
|
|
</section>
|
|
<section id="set-up-root-and-musrfit">
|
|
<h2>Set up ROOT and musrfit<a class="headerlink" href="#set-up-root-and-musrfit" title="Link to this heading"></a></h2>
|
|
<section id="use-an-existing-installation">
|
|
<h3>Use an existing installation<a class="headerlink" href="#use-an-existing-installation" title="Link to this heading"></a></h3>
|
|
<p>Open <strong>File / Preferences</strong>. Leave <strong>musrfit binaries</strong> on automatic detection
|
|
for a standard installation, or choose the directory containing <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>. Save your settings,
|
|
then use <strong>Check tools</strong> to verify the saved selection.</p>
|
|
</section>
|
|
<section id="install-the-separate-runtime-from-a-local-bundle">
|
|
<h3>Install the separate runtime from a local bundle<a class="headerlink" href="#install-the-separate-runtime-from-a-local-bundle" title="Link to this heading"></a></h3>
|
|
<ol class="arabic simple">
|
|
<li><p>Obtain the runtime bundle for your architecture. Keep
|
|
<code class="docutils literal notranslate"><span class="pre">runtime-download.json</span></code> and its matching <code class="docutils literal notranslate"><span class="pre">musrflow-runtime-*.tar.gz</span></code>
|
|
archive in the same folder. You do not need to unpack it.</p></li>
|
|
<li><p>Open <strong>File / Preferences / Install runtime…</strong> and select
|
|
<code class="docutils literal notranslate"><span class="pre">runtime-download.json</span></code>.</p></li>
|
|
<li><p>Review the versions and destination, then select <strong>Install and use</strong>.
|
|
muSRFlow validates the archive, installs it in your personal application
|
|
data directory, and selects its tools.</p></li>
|
|
<li><p>Use <strong>Check tools</strong> to confirm the selected runtime starts.</p></li>
|
|
</ol>
|
|
<p>This installation does not require administrator access. Runtime downloads
|
|
are not automatic: obtain the bundle separately before opening the installer.
|
|
A compatible Linux system and desktop/display services are still required.</p>
|
|
</section>
|
|
<section id="alternative-system-runtime-rpm">
|
|
<h3>Alternative: system runtime RPM<a class="headerlink" href="#alternative-system-runtime-rpm" title="Link to this heading"></a></h3>
|
|
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo<span class="w"> </span>dnf<span class="w"> </span>install<span class="w"> </span>./musrflow-runtime-1.0.0-rc.6-x86_64.rpm
|
|
</pre></div>
|
|
</div>
|
|
<p>This installs the runtime into <code class="docutils literal notranslate"><span class="pre">/opt/musrflow/runtime</span></code>, which muSRFlow
|
|
recognizes automatically when no explicit tool directory takes precedence.</p>
|
|
</section>
|
|
<section id="alternative-runtime-appimage">
|
|
<h3>Alternative: runtime AppImage<a class="headerlink" href="#alternative-runtime-appimage" title="Link to this heading"></a></h3>
|
|
<p>For a user-writable runtime location:</p>
|
|
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>chmod<span class="w"> </span>+x<span class="w"> </span>musrflow-runtime-1.0.0-rc.6-x86_64.AppImage
|
|
./musrflow-runtime-1.0.0-rc.6-x86_64.AppImage<span class="w"> </span>--install<span class="w"> </span><span class="s2">"</span><span class="nv">$HOME</span><span class="s2">/.local/share/musrflow/runtime"</span>
|
|
</pre></div>
|
|
</div>
|
|
<p>Launch the application with the installed runtime selected:</p>
|
|
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nv">MUSRFLOW_RUNTIME_ROOT</span><span class="o">=</span><span class="s2">"</span><span class="nv">$HOME</span><span class="s2">/.local/share/musrflow/runtime"</span><span class="w"> </span>musrflow
|
|
</pre></div>
|
|
</div>
|
|
<p>For the application AppImage, replace <code class="docutils literal notranslate"><span class="pre">musrflow</span></code> in that command with its
|
|
path. Leave <strong>musrfit binaries</strong> on automatic detection so the selected
|
|
runtime is used. Without a custom destination, the runtime AppImage installs
|
|
to <code class="docutils literal notranslate"><span class="pre">/opt/musrflow/runtime</span></code> and needs permission to write there. Its filename
|
|
is lowercase <code class="docutils literal notranslate"><span class="pre">musrflow-runtime</span></code>, unlike the application AppImage.</p>
|
|
</section>
|
|
</section>
|
|
<section id="choose-folders-and-test">
|
|
<h2>Choose folders and test<a class="headerlink" href="#choose-folders-and-test" title="Link to this heading"></a></h2>
|
|
<ol class="arabic simple">
|
|
<li><p>In <strong>File / Preferences</strong>, choose a writable <strong>Work directory</strong> outside
|
|
the application installation folder, for example <code class="docutils literal notranslate"><span class="pre">~/muSRFlow/work</span></code>.
|
|
Use <strong>Browse…</strong> to select it.</p></li>
|
|
<li><p>Set <strong>Data directory</strong> to the root of your instrument data tree, or to a
|
|
writable folder such as <code class="docutils literal notranslate"><span class="pre">~/muSRFlow/data</span></code> for downloaded runs.</p></li>
|
|
<li><p>Leave <strong>musrfit startup XML</strong> on automatic detection unless you have a
|
|
specific installation configuration, then save.</p></li>
|
|
<li><p>Select a known instrument, year, and run. Click <strong>Plot</strong>, then <strong>Fit</strong>.
|
|
Confirm the spectrum opens, fitted parameters update, and output files
|
|
appear in your work directory. Missing runs can be downloaded from
|
|
<code class="docutils literal notranslate"><span class="pre">musruser.psi.ch</span></code> after confirmation when the server is reachable.</p></li>
|
|
</ol>
|
|
</section>
|
|
<section id="updating-and-troubleshooting">
|
|
<h2>Updating and troubleshooting<a class="headerlink" href="#updating-and-troubleshooting" title="Link to this heading"></a></h2>
|
|
<ul class="simple">
|
|
<li><p>Upgrade the application RPM with your package manager, or replace the
|
|
application AppImage. The separate runtime is not updated by an app upgrade.</p></li>
|
|
<li><p>Preserve work files outside the application/runtime installation directories.</p></li>
|
|
<li><p>For missing tools or shared libraries, run <strong>Check tools</strong> and inspect the
|
|
reported executable paths. A configured binaries directory overrides
|
|
automatic detection; clear an obsolete selection or choose the correct one.</p></li>
|
|
<li><p>If fitting works but no spectrum window opens, inspect the run log and
|
|
confirm your desktop session can display native musrview windows.</p></li>
|
|
<li><p>If data are missing, check the instrument, year, run number, and data root.
|
|
Downloaded files use the selected writable data root or the personal
|
|
fallback folder reported in Preferences.</p></li>
|
|
</ul>
|
|
<p>Include the application version and run log when reporting a problem.</p>
|
|
</section>
|
|
</section>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
|
<a href="install-windows.html" class="btn btn-neutral float-left" title="Windows installation" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
|
<a href="runs-fitting.html" class="btn btn-neutral float-right" title="Runs and fitting" 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> |