226 lines
15 KiB
HTML
226 lines
15 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>muSRFlow User Manual — 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="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="#" 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>
|
|
<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"><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="#">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="#" class="icon icon-home" aria-label="Home"></a></li>
|
|
<li class="breadcrumb-item active">muSRFlow User Manual</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
<a href="_sources/index.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="musrflow-user-manual">
|
|
<h1>muSRFlow User Manual<a class="headerlink" href="#musrflow-user-manual" title="Link to this heading"></a></h1>
|
|
<p>muSRFlow is a graphical workflow for creating, editing, fitting, plotting, and
|
|
inspecting <code class="docutils literal notranslate"><span class="pre">musrfit</span></code> MSR files. It is available as an Electron desktop
|
|
application and as a browser application, and both editions wrap the same set
|
|
of command-line 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>).</p>
|
|
<p>These pages describe the end-user workflow. They are organised around the
|
|
main window tabs, mirroring the Quick Start help that is built into the
|
|
application (the <code class="docutils literal notranslate"><span class="pre">?</span></code> button).</p>
|
|
<div class="toctree-wrapper compound">
|
|
<p class="caption" role="heading"><span class="caption-text">Contents</span></p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="overview.html">Overview</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="overview.html#what-you-get">What you get</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="overview.html#under-the-hood">Under the hood</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="overview.html#two-editions">Two editions</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="overview.html#a-first-fit">A first fit</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="getting-started.html">Getting started</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="getting-started.html#prerequisites">Prerequisites</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="getting-started.html#desktop-installation">Desktop installation</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="getting-started.html#running-the-desktop-app">Running the desktop app</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="getting-started.html#opening-the-web-edition">Opening the web edition</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="getting-started.html#the-quick-start-guide">The Quick Start guide</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="getting-started.html#support">Support</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="runs-fitting.html">Runs and fitting</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="runs-fitting.html#run-selection">Run selection</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="runs-fitting.html#fit-range">Fit range</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="runs-fitting.html#fit-model">Fit model</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="runs-fitting.html#fit-options">Fit options</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="runs-fitting.html#series-fit-actions">Series fit actions</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="runs-fitting.html#view-settings">View settings</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="runs-fitting.html#fit-and-plot">Fit and Plot</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="parameters-plots.html">Parameters and parameter plots</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="parameters-plots.html#the-parameter-table">The parameter table</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="parameters-plots.html#selecting-parameters-for-plotting">Selecting parameters for plotting</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="parameters-plots.html#the-choose-x-axis-dialog">The Choose X axis dialog</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="parameters-plots.html#the-parameter-plot-window">The parameter-plot window</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="constraints.html">Constraints</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="constraints.html#custom-parameters">Custom parameters</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="constraints.html#id1">Constraints</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="constraints.html#example-couple-the-magnetic-field-to-the-larmor-frequency">Example: couple the magnetic field to the Larmor frequency</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="constraints.html#preview">Preview</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="t0-background.html">t0 / background</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="t0-background.html#multi-group-asymmetry-fits">Multi-group asymmetry fits</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="msr-editor.html">MSR editor</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="msr-editor.html#ownership-gui-or-editor">Ownership: GUI or editor</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="msr-editor.html#workflow">Workflow</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="msr-editor.html#file-handling">File handling</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="results-diagnostics.html">Results and diagnostics</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="results-diagnostics.html#result-files">Result files</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="results-diagnostics.html#execution-details">Execution details</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="results-diagnostics.html#command-log">Command log</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="results-diagnostics.html#the-status-bar">The status bar</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="results-diagnostics.html#run-log-window">Run log window</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="results-diagnostics.html#outcome-dialog">Outcome dialog</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="configuration-sharing.html">Configuration sharing</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="configuration-sharing.html#what-is-shared">What is shared</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="configuration-sharing.html#on-the-web">On the web</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="configuration-sharing.html#on-the-desktop">On the desktop</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="configuration-sharing.html#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><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="keyboard-shortcuts.html#parameter-selection-parameters-tab">Parameter selection (Parameters tab)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="keyboard-shortcuts.html#parameter-plot-window">Parameter-plot window</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="keyboard-shortcuts.html#msr-editor">MSR editor</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="keyboard-shortcuts.html#general-notes">General notes</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="troubleshooting.html">Troubleshooting</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="troubleshooting.html#fit-or-plot-will-not-start">Fit or plot will not start</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="troubleshooting.html#nothing-to-fit">“Nothing to fit”</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="troubleshooting.html#fitted-parameters-look-wrong-or-unchanged">Fitted parameters look wrong or unchanged</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="troubleshooting.html#parameter-plot-is-empty-or-missing-data">Parameter plot is empty or missing data</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="troubleshooting.html#parameter-plot-hangs-on-preparing-plot-files">Parameter plot hangs on “Preparing plot files”</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="troubleshooting.html#web-page-cannot-load-data">Web page cannot load data</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="troubleshooting.html#restored-configuration-differs-from-the-original-machine">Restored configuration differs from the original machine</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="troubleshooting.html#some-links-start-with-a-different-prefix">Some links start with a different prefix</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="troubleshooting.html#reporting-problems">Reporting problems</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="glossary.html">Glossary</a></li>
|
|
</ul>
|
|
</div>
|
|
<p>If anything in this manual does not match the behaviour you see, contact
|
|
<a class="reference external" href="mailto:zaher.salman%40psi.ch">Zaher Salman</a>.</p>
|
|
<p>Separate repository documents cover desk build and packaging
|
|
(<code class="docutils literal notranslate"><span class="pre">docs/DESKTOP_DEPLOYMENT.md</span></code>) and the web-server/CGI deployment
|
|
(<code class="docutils literal notranslate"><span class="pre">cgi/README.md</span></code>); this manual concentrates on using the application.</p>
|
|
</section>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
|
<a href="overview.html" class="btn btn-neutral float-right" title="Overview" 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> |