183 lines
9.7 KiB
HTML
183 lines
9.7 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>Getting started — 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="Runs and fitting" href="runs-fitting.html" />
|
|
<link rel="prev" title="Overview" href="overview.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 current"><a class="current reference internal" href="#">Getting started</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="#prerequisites">Prerequisites</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#desktop-installation">Desktop installation</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#running-the-desktop-app">Running the desktop app</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#opening-the-web-edition">Opening the web edition</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#the-quick-start-guide">The Quick Start guide</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#support">Support</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">Getting started</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
<a href="_sources/getting-started.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="getting-started">
|
|
<h1>Getting started<a class="headerlink" href="#getting-started" title="Link to this heading"></a></h1>
|
|
<section id="prerequisites">
|
|
<h2>Prerequisites<a class="headerlink" href="#prerequisites" title="Link to this heading"></a></h2>
|
|
<p>muSRFlow wraps external <code class="docutils literal notranslate"><span class="pre">musrfit</span></code> tools. They must be installed and on the
|
|
<code class="docutils literal notranslate"><span class="pre">PATH</span></code> on the machine that runs the tools:</p>
|
|
<ul class="simple">
|
|
<li><p>Desktop: on the machine running the Electron app.</p></li>
|
|
<li><p>Web: on the server that hosts the CGI runner.</p></li>
|
|
</ul>
|
|
<p>The browser edition needs no local installation at all.</p>
|
|
</section>
|
|
<section id="desktop-installation">
|
|
<h2>Desktop installation<a class="headerlink" href="#desktop-installation" title="Link to this heading"></a></h2>
|
|
<p>From a checkout, with <a class="reference external" href="https://nodejs.org/">Node.js</a> and npm installed:</p>
|
|
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span>npm<span class="w"> </span>install
|
|
<span class="gp">$ </span>npm<span class="w"> </span>start
|
|
</pre></div>
|
|
</div>
|
|
<p><cite>npm install</cite> is only needed once; later sessions start with <cite>npm start</cite>.</p>
|
|
<p>Release packages (Linux RPM and AppImage) are produced with:</p>
|
|
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span>npm<span class="w"> </span>run<span class="w"> </span>dist:rpm
|
|
<span class="gp">$ </span>npm<span class="w"> </span>run<span class="w"> </span>dist:appimage
|
|
</pre></div>
|
|
</div>
|
|
<p>The build and runtime requirements are described in
|
|
<code class="docutils literal notranslate"><span class="pre">docs/DESKTOP_DEPLOYMENT.md</span></code>.</p>
|
|
</section>
|
|
<section id="running-the-desktop-app">
|
|
<h2>Running the desktop app<a class="headerlink" href="#running-the-desktop-app" title="Link to this heading"></a></h2>
|
|
<p>When the window opens, the <strong>Runs</strong> tab is active and the current year is
|
|
already selected. Enter run numbers, choose a model, and press <strong>Fit</strong>. The
|
|
first fit writes the working files next to your MSR document and results
|
|
appear in the <strong>Results</strong> tab.</p>
|
|
</section>
|
|
<section id="opening-the-web-edition">
|
|
<h2>Opening the web edition<a class="headerlink" href="#opening-the-web-edition" title="Link to this heading"></a></h2>
|
|
<p>Point your browser at the deployment URL (e.g.
|
|
<code class="docutils literal notranslate"><span class="pre">http://musruser.psi.ch/muSRFlow/</span></code>). Instrument options and run numbers are
|
|
the ones the server data tree supports. There is nothing to install; the
|
|
parameter table is also served from the same data tree.</p>
|
|
</section>
|
|
<section id="the-quick-start-guide">
|
|
<h2>The Quick Start guide<a class="headerlink" href="#the-quick-start-guide" title="Link to this heading"></a></h2>
|
|
<p>The <code class="docutils literal notranslate"><span class="pre">?</span></code> button at the right of the tab bar opens a short, tab-aware guide.
|
|
On the desktop it opens in an independent window; in the browser it opens a
|
|
modeless dialog next to the main window. Each of its sections corresponds to
|
|
one tab and is expanded into a chapter of this manual.</p>
|
|
</section>
|
|
<section id="support">
|
|
<h2>Support<a class="headerlink" href="#support" title="Link to this heading"></a></h2>
|
|
<p>For questions and bug reports contact Zaher Salman
|
|
<a class="reference external" href="mailto:zaher.salman%40psi.ch">mailto:zaher<span>.</span>salman<span>@</span>psi<span>.</span>ch</a>. Issue tracking is linked from the project
|
|
repository.</p>
|
|
</section>
|
|
</section>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
|
<a href="overview.html" class="btn btn-neutral float-left" title="Overview" 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> |