Illustrate user manual and include documentation in web deployment

Add real pre-fit UI screenshots, workflow diagrams, accessible captions, and image maintenance instructions. Correct run-count examples and rebuild the tracked HTML and PDF manuals.

Deploy the complete generated HTML manual with readable permissions. Check for missing documentation before modifying installed files and cover deployment, updates, and missing-doc failures with regression tests.
This commit is contained in:
salman committed 2026-10-30 16:25:53 +01:00
1 parent 12ecbf4f7d
commit 95b0cd8dcc
65 files changed
+974 -452

No files matched your search

+10 -1
View File
@@ -68,13 +68,22 @@ JSROOT to draw the ROOT files produced by `musrview --root`. Its server-side
runner is documented in
[`cgi/README.md`](cgi/README.md).
Install both the browser files and CGI endpoint. The script targets the default
Build the HTML manual, then install the browser files, manual, and CGI endpoint.
The build needs Sphinx and `sphinx_rtd_theme`; deployment only copies the generated
files, so Sphinx is not needed on the web server. The script targets the default
Apache paths and hands the files to the web server's owner:
```bash
make -C docs html
sudo ./scripts/deploy-web.sh
```
The complete manual is installed under `/muSRFlow/docs/`, including its styles
and search index. Rebuild it before each deployment to include documentation and
version changes. If `docs/_build/html/index.html` is missing or empty, deployment
stops before changing installed files. When deploying from a separate source
checkout on the server, transfer `docs/_build/html/` into that checkout first.
The web-only owner (`apache`/`www-data`/`httpd`) is auto-detected when the
deployed tree is not already owned by the invoking user, so the script also
runs unprivileged against a developer-owned web tree (skip that case's `sudo`).
+40
View File
@@ -0,0 +1,40 @@
<svg xmlns="http://www.w3.org/2000/svg" width="780" height="510" viewBox="0 0 780 510" role="img" aria-labelledby="title desc">
<title id="title">Where muSRFlow runs the scientific tools</title>
<desc id="desc">Linux runs native tools locally. Windows runs the bundled tools in WSL2 and keeps work files on Windows. The web interface calls a CGI server and shows ROOT plots using JSROOT.</desc>
<defs>
<marker id="arrow" markerWidth="8" markerHeight="8" refX="7" refY="4" orient="auto"><path d="M0 0 L8 4 L0 8" fill="#347249"/></marker>
<style>
text { font-family: DejaVu Sans, sans-serif; fill: #193724; }
.title { font-size: 25px; font-weight: bold; }
.heading { font-size: 18px; font-weight: bold; }
.body { font-size: 15px; }
.label { font-size: 16px; font-weight: bold; fill: #347249; }
.card { fill: white; stroke: #b8cbbd; stroke-width: 1.5; }
.arrow { stroke: #347249; stroke-width: 2; marker-end: url(#arrow); }
</style>
</defs>
<rect width="780" height="510" rx="16" fill="#f6f8f2"/>
<text x="28" y="43" class="title">One interface, three execution paths</text>
<text x="28" y="72" class="body">The place where the tools run determines data access and plotting.</text>
<text x="28" y="111" class="label">LINUX DESKTOP</text>
<rect x="28" y="124" width="200" height="82" rx="10" class="card"/>
<text x="48" y="154" class="heading">muSRFlow</text><text x="48" y="180" class="body">Electron application</text>
<path d="M233 165 H265" class="arrow"/>
<rect x="276" y="124" width="476" height="82" rx="10" class="card"/>
<text x="296" y="154" class="heading">Local ROOT + musrfit</text>
<text x="296" y="180" class="body">Existing installation or separate optional runtime</text>
<text x="28" y="241" class="label">WINDOWS DESKTOP</text>
<rect x="28" y="254" width="200" height="82" rx="10" class="card"/>
<text x="48" y="284" class="heading">muSRFlow</text><text x="48" y="310" class="body">Electron application</text>
<path d="M233 295 H265" class="arrow"/>
<rect x="276" y="254" width="476" height="82" rx="10" class="card"/>
<text x="296" y="284" class="heading">Bundled runtime inside WSL2</text>
<text x="296" y="310" class="body">Windows work files; musrview window via WSLg</text>
<text x="28" y="371" class="label">WEB BROWSER</text>
<rect x="28" y="384" width="200" height="82" rx="10" class="card"/>
<text x="48" y="414" class="heading">muSRFlow</text><text x="48" y="440" class="body">Browser interface</text>
<path d="M233 425 H265" class="arrow"/>
<rect x="276" y="384" width="476" height="82" rx="10" class="card"/>
<text x="296" y="414" class="heading">CGI server + ROOT + musrfit</text>
<text x="296" y="440" class="body">Server data; ROOT plots displayed with JSROOT</text>
</svg>

After

Width:  |  Height:  |  Size: 2.7 KiB

+52
View File
@@ -0,0 +1,52 @@
<svg xmlns="http://www.w3.org/2000/svg" width="780" height="540" viewBox="0 0 780 540" role="img" aria-labelledby="title desc">
<title id="title">From run selection to fitted parameters</title>
<desc id="desc">Choose runs and a model, prepare an MSR document, run musrfit, then review fitted values and plots. Plot prepares a document but does not run the minimizer.</desc>
<defs>
<marker id="arrow" markerWidth="8" markerHeight="8" refX="7" refY="4" orient="auto"><path d="M0 0 L8 4 L0 8" fill="#347249"/></marker>
<style>
text { font-family: DejaVu Sans, sans-serif; fill: #193724; }
.title { font-size: 25px; font-weight: bold; }
.heading { font-size: 19px; font-weight: bold; }
.body { font-size: 16px; }
.note { font-size: 15px; fill: #44594a; }
.number { font-size: 18px; font-weight: bold; fill: white; }
.card { fill: white; stroke: #b8cbbd; stroke-width: 1.5; }
.arrow { fill: none; stroke: #347249; stroke-width: 2; marker-end: url(#arrow); }
</style>
</defs>
<rect width="780" height="540" rx="16" fill="#f6f8f2"/>
<text x="28" y="43" class="title">A fit, step by step</text>
<text x="28" y="69" class="note">A workflow diagram, not a fit result</text>
<rect x="28" y="92" width="350" height="76" rx="10" class="card"/>
<circle cx="55" cy="119" r="16" fill="#347249"/><text x="49" y="125" class="number">1</text>
<text x="82" y="121" class="heading">Choose the analysis</text>
<text x="82" y="148" class="body">Runs, model, range, parameters</text>
<path d="M203 169 V186" class="arrow"/>
<rect x="28" y="192" width="350" height="76" rx="10" class="card"/>
<circle cx="55" cy="219" r="16" fill="#347249"/><text x="49" y="225" class="number">2</text>
<text x="82" y="221" class="heading">Prepare the MSR</text>
<text x="82" y="248" class="body">Settings become a fit document</text>
<path d="M203 269 V286" class="arrow"/>
<rect x="28" y="292" width="350" height="76" rx="10" class="card"/>
<circle cx="55" cy="319" r="16" fill="#347249"/><text x="49" y="325" class="number">3</text>
<text x="82" y="321" class="heading">Fit with musrfit</text>
<text x="82" y="348" class="body">The fitted MSR holds the results</text>
<path d="M203 369 V386" class="arrow"/>
<rect x="28" y="392" width="350" height="76" rx="10" class="card"/>
<circle cx="55" cy="419" r="16" fill="#347249"/><text x="49" y="425" class="number">4</text>
<text x="82" y="421" class="heading">Review and refine</text>
<text x="82" y="448" class="body">Inspect values, spectra, and logs</text>
<rect x="408" y="92" width="344" height="176" rx="10" fill="#e7eee3"/>
<text x="430" y="122" class="heading">Who controls the document?</text>
<text x="430" y="152" class="body">GUI-owned: generate from settings.</text>
<text x="430" y="182" class="body">Editor-owned: use the edited MSR.</text>
<text x="430" y="219" class="note">An editor-owned document is not</text>
<text x="430" y="242" class="note">silently replaced by GUI settings.</text>
<rect x="408" y="292" width="344" height="174" rx="10" fill="#e7eee3"/>
<text x="430" y="322" class="heading">After fitting</text>
<text x="430" y="353" class="body">Fitted values update the table.</text>
<text x="430" y="382" class="body">musrview displays the spectra.</text>
<text x="430" y="411" class="body">msr2data collects parameters</text>
<text x="430" y="435" class="body">for parameter plots.</text>
<text x="28" y="508" class="body">Plot prepares the MSR and opens the viewer without running the minimizer.</text>
</svg>

After

Width:  |  Height:  |  Size: 3.5 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 113 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 78 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 95 KiB

+8
View File
@@ -42,6 +42,14 @@ spectrum. Press **Fit** to fit it and refresh the parameter table. Generated
files go to the selected work directory; the **Results** tab and run log
show the outcome.
.. figure:: images/runs-tab.png
:alt: Runs tab showing LEM run 514 from 2025, fit range, exponential cosine model, and Fit and Plot buttons.
:width: 100%
The browser edition before fitting. Run 514 (LEM, 2025) is an example
selection, not a validated fit configuration. Choose your runs and model
here; the Fit and Plot buttons remain available across tabs.
Opening the web edition
-----------------------
+7 -7
View File
@@ -9,7 +9,7 @@ runtime.** You can use an existing installation or install the separate
runtime through Preferences. Node.js and npm are not needed on the target PC.
The current application packages are for x86_64 Linux. Examples below use
``1.0.0-rc.5``; substitute the version of the package you obtained. Run the
``1.0.0-rc.6``; substitute the version of the package you obtained. Run the
commands from the folder containing the downloaded files.
Install the application
@@ -24,7 +24,7 @@ On an RPM-based distribution with dnf:
.. code-block:: bash
sudo dnf install ./musrflow-1.0.0-rc.5-x86_64.rpm
sudo dnf install ./musrflow-1.0.0-rc.6-x86_64.rpm
musrflow
On other RPM systems, use the distribution's package manager. The application
@@ -35,8 +35,8 @@ AppImage
.. code-block:: bash
chmod +x muSRFlow-1.0.0-rc.5-x86_64.AppImage
./muSRFlow-1.0.0-rc.5-x86_64.AppImage
chmod +x muSRFlow-1.0.0-rc.6-x86_64.AppImage
./muSRFlow-1.0.0-rc.6-x86_64.AppImage
The application AppImage filename starts with ``muSRFlow``. It requires a
compatible Linux desktop and AppImage/FUSE support. If it cannot start,
@@ -75,7 +75,7 @@ Alternative: system runtime RPM
.. code-block:: bash
sudo dnf install ./musrflow-runtime-1.0.0-rc.5-x86_64.rpm
sudo dnf install ./musrflow-runtime-1.0.0-rc.6-x86_64.rpm
This installs the runtime into ``/opt/musrflow/runtime``, which muSRFlow
recognizes automatically when no explicit tool directory takes precedence.
@@ -87,8 +87,8 @@ For a user-writable runtime location:
.. code-block:: bash
chmod +x musrflow-runtime-1.0.0-rc.5-x86_64.AppImage
./musrflow-runtime-1.0.0-rc.5-x86_64.AppImage --install "$HOME/.local/share/musrflow/runtime"
chmod +x musrflow-runtime-1.0.0-rc.6-x86_64.AppImage
./musrflow-runtime-1.0.0-rc.6-x86_64.AppImage --install "$HOME/.local/share/musrflow/runtime"
Launch the application with the installed runtime selected:
+11 -7
View File
@@ -17,14 +17,18 @@ Before you start
* Windows 11 is recommended. Windows 10 requires build 19044 or newer for
WSLg, which displays the musrview spectrum windows.
* Administrator access is needed to enable the Windows virtualization features.
* Obtain the Windows installer, named ``muSRFlow-<version>-x64.exe``. The
current release candidate is ``1.0.0-rc.5``.
* Obtain the Windows installer, named ``muSRFlow-<version>-x64.exe``, from
the project's `Releases <https://gitea.psi.ch/salman/muSRFlow/releases>`_
or the **musrflow-windows** package in
`Packages <https://gitea.psi.ch/salman/muSRFlow/packages>`_. Verify its
SHA-256 checksum against the accompanying ``.sha256`` file.
* For a test build that has not been published yet, download the
**musrflow-windows-x64** artifact from a successful **Build Windows
installer** workflow run and extract the installer.
**Use the refreshed Windows build.** Earlier rc.5 installers have the same
filename but lack the WSL fixes. Obtain a build containing commit ``a6981c4``
or later. In the development workspace, the verified replacement is
``dist/windows-runtime-fix/muSRFlow-1.0.0-rc.5-x64.exe``; this is a local build
output, not a public download address.
**Avoid old rc.5 installers.** Early builds lack the WSL fixes. The current
runner-built installer includes them and has passed Windows installation,
runtime setup, data download, Fit/Plot, and multi-run smoke tests.
See `Microsoft's WSL GUI requirements
<https://learn.microsoft.com/en-us/windows/wsl/tutorials/gui-apps>`_ for the
+9 -1
View File
@@ -5,6 +5,14 @@ The **MSR Editor** tab displays the complete MSR file that muSRFlow prepares.
It is a real editor, not just a preview: you can edit the text by hand, and
the edited document becomes the source of truth for the next Fit or Plot.
.. figure:: images/msr-editor-tab.png
:alt: MSR Editor showing a generated unfitted MSR with highlighted block keywords and comments, the GUI to MSR button, and the ownership lock.
:width: 100%
A document generated with **GUI -> MSR**, before any fit. Syntax colours
separate keywords and comments. The open padlock shows that the GUI still
owns this document; editing it by hand changes that state.
Ownership: GUI or editor
------------------------
@@ -52,4 +60,4 @@ artifacts.
The editor also shows which source document it currently displays. For a
multiple-run fit it can expose the generated document and the template it
was built from; the active tab (**MSR** or **Template**) selects which one
is shown.
is shown.
+8 -1
View File
@@ -5,6 +5,13 @@ muSRFlow provides a modern interface over the classic µSR analysis tools. A
typical session selects the data, chooses a fit model, fits it, inspects the
result, and finally inspects how the fitted parameters vary run by run.
.. figure:: images/fit-workflow.*
:alt: Four steps: choose the analysis, prepare the MSR, fit with musrfit, then review fitted values and plots. Plot skips the minimizer.
:width: 100%
The basic fit workflow. See :doc:`runs-fitting` for independent series
and shared-parameter fits, and :doc:`msr-editor` for document ownership.
What you get
------------
@@ -79,4 +86,4 @@ A first fit
The Quick Start button (``?``) at the right of the tab bar opens a short
guide that highlights the section relevant to the active tab. Its sections
are expanded into the chapters of this manual.
are expanded into the chapters of this manual.
+9 -1
View File
@@ -6,6 +6,14 @@ parameter, per data set, with starting values, steps, and limits. Fitting
feeds the measured values back, and the same table drives the interactive
parameter plots.
.. figure:: images/parameters-tab.png
:alt: Parameters tab with editable starting values, error or step fields, bounds, and the Plot parameters button.
:width: 100%
Example parameter table before fitting, for the same run and model as
:doc:`getting-started`. These are initial values, not measured results;
the Error column contains starting steps at this stage.
The parameter table
-------------------
@@ -248,4 +256,4 @@ With a panel focused (and not while typing in a field), the shortcut keys are:
The plotly mode bar at the top-right of each panel provides zoom, pan, box
select, and download, and a custom button toggles each axis between linear
and logarithmic. Trace colours are assigned automatically per series --
clicking a marker opens the style editor described above to change them.
clicking a marker opens the style editor described above to change them.
+7
View File
@@ -5,6 +5,13 @@ Both editions share the tabs, fit engine, model library, parameter plots, and
configuration-sharing protocol. The differences come from where the data and
the command-line tools live.
.. figure:: images/execution-locations.*
:alt: Linux runs native tools locally; Windows runs its bundled tools in WSL2; the browser sends work to the CGI server.
:width: 100%
Standard execution paths. Windows can also use explicitly configured
native binaries instead of the bundled WSL runtime.
.. list-table::
:header-rows: 1
:widths: 25 35 40
+3 -3
View File
@@ -14,7 +14,7 @@ Run(s)
sequence, for example ``520:540:2``.
Each comma- or range-separated data set is fit independently and merged
into one fit document, so ``514, 516, 520-525`` prepares six data sets.
into one fit document, so ``514, 516, 520-525`` prepares eight data sets.
A ``+`` between runs adds the run to the previous data set via the MSR
``ADDRUN`` directive rather than starting a new data set. ``514+515`` is
@@ -23,7 +23,7 @@ Run(s)
Examples:
* ``514`` -- one run.
* ``514, 520-525`` -- two data sets: 514 and each of 520..525.
* ``514, 520-525`` -- seven data sets: 514 and each of 520..525.
* ``514+515, 520:540:2`` -- one ADDRUN data set and a stepped range.
Year
@@ -223,4 +223,4 @@ edition always fits on the server and ignores the setting.
If the MSR editor owns the document (a hand-edited MSR is authoritative), the
editor block is used for Fit and Plot as-is and GUI changes do not silently
replace it -- see :doc:`msr-editor`.
replace it -- see :doc:`msr-editor`.
+1 -1
View File
@@ -1,5 +1,5 @@
const DOCUMENTATION_OPTIONS = {
VERSION: '1.0.0-rc.5',
VERSION: '1.0.0-rc.6',
LANGUAGE: 'en',
COLLAPSE_INDEX: false,
BUILDER: 'html',
+1 -1
View File
@@ -13,7 +13,7 @@
<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=b77d6c2f"></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>
+1 -1
View File
@@ -13,7 +13,7 @@
<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=b77d6c2f"></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>
+1 -1
View File
@@ -12,7 +12,7 @@
<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=b77d6c2f"></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>
+10 -1
View File
@@ -13,7 +13,7 @@
<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=b77d6c2f"></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>
@@ -130,6 +130,15 @@ year, and run numbers, check the model, and press <strong>Plot</strong> to inspe
spectrum. Press <strong>Fit</strong> to fit it and refresh the parameter table. Generated
files go to the selected work directory; the <strong>Results</strong> tab and run log
show the outcome.</p>
<figure class="align-default" id="id2">
<a class="reference internal image-reference" href="_images/runs-tab.png"><img alt="Runs tab showing LEM run 514 from 2025, fit range, exponential cosine model, and Fit and Plot buttons." src="_images/runs-tab.png" style="width: 100%;" />
</a>
<figcaption>
<p><span class="caption-text">The browser edition before fitting. Run 514 (LEM, 2025) is an example
selection, not a validated fit configuration. Choose your runs and model
here; the Fit and Plot buttons remain available across tabs.</span><a class="headerlink" href="#id2" title="Link to this image"></a></p>
</figcaption>
</figure>
</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>
+1 -1
View File
@@ -13,7 +13,7 @@
<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=b77d6c2f"></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>
+1 -1
View File
@@ -13,7 +13,7 @@
<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=b77d6c2f"></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>
+8 -8
View File
@@ -13,7 +13,7 @@
<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=b77d6c2f"></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>
@@ -109,7 +109,7 @@ installation. <strong>The Linux application package does not include the scienti
runtime.</strong> You can use an existing installation or install the separate
runtime through Preferences. 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.5</span></code>; substitute the version of the package you obtained. Run the
<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>
@@ -117,7 +117,7 @@ commands from the folder containing the downloaded files.</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.5-x86_64.rpm
<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>
@@ -126,8 +126,8 @@ RPM filename starts with lowercase <code class="docutils literal notranslate"><s
</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.5-x86_64.AppImage
./muSRFlow-1.0.0-rc.5-x86_64.AppImage
<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
@@ -163,7 +163,7 @@ 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.5-x86_64.rpm
<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
@@ -172,8 +172,8 @@ recognizes automatically when no explicit tool directory takes precedence.</p>
<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.5-x86_64.AppImage
./musrflow-runtime-1.0.0-rc.5-x86_64.AppImage<span class="w"> </span>--install<span class="w"> </span><span class="s2">&quot;</span><span class="nv">$HOME</span><span class="s2">/.local/share/musrflow/runtime&quot;</span>
<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">&quot;</span><span class="nv">$HOME</span><span class="s2">/.local/share/musrflow/runtime&quot;</span>
</pre></div>
</div>
<p>Launch the application with the installed runtime selected:</p>
+12 -8
View File
@@ -13,7 +13,7 @@
<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=b77d6c2f"></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>
@@ -114,14 +114,18 @@ the application does not update an already imported WSL runtime.</p>
<li><p>Windows 11 is recommended. Windows 10 requires build 19044 or newer for
WSLg, which displays the musrview spectrum windows.</p></li>
<li><p>Administrator access is needed to enable the Windows virtualization features.</p></li>
<li><p>Obtain the Windows installer, named <code class="docutils literal notranslate"><span class="pre">muSRFlow-&lt;version&gt;-x64.exe</span></code>. The
current release candidate is <code class="docutils literal notranslate"><span class="pre">1.0.0-rc.5</span></code>.</p></li>
<li><p>Obtain the Windows installer, named <code class="docutils literal notranslate"><span class="pre">muSRFlow-&lt;version&gt;-x64.exe</span></code>, from
the project’s <a class="reference external" href="https://gitea.psi.ch/salman/muSRFlow/releases">Releases</a>
or the <strong>musrflow-windows</strong> package in
<a class="reference external" href="https://gitea.psi.ch/salman/muSRFlow/packages">Packages</a>. Verify its
SHA-256 checksum against the accompanying <code class="docutils literal notranslate"><span class="pre">.sha256</span></code> file.</p></li>
<li><p>For a test build that has not been published yet, download the
<strong>musrflow-windows-x64</strong> artifact from a successful <strong>Build Windows
installer</strong> workflow run and extract the installer.</p></li>
</ul>
<p><strong>Use the refreshed Windows build.</strong> Earlier rc.5 installers have the same
filename but lack the WSL fixes. Obtain a build containing commit <code class="docutils literal notranslate"><span class="pre">a6981c4</span></code>
or later. In the development workspace, the verified replacement is
<code class="docutils literal notranslate"><span class="pre">dist/windows-runtime-fix/muSRFlow-1.0.0-rc.5-x64.exe</span></code>; this is a local build
output, not a public download address.</p>
<p><strong>Avoid old rc.5 installers.</strong> Early builds lack the WSL fixes. The current
runner-built installer includes them and has passed Windows installation,
runtime setup, data download, Fit/Plot, and multi-run smoke tests.</p>
<p>See <a class="reference external" href="https://learn.microsoft.com/en-us/windows/wsl/tutorials/gui-apps">Microsoft’s WSL GUI requirements</a> for the
Windows prerequisites.</p>
</section>
+1 -1
View File
@@ -13,7 +13,7 @@
<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=b77d6c2f"></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>
+10 -1
View File
@@ -13,7 +13,7 @@
<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=b77d6c2f"></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>
@@ -96,6 +96,15 @@
<p>The <strong>MSR Editor</strong> tab displays the complete MSR file that muSRFlow prepares.
It is a real editor, not just a preview: you can edit the text by hand, and
the edited document becomes the source of truth for the next Fit or Plot.</p>
<figure class="align-default" id="id1">
<a class="reference internal image-reference" href="_images/msr-editor-tab.png"><img alt="MSR Editor showing a generated unfitted MSR with highlighted block keywords and comments, the GUI to MSR button, and the ownership lock." src="_images/msr-editor-tab.png" style="width: 100%;" />
</a>
<figcaption>
<p><span class="caption-text">A document generated with <strong>GUI -&gt; MSR</strong>, before any fit. Syntax colours
separate keywords and comments. The open padlock shows that the GUI still
owns this document; editing it by hand changes that state.</span><a class="headerlink" href="#id1" title="Link to this image"></a></p>
</figcaption>
</figure>
<section id="ownership-gui-or-editor">
<h2>Ownership: GUI or editor<a class="headerlink" href="#ownership-gui-or-editor" title="Link to this heading"></a></h2>
<p>Two actors can own the document:</p>
BIN
View File
Binary file not shown.
+9 -1
View File
@@ -13,7 +13,7 @@
<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=b77d6c2f"></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>
@@ -97,6 +97,14 @@
<p>muSRFlow provides a modern interface over the classic µSR analysis tools. A
typical session selects the data, chooses a fit model, fits it, inspects the
result, and finally inspects how the fitted parameters vary run by run.</p>
<figure class="align-default" id="id1">
<a class="reference internal image-reference" href="_images/fit-workflow.svg"><img alt="Four steps: choose the analysis, prepare the MSR, fit with musrfit, then review fitted values and plots. Plot skips the minimizer." src="_images/fit-workflow.svg" style="width: 100%;" />
</a>
<figcaption>
<p><span class="caption-text">The basic fit workflow. See <a class="reference internal" href="runs-fitting.html"><span class="doc">Runs and fitting</span></a> for independent series
and shared-parameter fits, and <a class="reference internal" href="msr-editor.html"><span class="doc">MSR editor</span></a> for document ownership.</span><a class="headerlink" href="#id1" title="Link to this image"></a></p>
</figcaption>
</figure>
<section id="what-you-get">
<h2>What you get<a class="headerlink" href="#what-you-get" title="Link to this heading"></a></h2>
<ul class="simple">
+10 -1
View File
@@ -13,7 +13,7 @@
<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=b77d6c2f"></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>
@@ -109,6 +109,15 @@
parameter, per data set, with starting values, steps, and limits. Fitting
feeds the measured values back, and the same table drives the interactive
parameter plots.</p>
<figure class="align-default" id="id2">
<a class="reference internal image-reference" href="_images/parameters-tab.png"><img alt="Parameters tab with editable starting values, error or step fields, bounds, and the Plot parameters button." src="_images/parameters-tab.png" style="width: 100%;" />
</a>
<figcaption>
<p><span class="caption-text">Example parameter table before fitting, for the same run and model as
<a class="reference internal" href="getting-started.html"><span class="doc">Getting started</span></a>. These are initial values, not measured results;
the Error column contains starting steps at this stage.</span><a class="headerlink" href="#id2" title="Link to this image"></a></p>
</figcaption>
</figure>
<section id="the-parameter-table">
<h2>The parameter table<a class="headerlink" href="#the-parameter-table" title="Link to this heading"></a></h2>
<p>The table is rebuilt automatically whenever the model changes (a new
+9 -1
View File
@@ -13,7 +13,7 @@
<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=b77d6c2f"></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>
@@ -95,6 +95,14 @@
<p>Both editions share the tabs, fit engine, model library, parameter plots, and
configuration-sharing protocol. The differences come from where the data and
the command-line tools live.</p>
<figure class="align-default" id="id1">
<a class="reference internal image-reference" href="_images/execution-locations.svg"><img alt="Linux runs native tools locally; Windows runs its bundled tools in WSL2; the browser sends work to the CGI server." src="_images/execution-locations.svg" style="width: 100%;" />
</a>
<figcaption>
<p><span class="caption-text">Standard execution paths. Windows can also use explicitly configured
native binaries instead of the bundled WSL runtime.</span><a class="headerlink" href="#id1" title="Link to this image"></a></p>
</figcaption>
</figure>
<table class="docutils align-default">
<colgroup>
<col style="width: 25.0%" />
+1 -1
View File
@@ -13,7 +13,7 @@
<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=b77d6c2f"></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>
+1 -1
View File
@@ -13,7 +13,7 @@
<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=b77d6c2f"></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>
+3 -3
View File
@@ -13,7 +13,7 @@
<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=b77d6c2f"></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>
@@ -110,14 +110,14 @@ settings used for Plot, FFT, and RRF.</p>
range and a colon-with-step <code class="docutils literal notranslate"><span class="pre">from:to:step</span></code> produces a regular
sequence, for example <code class="docutils literal notranslate"><span class="pre">520:540:2</span></code>.</p>
<p>Each comma- or range-separated data set is fit independently and merged
into one fit document, so <code class="docutils literal notranslate"><span class="pre">514,</span> <span class="pre">516,</span> <span class="pre">520-525</span></code> prepares six data sets.</p>
into one fit document, so <code class="docutils literal notranslate"><span class="pre">514,</span> <span class="pre">516,</span> <span class="pre">520-525</span></code> prepares eight data sets.</p>
<p>A <code class="docutils literal notranslate"><span class="pre">+</span></code> between runs adds the run to the previous data set via the MSR
<code class="docutils literal notranslate"><span class="pre">ADDRUN</span></code> directive rather than starting a new data set. <code class="docutils literal notranslate"><span class="pre">514+515</span></code> is
a single data set composed of two runs.</p>
<p>Examples:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">514</span></code> – one run.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">514,</span> <span class="pre">520-525</span></code> – two data sets: 514 and each of 520..525.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">514,</span> <span class="pre">520-525</span></code> – seven data sets: 514 and each of 520..525.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">514+515,</span> <span class="pre">520:540:2</span></code> – one ADDRUN data set and a stepped range.</p></li>
</ul>
</dd>
+1 -1
View File
@@ -13,7 +13,7 @@
<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=b77d6c2f"></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>
+1 -1
View File
@@ -1 +1 @@
Search.setIndex({"alltitles":{"A first fit":[[9,"a-first-fit"]],"Alternative: runtime AppImage":[[5,"alternative-runtime-appimage"]],"Alternative: system runtime RPM":[[5,"alternative-system-runtime-rpm"]],"AppImage":[[5,"appimage"]],"Before you start":[[6,"before-you-start"]],"Bundled ROOT and musrfit":[[11,"bundled-root-and-musrfit"]],"Cannot find wsl.exe":[[6,"cannot-find-wsl-exe"]],"Cannot load libCore.so":[[6,"cannot-load-libcore-so"]],"Choose folders and test":[[5,"choose-folders-and-test"]],"Choose your edition":[[2,"choose-your-edition"]],"Command log":[[13,"command-log"]],"Configuration sharing":[[0,null]],"Constraints":[[1,null],[1,"id1"]],"Contents":[[4,null]],"Custom parameters":[[1,"custom-parameters"]],"Desktop installation":[[2,"desktop-installation"]],"Downloading missing runs":[[11,"downloading-missing-runs"]],"Editing trace styles":[[10,"editing-trace-styles"]],"Example: couple the magnetic field to the Larmor frequency":[[1,"example-couple-the-magnetic-field-to-the-larmor-frequency"]],"Execution details":[[13,"execution-details"]],"Existing installations":[[6,"existing-installations"]],"File handling":[[8,"file-handling"]],"Fit and Plot":[[14,"fit-and-plot"]],"Fit model":[[14,"fit-model"]],"Fit options":[[14,"fit-options"]],"Fit or plot will not start":[[16,"fit-or-plot-will-not-start"]],"Fit range":[[14,"fit-range"]],"Fitted parameters look wrong or unchanged":[[16,"fitted-parameters-look-wrong-or-unchanged"]],"General notes":[[7,"general-notes"]],"Getting started":[[2,null]],"Glossary":[[3,null]],"Install step by step":[[6,"install-step-by-step"]],"Install the application":[[5,"install-the-application"]],"Install the separate runtime from a local bundle":[[5,"install-the-separate-runtime-from-a-local-bundle"]],"Keyboard shortcuts":[[7,null],[10,"keyboard-shortcuts"]],"Linux installation":[[5,null]],"MSR editor":[[7,"msr-editor"],[8,null]],"Missing boost/version.hpp or plotting crash":[[6,"missing-boost-version-hpp-or-plotting-crash"]],"Multi-group asymmetry fits":[[15,"multi-group-asymmetry-fits"]],"No spectrum window appears":[[6,"no-spectrum-window-appears"]],"Notes":[[0,"notes"]],"On the desktop":[[0,"on-the-desktop"]],"On the web":[[0,"on-the-web"]],"Opening the web edition":[[2,"opening-the-web-edition"]],"Outcome dialog":[[13,"outcome-dialog"]],"Overlay data sets (multiple files in one panel)":[[10,"overlay-data-sets-multiple-files-in-one-panel"]],"Overview":[[9,null]],"Ownership: GUI or editor":[[8,"ownership-gui-or-editor"]],"Parameter plot hangs on \u201cPreparing plot files\u201d":[[16,"parameter-plot-hangs-on-preparing-plot-files"]],"Parameter plot is empty or missing data":[[16,"parameter-plot-is-empty-or-missing-data"]],"Parameter selection (Parameters tab)":[[7,"parameter-selection-parameters-tab"]],"Parameter-plot window":[[7,"parameter-plot-window"]],"Parameters and parameter plots":[[10,null]],"Per-run statistics":[[14,"per-run-statistics"]],"Plot options":[[10,"plot-options"]],"Preferences":[[12,null]],"Preview":[[1,"preview"]],"RPM":[[5,"rpm"]],"Remembered plot configurations":[[10,"remembered-plot-configurations"]],"Reporting a problem":[[6,"reporting-a-problem"]],"Reporting problems":[[16,"reporting-problems"]],"Required feature is not installed":[[6,"required-feature-is-not-installed"]],"Restored configuration differs from the original machine":[[16,"restored-configuration-differs-from-the-original-machine"]],"Result files":[[13,"result-files"]],"Results and diagnostics":[[13,null]],"Run log window":[[13,"run-log-window"]],"Run selection":[[14,"run-selection"]],"Running the desktop app":[[2,"running-the-desktop-app"]],"Runs and fitting":[[14,null]],"Selecting parameters for plotting":[[10,"selecting-parameters-for-plotting"]],"Series fit actions":[[14,"series-fit-actions"]],"Set up ROOT and musrfit":[[5,"set-up-root-and-musrfit"]],"Some links start with a different prefix":[[16,"some-links-start-with-a-different-prefix"]],"Support":[[2,"support"]],"Template and series presets":[[10,"template-and-series-presets"]],"The Choose X axis dialog":[[10,"the-choose-x-axis-dialog"]],"The Quick Start guide":[[2,"the-quick-start-guide"]],"The Shared column":[[10,"the-shared-column"]],"The parameter table":[[10,"the-parameter-table"]],"The parameter-plot window":[[10,"the-parameter-plot-window"]],"The status bar":[[13,"the-status-bar"]],"Troubleshooting":[[6,"troubleshooting"],[16,null]],"Two editions":[[9,"two-editions"]],"Under the hood":[[9,"under-the-hood"]],"Updating and troubleshooting":[[5,"updating-and-troubleshooting"]],"Use an existing installation":[[5,"use-an-existing-installation"]],"View settings":[[14,"view-settings"]],"Web and desktop editions":[[11,null]],"Web page cannot load data":[[16,"web-page-cannot-load-data"]],"What is shared":[[0,"what-is-shared"]],"What you get":[[9,"what-you-get"]],"Windows installation":[[2,"windows-installation"],[6,null]],"Workflow":[[8,"workflow"]],"muSRFlow User Manual":[[4,null]],"t0 / background":[[15,null]],"\u201cNothing to Line truncated
Search.setIndex({"alltitles":{"A first fit":[[9,"a-first-fit"]],"Alternative: runtime AppImage":[[5,"alternative-runtime-appimage"]],"Alternative: system runtime RPM":[[5,"alternative-system-runtime-rpm"]],"AppImage":[[5,"appimage"]],"Before you start":[[6,"before-you-start"]],"Bundled ROOT and musrfit":[[11,"bundled-root-and-musrfit"]],"Cannot find wsl.exe":[[6,"cannot-find-wsl-exe"]],"Cannot load libCore.so":[[6,"cannot-load-libcore-so"]],"Choose folders and test":[[5,"choose-folders-and-test"]],"Choose your edition":[[2,"choose-your-edition"]],"Command log":[[13,"command-log"]],"Configuration sharing":[[0,null]],"Constraints":[[1,null],[1,"id1"]],"Contents":[[4,null]],"Custom parameters":[[1,"custom-parameters"]],"Desktop installation":[[2,"desktop-installation"]],"Downloading missing runs":[[11,"downloading-missing-runs"]],"Editing trace styles":[[10,"editing-trace-styles"]],"Example: couple the magnetic field to the Larmor frequency":[[1,"example-couple-the-magnetic-field-to-the-larmor-frequency"]],"Execution details":[[13,"execution-details"]],"Existing installations":[[6,"existing-installations"]],"File handling":[[8,"file-handling"]],"Fit and Plot":[[14,"fit-and-plot"]],"Fit model":[[14,"fit-model"]],"Fit options":[[14,"fit-options"]],"Fit or plot will not start":[[16,"fit-or-plot-will-not-start"]],"Fit range":[[14,"fit-range"]],"Fitted parameters look wrong or unchanged":[[16,"fitted-parameters-look-wrong-or-unchanged"]],"General notes":[[7,"general-notes"]],"Getting started":[[2,null]],"Glossary":[[3,null]],"Install step by step":[[6,"install-step-by-step"]],"Install the application":[[5,"install-the-application"]],"Install the separate runtime from a local bundle":[[5,"install-the-separate-runtime-from-a-local-bundle"]],"Keyboard shortcuts":[[7,null],[10,"keyboard-shortcuts"]],"Linux installation":[[5,null]],"MSR editor":[[7,"msr-editor"],[8,null]],"Missing boost/version.hpp or plotting crash":[[6,"missing-boost-version-hpp-or-plotting-crash"]],"Multi-group asymmetry fits":[[15,"multi-group-asymmetry-fits"]],"No spectrum window appears":[[6,"no-spectrum-window-appears"]],"Notes":[[0,"notes"]],"On the desktop":[[0,"on-the-desktop"]],"On the web":[[0,"on-the-web"]],"Opening the web edition":[[2,"opening-the-web-edition"]],"Outcome dialog":[[13,"outcome-dialog"]],"Overlay data sets (multiple files in one panel)":[[10,"overlay-data-sets-multiple-files-in-one-panel"]],"Overview":[[9,null]],"Ownership: GUI or editor":[[8,"ownership-gui-or-editor"]],"Parameter plot hangs on \u201cPreparing plot files\u201d":[[16,"parameter-plot-hangs-on-preparing-plot-files"]],"Parameter plot is empty or missing data":[[16,"parameter-plot-is-empty-or-missing-data"]],"Parameter selection (Parameters tab)":[[7,"parameter-selection-parameters-tab"]],"Parameter-plot window":[[7,"parameter-plot-window"]],"Parameters and parameter plots":[[10,null]],"Per-run statistics":[[14,"per-run-statistics"]],"Plot options":[[10,"plot-options"]],"Preferences":[[12,null]],"Preview":[[1,"preview"]],"RPM":[[5,"rpm"]],"Remembered plot configurations":[[10,"remembered-plot-configurations"]],"Reporting a problem":[[6,"reporting-a-problem"]],"Reporting problems":[[16,"reporting-problems"]],"Required feature is not installed":[[6,"required-feature-is-not-installed"]],"Restored configuration differs from the original machine":[[16,"restored-configuration-differs-from-the-original-machine"]],"Result files":[[13,"result-files"]],"Results and diagnostics":[[13,null]],"Run log window":[[13,"run-log-window"]],"Run selection":[[14,"run-selection"]],"Running the desktop app":[[2,"running-the-desktop-app"]],"Runs and fitting":[[14,null]],"Selecting parameters for plotting":[[10,"selecting-parameters-for-plotting"]],"Series fit actions":[[14,"series-fit-actions"]],"Set up ROOT and musrfit":[[5,"set-up-root-and-musrfit"]],"Some links start with a different prefix":[[16,"some-links-start-with-a-different-prefix"]],"Support":[[2,"support"]],"Template and series presets":[[10,"template-and-series-presets"]],"The Choose X axis dialog":[[10,"the-choose-x-axis-dialog"]],"The Quick Start guide":[[2,"the-quick-start-guide"]],"The Shared column":[[10,"the-shared-column"]],"The parameter table":[[10,"the-parameter-table"]],"The parameter-plot window":[[10,"the-parameter-plot-window"]],"The status bar":[[13,"the-status-bar"]],"Troubleshooting":[[6,"troubleshooting"],[16,null]],"Two editions":[[9,"two-editions"]],"Under the hood":[[9,"under-the-hood"]],"Updating and troubleshooting":[[5,"updating-and-troubleshooting"]],"Use an existing installation":[[5,"use-an-existing-installation"]],"View settings":[[14,"view-settings"]],"Web and desktop editions":[[11,null]],"Web page cannot load data":[[16,"web-page-cannot-load-data"]],"What is shared":[[0,"what-is-shared"]],"What you get":[[9,"what-you-get"]],"Windows installation":[[2,"windows-installation"],[6,null]],"Workflow":[[8,"workflow"]],"muSRFlow User Manual":[[4,null]],"t0 / background":[[15,null]],"\u201cNothing to Line truncated
+1 -1
View File
@@ -13,7 +13,7 @@
<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=b77d6c2f"></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>
+1 -1
View File
@@ -13,7 +13,7 @@
<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=b77d6c2f"></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>
Binary file not shown.

After

Width:  |  Height:  |  Size: 175 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 244 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 113 KiB

+241 -231
View File
@@ -14,264 +14,274 @@
\newlabel{overview::doc}{{1}{3}{Overview}{chapter.1}{}}
\@writefile{toc}{\contentsline {section}{\numberline {1.1}What you get}{3}{section.1.1}\protected@file@percent }
\newlabel{overview:what-you-get}{{1.1}{3}{What you get}{section.1.1}{}}
\@writefile{toc}{\contentsline {section}{\numberline {1.2}Under the hood}{4}{section.1.2}\protected@file@percent }
\newlabel{overview:under-the-hood}{{1.2}{4}{Under the hood}{section.1.2}{}}
\@writefile{toc}{\contentsline {section}{\numberline {1.3}Two editions}{4}{section.1.3}\protected@file@percent }
\newlabel{overview:two-editions}{{1.3}{4}{Two editions}{section.1.3}{}}
\@writefile{toc}{\contentsline {section}{\numberline {1.4}A first fit}{4}{section.1.4}\protected@file@percent }
\newlabel{overview:a-first-fit}{{1.4}{4}{A first fit}{section.1.4}{}}
\@writefile{toc}{\contentsline {chapter}{\numberline {2}Getting started}{5}{chapter.2}\protected@file@percent }
\@writefile{lof}{\contentsline {figure}{\numberline {1}{\ignorespaces \xpg@aux {}{english}\ignorespaces The basic fit workflow. See {\hyperref [runs-fitting::doc]{\sphinxcrossref {Runs and fitting}}} for independent series and shared\sphinxhyphen {}parameter fits, and {\hyperref [msr-editor::doc]{\sphinxcrossref {MSR editor}}} for document ownership.}}{4}{figure.1.1}\protected@file@percent }
\newlabel{overview:id1}{{1}{4}{\texorpdfstring {\xpg@aux {\xpg@current@opts }{\languagename }}{}\ignorespaces The basic fit workflow. See {\hyperref [\detokenize {runs-fitting::doc}]{\sphinxcrossref {\DUrole {doc}{Runs and fitting}}}} for independent series and shared\sphinxhyphen {}parameter fits, and {\hyperref [\detokenize {msr-editor::doc}]{\sphinxcrossref {\DUrole {doc}{MSR editor}}}} for document ownership}{figure.1.1}{}}
\@writefile{toc}{\contentsline {section}{\numberline {1.2}Under the hood}{5}{section.1.2}\protected@file@percent }
\newlabel{overview:under-the-hood}{{1.2}{5}{Under the hood}{section.1.2}{}}
\@writefile{toc}{\contentsline {section}{\numberline {1.3}Two editions}{5}{section.1.3}\protected@file@percent }
\newlabel{overview:two-editions}{{1.3}{5}{Two editions}{section.1.3}{}}
\@writefile{toc}{\contentsline {section}{\numberline {1.4}A first fit}{5}{section.1.4}\protected@file@percent }
\newlabel{overview:a-first-fit}{{1.4}{5}{A first fit}{section.1.4}{}}
\@writefile{toc}{\contentsline {chapter}{\numberline {2}Getting started}{7}{chapter.2}\protected@file@percent }
\@writefile{lof}{\addvspace {10\p@ }}
\@writefile{lot}{\addvspace {10\p@ }}
\newlabel{getting-started:getting-started}{{2}{5}{Getting started}{chapter.2}{}}
\newlabel{getting-started::doc}{{2}{5}{Getting started}{chapter.2}{}}
\@writefile{toc}{\contentsline {section}{\numberline {2.1}Choose your edition}{5}{section.2.1}\protected@file@percent }
\newlabel{getting-started:choose-your-edition}{{2.1}{5}{Choose your edition}{section.2.1}{}}
\@writefile{toc}{\contentsline {section}{\numberline {2.2}Desktop installation}{5}{section.2.2}\protected@file@percent }
\newlabel{getting-started:desktop-installation}{{2.2}{5}{Desktop installation}{section.2.2}{}}
\newlabel{getting-started:id1}{{2.2}{5}{Desktop installation}{section.2.2}{}}
\@writefile{toc}{\contentsline {section}{\numberline {2.3}Windows installation}{5}{section.2.3}\protected@file@percent }
\newlabel{getting-started:windows-installation}{{2.3}{5}{Windows installation}{section.2.3}{}}
\newlabel{getting-started:getting-started-windows-installation}{{2.3}{5}{Windows installation}{section.2.3}{}}
\@writefile{toc}{\contentsline {section}{\numberline {2.4}Running the desktop app}{6}{section.2.4}\protected@file@percent }
\newlabel{getting-started:running-the-desktop-app}{{2.4}{6}{Running the desktop app}{section.2.4}{}}
\@writefile{toc}{\contentsline {section}{\numberline {2.5}Opening the web edition}{6}{section.2.5}\protected@file@percent }
\newlabel{getting-started:opening-the-web-edition}{{2.5}{6}{Opening the web edition}{section.2.5}{}}
\@writefile{toc}{\contentsline {section}{\numberline {2.6}The Quick Start guide}{6}{section.2.6}\protected@file@percent }
\newlabel{getting-started:the-quick-start-guide}{{2.6}{6}{The Quick Start guide}{section.2.6}{}}
\@writefile{toc}{\contentsline {section}{\numberline {2.7}Support}{6}{section.2.7}\protected@file@percent }
\newlabel{getting-started:support}{{2.7}{6}{Support}{section.2.7}{}}
\@writefile{toc}{\contentsline {chapter}{\numberline {3}Windows installation}{7}{chapter.3}\protected@file@percent }
\newlabel{getting-started:getting-started}{{2}{7}{Getting started}{chapter.2}{}}
\newlabel{getting-started::doc}{{2}{7}{Getting started}{chapter.2}{}}
\@writefile{toc}{\contentsline {section}{\numberline {2.1}Choose your edition}{7}{section.2.1}\protected@file@percent }
\newlabel{getting-started:choose-your-edition}{{2.1}{7}{Choose your edition}{section.2.1}{}}
\@writefile{toc}{\contentsline {section}{\numberline {2.2}Desktop installation}{7}{section.2.2}\protected@file@percent }
\newlabel{getting-started:desktop-installation}{{2.2}{7}{Desktop installation}{section.2.2}{}}
\newlabel{getting-started:id1}{{2.2}{7}{Desktop installation}{section.2.2}{}}
\@writefile{toc}{\contentsline {section}{\numberline {2.3}Windows installation}{7}{section.2.3}\protected@file@percent }
\newlabel{getting-started:windows-installation}{{2.3}{7}{Windows installation}{section.2.3}{}}
\newlabel{getting-started:getting-started-windows-installation}{{2.3}{7}{Windows installation}{section.2.3}{}}
\@writefile{toc}{\contentsline {section}{\numberline {2.4}Running the desktop app}{8}{section.2.4}\protected@file@percent }
\newlabel{getting-started:running-the-desktop-app}{{2.4}{8}{Running the desktop app}{section.2.4}{}}
\@writefile{lof}{\contentsline {figure}{\numberline {1}{\ignorespaces \xpg@aux {}{english}\ignorespaces The browser edition before fitting. Run 514 (LEM, 2025) is an example selection, not a validated fit configuration. Choose your runs and model here; the Fit and Plot buttons remain available across tabs.}}{8}{figure.2.1}\protected@file@percent }
\newlabel{getting-started:id2}{{1}{8}{\texorpdfstring {\xpg@aux {\xpg@current@opts }{\languagename }}{}\ignorespaces The browser edition before fitting. Run 514 (LEM, 2025) is an example selection, not a validated fit configuration. Choose your runs and model here; the Fit and Plot buttons remain available across tabs}{figure.2.1}{}}
\@writefile{toc}{\contentsline {section}{\numberline {2.5}Opening the web edition}{8}{section.2.5}\protected@file@percent }
\newlabel{getting-started:opening-the-web-edition}{{2.5}{8}{Opening the web edition}{section.2.5}{}}
\@writefile{toc}{\contentsline {section}{\numberline {2.6}The Quick Start guide}{8}{section.2.6}\protected@file@percent }
\newlabel{getting-started:the-quick-start-guide}{{2.6}{8}{The Quick Start guide}{section.2.6}{}}
\@writefile{toc}{\contentsline {section}{\numberline {2.7}Support}{9}{section.2.7}\protected@file@percent }
\newlabel{getting-started:support}{{2.7}{9}{Support}{section.2.7}{}}
\@writefile{toc}{\contentsline {chapter}{\numberline {3}Windows installation}{11}{chapter.3}\protected@file@percent }
\@writefile{lof}{\addvspace {10\p@ }}
\@writefile{lot}{\addvspace {10\p@ }}
\newlabel{install-windows:windows-installation}{{3}{7}{Windows installation}{chapter.3}{}}
\newlabel{install-windows:id1}{{3}{7}{Windows installation}{chapter.3}{}}
\newlabel{install-windows::doc}{{3}{7}{Windows installation}{chapter.3}{}}
\@writefile{toc}{\contentsline {section}{\numberline {3.1}Before you start}{7}{section.3.1}\protected@file@percent }
\newlabel{install-windows:before-you-start}{{3.1}{7}{Before you start}{section.3.1}{}}
\@writefile{toc}{\contentsline {section}{\numberline {3.2}Install step by step}{8}{section.3.2}\protected@file@percent }
\newlabel{install-windows:install-step-by-step}{{3.2}{8}{Install step by step}{section.3.2}{}}
\@writefile{toc}{\contentsline {section}{\numberline {3.3}Existing installations}{9}{section.3.3}\protected@file@percent }
\newlabel{install-windows:existing-installations}{{3.3}{9}{Existing installations}{section.3.3}{}}
\@writefile{toc}{\contentsline {section}{\numberline {3.4}Troubleshooting}{9}{section.3.4}\protected@file@percent }
\newlabel{install-windows:troubleshooting}{{3.4}{9}{Troubleshooting}{section.3.4}{}}
\@writefile{toc}{\contentsline {subsection}{\numberline {3.4.1}Required feature is not installed}{9}{subsection.3.4.1}\protected@file@percent }
\newlabel{install-windows:required-feature-is-not-installed}{{3.4.1}{9}{Required feature is not installed}{subsection.3.4.1}{}}
\@writefile{toc}{\contentsline {subsection}{\numberline {3.4.2}Cannot find wsl.exe}{9}{subsection.3.4.2}\protected@file@percent }
\newlabel{install-windows:cannot-find-wsl-exe}{{3.4.2}{9}{Cannot find wsl.exe}{subsection.3.4.2}{}}
\@writefile{toc}{\contentsline {subsection}{\numberline {3.4.3}Cannot load libCore.so}{10}{subsection.3.4.3}\protected@file@percent }
\newlabel{install-windows:cannot-load-libcore-so}{{3.4.3}{10}{Cannot load libCore.so}{subsection.3.4.3}{}}
\@writefile{toc}{\contentsline {subsection}{\numberline {3.4.4}Missing boost/version.hpp or plotting crash}{10}{subsection.3.4.4}\protected@file@percent }
\newlabel{install-windows:missing-boost-version-hpp-or-plotting-crash}{{3.4.4}{10}{Missing boost/version.hpp or plotting crash}{subsection.3.4.4}{}}
\@writefile{toc}{\contentsline {subsection}{\numberline {3.4.5}No spectrum window appears}{10}{subsection.3.4.5}\protected@file@percent }
\newlabel{install-windows:no-spectrum-window-appears}{{3.4.5}{10}{No spectrum window appears}{subsection.3.4.5}{}}
\@writefile{toc}{\contentsline {subsection}{\numberline {3.4.6}Reporting a problem}{10}{subsection.3.4.6}\protected@file@percent }
\newlabel{install-windows:reporting-a-problem}{{3.4.6}{10}{Reporting a problem}{subsection.3.4.6}{}}
\@writefile{toc}{\contentsline {chapter}{\numberline {4}Linux installation}{11}{chapter.4}\protected@file@percent }
\newlabel{install-windows:windows-installation}{{3}{11}{Windows installation}{chapter.3}{}}
\newlabel{install-windows:id1}{{3}{11}{Windows installation}{chapter.3}{}}
\newlabel{install-windows::doc}{{3}{11}{Windows installation}{chapter.3}{}}
\@writefile{toc}{\contentsline {section}{\numberline {3.1}Before you start}{11}{section.3.1}\protected@file@percent }
\newlabel{install-windows:before-you-start}{{3.1}{11}{Before you start}{section.3.1}{}}
\@writefile{toc}{\contentsline {section}{\numberline {3.2}Install step by step}{12}{section.3.2}\protected@file@percent }
\newlabel{install-windows:install-step-by-step}{{3.2}{12}{Install step by step}{section.3.2}{}}
\@writefile{toc}{\contentsline {section}{\numberline {3.3}Existing installations}{13}{section.3.3}\protected@file@percent }
\newlabel{install-windows:existing-installations}{{3.3}{13}{Existing installations}{section.3.3}{}}
\@writefile{toc}{\contentsline {section}{\numberline {3.4}Troubleshooting}{13}{section.3.4}\protected@file@percent }
\newlabel{install-windows:troubleshooting}{{3.4}{13}{Troubleshooting}{section.3.4}{}}
\@writefile{toc}{\contentsline {subsection}{\numberline {3.4.1}Required feature is not installed}{13}{subsection.3.4.1}\protected@file@percent }
\newlabel{install-windows:required-feature-is-not-installed}{{3.4.1}{13}{Required feature is not installed}{subsection.3.4.1}{}}
\@writefile{toc}{\contentsline {subsection}{\numberline {3.4.2}Cannot find wsl.exe}{13}{subsection.3.4.2}\protected@file@percent }
\newlabel{install-windows:cannot-find-wsl-exe}{{3.4.2}{13}{Cannot find wsl.exe}{subsection.3.4.2}{}}
\@writefile{toc}{\contentsline {subsection}{\numberline {3.4.3}Cannot load libCore.so}{14}{subsection.3.4.3}\protected@file@percent }
\newlabel{install-windows:cannot-load-libcore-so}{{3.4.3}{14}{Cannot load libCore.so}{subsection.3.4.3}{}}
\@writefile{toc}{\contentsline {subsection}{\numberline {3.4.4}Missing boost/version.hpp or plotting crash}{14}{subsection.3.4.4}\protected@file@percent }
\newlabel{install-windows:missing-boost-version-hpp-or-plotting-crash}{{3.4.4}{14}{Missing boost/version.hpp or plotting crash}{subsection.3.4.4}{}}
\@writefile{toc}{\contentsline {subsection}{\numberline {3.4.5}No spectrum window appears}{14}{subsection.3.4.5}\protected@file@percent }
\newlabel{install-windows:no-spectrum-window-appears}{{3.4.5}{14}{No spectrum window appears}{subsection.3.4.5}{}}
\@writefile{toc}{\contentsline {subsection}{\numberline {3.4.6}Reporting a problem}{14}{subsection.3.4.6}\protected@file@percent }
\newlabel{install-windows:reporting-a-problem}{{3.4.6}{14}{Reporting a problem}{subsection.3.4.6}{}}
\@writefile{toc}{\contentsline {chapter}{\numberline {4}Linux installation}{15}{chapter.4}\protected@file@percent }
\@writefile{lof}{\addvspace {10\p@ }}
\@writefile{lot}{\addvspace {10\p@ }}
\newlabel{install-linux:linux-installation}{{4}{11}{Linux installation}{chapter.4}{}}
\newlabel{install-linux:id1}{{4}{11}{Linux installation}{chapter.4}{}}
\newlabel{install-linux::doc}{{4}{11}{Linux installation}{chapter.4}{}}
\@writefile{toc}{\contentsline {section}{\numberline {4.1}Install the application}{11}{section.4.1}\protected@file@percent }
\newlabel{install-linux:install-the-application}{{4.1}{11}{Install the application}{section.4.1}{}}
\@writefile{toc}{\contentsline {subsection}{\numberline {4.1.1}RPM}{11}{subsection.4.1.1}\protected@file@percent }
\newlabel{install-linux:rpm}{{4.1.1}{11}{RPM}{subsection.4.1.1}{}}
\@writefile{toc}{\contentsline {subsection}{\numberline {4.1.2}AppImage}{11}{subsection.4.1.2}\protected@file@percent }
\newlabel{install-linux:appimage}{{4.1.2}{11}{AppImage}{subsection.4.1.2}{}}
\@writefile{toc}{\contentsline {section}{\numberline {4.2}Set up ROOT and musrfit}{12}{section.4.2}\protected@file@percent }
\newlabel{install-linux:set-up-root-and-musrfit}{{4.2}{12}{Set up ROOT and musrfit}{section.4.2}{}}
\@writefile{toc}{\contentsline {subsection}{\numberline {4.2.1}Use an existing installation}{12}{subsection.4.2.1}\protected@file@percent }
\newlabel{install-linux:use-an-existing-installation}{{4.2.1}{12}{Use an existing installation}{subsection.4.2.1}{}}
\@writefile{toc}{\contentsline {subsection}{\numberline {4.2.2}Install the separate runtime from a local bundle}{12}{subsection.4.2.2}\protected@file@percent }
\newlabel{install-linux:install-the-separate-runtime-from-a-local-bundle}{{4.2.2}{12}{Install the separate runtime from a local bundle}{subsection.4.2.2}{}}
\@writefile{toc}{\contentsline {subsection}{\numberline {4.2.3}Alternative: system runtime RPM}{12}{subsection.4.2.3}\protected@file@percent }
\newlabel{install-linux:alternative-system-runtime-rpm}{{4.2.3}{12}{Alternative: system runtime RPM}{subsection.4.2.3}{}}
\@writefile{toc}{\contentsline {subsection}{\numberline {4.2.4}Alternative: runtime AppImage}{12}{subsection.4.2.4}\protected@file@percent }
\newlabel{install-linux:alternative-runtime-appimage}{{4.2.4}{12}{Alternative: runtime AppImage}{subsection.4.2.4}{}}
\@writefile{toc}{\contentsline {section}{\numberline {4.3}Choose folders and test}{13}{section.4.3}\protected@file@percent }
\newlabel{install-linux:choose-folders-and-test}{{4.3}{13}{Choose folders and test}{section.4.3}{}}
\@writefile{toc}{\contentsline {section}{\numberline {4.4}Updating and troubleshooting}{13}{section.4.4}\protected@file@percent }
\newlabel{install-linux:updating-and-troubleshooting}{{4.4}{13}{Updating and troubleshooting}{section.4.4}{}}
\@writefile{toc}{\contentsline {chapter}{\numberline {5}Runs and fitting}{15}{chapter.5}\protected@file@percent }
\newlabel{install-linux:linux-installation}{{4}{15}{Linux installation}{chapter.4}{}}
\newlabel{install-linux:id1}{{4}{15}{Linux installation}{chapter.4}{}}
\newlabel{install-linux::doc}{{4}{15}{Linux installation}{chapter.4}{}}
\@writefile{toc}{\contentsline {section}{\numberline {4.1}Install the application}{15}{section.4.1}\protected@file@percent }
\newlabel{install-linux:install-the-application}{{4.1}{15}{Install the application}{section.4.1}{}}
\@writefile{toc}{\contentsline {subsection}{\numberline {4.1.1}RPM}{15}{subsection.4.1.1}\protected@file@percent }
\newlabel{install-linux:rpm}{{4.1.1}{15}{RPM}{subsection.4.1.1}{}}
\@writefile{toc}{\contentsline {subsection}{\numberline {4.1.2}AppImage}{15}{subsection.4.1.2}\protected@file@percent }
\newlabel{install-linux:appimage}{{4.1.2}{15}{AppImage}{subsection.4.1.2}{}}
\@writefile{toc}{\contentsline {section}{\numberline {4.2}Set up ROOT and musrfit}{16}{section.4.2}\protected@file@percent }
\newlabel{install-linux:set-up-root-and-musrfit}{{4.2}{16}{Set up ROOT and musrfit}{section.4.2}{}}
\@writefile{toc}{\contentsline {subsection}{\numberline {4.2.1}Use an existing installation}{16}{subsection.4.2.1}\protected@file@percent }
\newlabel{install-linux:use-an-existing-installation}{{4.2.1}{16}{Use an existing installation}{subsection.4.2.1}{}}
\@writefile{toc}{\contentsline {subsection}{\numberline {4.2.2}Install the separate runtime from a local bundle}{16}{subsection.4.2.2}\protected@file@percent }
\newlabel{install-linux:install-the-separate-runtime-from-a-local-bundle}{{4.2.2}{16}{Install the separate runtime from a local bundle}{subsection.4.2.2}{}}
\@writefile{toc}{\contentsline {subsection}{\numberline {4.2.3}Alternative: system runtime RPM}{16}{subsection.4.2.3}\protected@file@percent }
\newlabel{install-linux:alternative-system-runtime-rpm}{{4.2.3}{16}{Alternative: system runtime RPM}{subsection.4.2.3}{}}
\@writefile{toc}{\contentsline {subsection}{\numberline {4.2.4}Alternative: runtime AppImage}{16}{subsection.4.2.4}\protected@file@percent }
\newlabel{install-linux:alternative-runtime-appimage}{{4.2.4}{16}{Alternative: runtime AppImage}{subsection.4.2.4}{}}
\@writefile{toc}{\contentsline {section}{\numberline {4.3}Choose folders and test}{17}{section.4.3}\protected@file@percent }
\newlabel{install-linux:choose-folders-and-test}{{4.3}{17}{Choose folders and test}{section.4.3}{}}
\@writefile{toc}{\contentsline {section}{\numberline {4.4}Updating and troubleshooting}{17}{section.4.4}\protected@file@percent }
\newlabel{install-linux:updating-and-troubleshooting}{{4.4}{17}{Updating and troubleshooting}{section.4.4}{}}
\@writefile{toc}{\contentsline {chapter}{\numberline {5}Runs and fitting}{19}{chapter.5}\protected@file@percent }
\@writefile{lof}{\addvspace {10\p@ }}
\@writefile{lot}{\addvspace {10\p@ }}
\newlabel{runs-fitting:runs-and-fitting}{{5}{15}{Runs and fitting}{chapter.5}{}}
\newlabel{runs-fitting::doc}{{5}{15}{Runs and fitting}{chapter.5}{}}
\@writefile{toc}{\contentsline {section}{\numberline {5.1}Run selection}{15}{section.5.1}\protected@file@percent }
\newlabel{runs-fitting:run-selection}{{5.1}{15}{Run selection}{section.5.1}{}}
\@writefile{toc}{\contentsline {section}{\numberline {5.2}Fit range}{16}{section.5.2}\protected@file@percent }
\newlabel{runs-fitting:fit-range}{{5.2}{16}{Fit range}{section.5.2}{}}
\@writefile{toc}{\contentsline {section}{\numberline {5.3}Fit model}{16}{section.5.3}\protected@file@percent }
\newlabel{runs-fitting:fit-model}{{5.3}{16}{Fit model}{section.5.3}{}}
\@writefile{toc}{\contentsline {section}{\numberline {5.4}Fit options}{17}{section.5.4}\protected@file@percent }
\newlabel{runs-fitting:fit-options}{{5.4}{17}{Fit options}{section.5.4}{}}
\@writefile{toc}{\contentsline {section}{\numberline {5.5}Series fit actions}{17}{section.5.5}\protected@file@percent }
\newlabel{runs-fitting:series-fit-actions}{{5.5}{17}{Series fit actions}{section.5.5}{}}
\@writefile{toc}{\contentsline {subsection}{\numberline {5.5.1}Per\sphinxhyphen {}run statistics}{17}{subsection.5.5.1}\protected@file@percent }
\newlabel{runs-fitting:per-run-statistics}{{5.5.1}{17}{Per\sphinxhyphen {}run statistics}{subsection.5.5.1}{}}
\@writefile{toc}{\contentsline {section}{\numberline {5.6}View settings}{18}{section.5.6}\protected@file@percent }
\newlabel{runs-fitting:view-settings}{{5.6}{18}{View settings}{section.5.6}{}}
\@writefile{toc}{\contentsline {section}{\numberline {5.7}Fit and Plot}{18}{section.5.7}\protected@file@percent }
\newlabel{runs-fitting:fit-and-plot}{{5.7}{18}{Fit and Plot}{section.5.7}{}}
\@writefile{toc}{\contentsline {chapter}{\numberline {6}Parameters and parameter plots}{21}{chapter.6}\protected@file@percent }
\newlabel{runs-fitting:runs-and-fitting}{{5}{19}{Runs and fitting}{chapter.5}{}}
\newlabel{runs-fitting::doc}{{5}{19}{Runs and fitting}{chapter.5}{}}
\@writefile{toc}{\contentsline {section}{\numberline {5.1}Run selection}{19}{section.5.1}\protected@file@percent }
\newlabel{runs-fitting:run-selection}{{5.1}{19}{Run selection}{section.5.1}{}}
\@writefile{toc}{\contentsline {section}{\numberline {5.2}Fit range}{20}{section.5.2}\protected@file@percent }
\newlabel{runs-fitting:fit-range}{{5.2}{20}{Fit range}{section.5.2}{}}
\@writefile{toc}{\contentsline {section}{\numberline {5.3}Fit model}{20}{section.5.3}\protected@file@percent }
\newlabel{runs-fitting:fit-model}{{5.3}{20}{Fit model}{section.5.3}{}}
\@writefile{toc}{\contentsline {section}{\numberline {5.4}Fit options}{21}{section.5.4}\protected@file@percent }
\newlabel{runs-fitting:fit-options}{{5.4}{21}{Fit options}{section.5.4}{}}
\@writefile{toc}{\contentsline {section}{\numberline {5.5}Series fit actions}{21}{section.5.5}\protected@file@percent }
\newlabel{runs-fitting:series-fit-actions}{{5.5}{21}{Series fit actions}{section.5.5}{}}
\@writefile{toc}{\contentsline {subsection}{\numberline {5.5.1}Per\sphinxhyphen {}run statistics}{21}{subsection.5.5.1}\protected@file@percent }
\newlabel{runs-fitting:per-run-statistics}{{5.5.1}{21}{Per\sphinxhyphen {}run statistics}{subsection.5.5.1}{}}
\@writefile{toc}{\contentsline {section}{\numberline {5.6}View settings}{22}{section.5.6}\protected@file@percent }
\newlabel{runs-fitting:view-settings}{{5.6}{22}{View settings}{section.5.6}{}}
\@writefile{toc}{\contentsline {section}{\numberline {5.7}Fit and Plot}{22}{section.5.7}\protected@file@percent }
\newlabel{runs-fitting:fit-and-plot}{{5.7}{22}{Fit and Plot}{section.5.7}{}}
\@writefile{toc}{\contentsline {chapter}{\numberline {6}Parameters and parameter plots}{25}{chapter.6}\protected@file@percent }
\@writefile{lof}{\addvspace {10\p@ }}
\@writefile{lot}{\addvspace {10\p@ }}
\newlabel{parameters-plots:parameters-and-parameter-plots}{{6}{21}{Parameters and parameter plots}{chapter.6}{}}
\newlabel{parameters-plots::doc}{{6}{21}{Parameters and parameter plots}{chapter.6}{}}
\@writefile{toc}{\contentsline {section}{\numberline {6.1}The parameter table}{21}{section.6.1}\protected@file@percent }
\newlabel{parameters-plots:the-parameter-table}{{6.1}{21}{The parameter table}{section.6.1}{}}
\@writefile{toc}{\contentsline {subsection}{\numberline {6.1.1}The \sphinxstylestrong {Shared} column}{22}{subsection.6.1.1}\protected@file@percent }
\newlabel{parameters-plots:the-shared-column}{{6.1.1}{22}{The \sphinxstylestrong {Shared} column}{subsection.6.1.1}{}}
\@writefile{toc}{\contentsline {section}{\numberline {6.2}Selecting parameters for plotting}{22}{section.6.2}\protected@file@percent }
\newlabel{parameters-plots:selecting-parameters-for-plotting}{{6.2}{22}{Selecting parameters for plotting}{section.6.2}{}}
\@writefile{toc}{\contentsline {section}{\numberline {6.3}The Choose X axis dialog}{22}{section.6.3}\protected@file@percent }
\newlabel{parameters-plots:the-choose-x-axis-dialog}{{6.3}{22}{The Choose X axis dialog}{section.6.3}{}}
\@writefile{toc}{\contentsline {section}{\numberline {6.4}The parameter\sphinxhyphen {}plot window}{22}{section.6.4}\protected@file@percent }
\newlabel{parameters-plots:the-parameter-plot-window}{{6.4}{22}{The parameter\sphinxhyphen {}plot window}{section.6.4}{}}
\@writefile{toc}{\contentsline {subsection}{\numberline {6.4.1}Plot options}{23}{subsection.6.4.1}\protected@file@percent }
\newlabel{parameters-plots:plot-options}{{6.4.1}{23}{Plot options}{subsection.6.4.1}{}}
\@writefile{toc}{\contentsline {subsection}{\numberline {6.4.2}Remembered plot configurations}{23}{subsection.6.4.2}\protected@file@percent }
\newlabel{parameters-plots:remembered-plot-configurations}{{6.4.2}{23}{Remembered plot configurations}{subsection.6.4.2}{}}
\newlabel{parameters-plots:id1}{{6.4.2}{23}{Remembered plot configurations}{subsection.6.4.2}{}}
\@writefile{toc}{\contentsline {subsection}{\numberline {6.4.3}Overlay data sets (multiple files in one panel)}{24}{subsection.6.4.3}\protected@file@percent }
\newlabel{parameters-plots:overlay-data-sets-multiple-files-in-one-panel}{{6.4.3}{24}{Overlay data sets (multiple files in one panel)}{subsection.6.4.3}{}}
\@writefile{toc}{\contentsline {subsection}{\numberline {6.4.4}Editing trace styles}{25}{subsection.6.4.4}\protected@file@percent }
\newlabel{parameters-plots:editing-trace-styles}{{6.4.4}{25}{Editing trace styles}{subsection.6.4.4}{}}
\@writefile{toc}{\contentsline {subsection}{\numberline {6.4.5}Template and series presets}{25}{subsection.6.4.5}\protected@file@percent }
\newlabel{parameters-plots:template-and-series-presets}{{6.4.5}{25}{Template and series presets}{subsection.6.4.5}{}}
\@writefile{toc}{\contentsline {subsection}{\numberline {6.4.6}Keyboard shortcuts}{25}{subsection.6.4.6}\protected@file@percent }
\newlabel{parameters-plots:keyboard-shortcuts}{{6.4.6}{25}{Keyboard shortcuts}{subsection.6.4.6}{}}
\@writefile{toc}{\contentsline {chapter}{\numberline {7}Constraints}{27}{chapter.7}\protected@file@percent }
\newlabel{parameters-plots:parameters-and-parameter-plots}{{6}{25}{Parameters and parameter plots}{chapter.6}{}}
\newlabel{parameters-plots::doc}{{6}{25}{Parameters and parameter plots}{chapter.6}{}}
\@writefile{lof}{\contentsline {figure}{\numberline {1}{\ignorespaces \xpg@aux {}{english}\ignorespaces Example parameter table before fitting, for the same run and model as {\hyperref [getting-started::doc]{\sphinxcrossref {Getting started}}}. These are initial values, not measured results; the Error column contains starting steps at this stage.}}{25}{figure.6.1}\protected@file@percent }
\newlabel{parameters-plots:id2}{{1}{25}{\texorpdfstring {\xpg@aux {\xpg@current@opts }{\languagename }}{}\ignorespaces Example parameter table before fitting, for the same run and model as {\hyperref [\detokenize {getting-started::doc}]{\sphinxcrossref {\DUrole {doc}{Getting started}}}}. These are initial values, not measured results; the Error column contains starting steps at this stage}{figure.6.1}{}}
\@writefile{toc}{\contentsline {section}{\numberline {6.1}The parameter table}{26}{section.6.1}\protected@file@percent }
\newlabel{parameters-plots:the-parameter-table}{{6.1}{26}{The parameter table}{section.6.1}{}}
\@writefile{toc}{\contentsline {subsection}{\numberline {6.1.1}The \sphinxstylestrong {Shared} column}{26}{subsection.6.1.1}\protected@file@percent }
\newlabel{parameters-plots:the-shared-column}{{6.1.1}{26}{The \sphinxstylestrong {Shared} column}{subsection.6.1.1}{}}
\@writefile{toc}{\contentsline {section}{\numberline {6.2}Selecting parameters for plotting}{26}{section.6.2}\protected@file@percent }
\newlabel{parameters-plots:selecting-parameters-for-plotting}{{6.2}{26}{Selecting parameters for plotting}{section.6.2}{}}
\@writefile{toc}{\contentsline {section}{\numberline {6.3}The Choose X axis dialog}{27}{section.6.3}\protected@file@percent }
\newlabel{parameters-plots:the-choose-x-axis-dialog}{{6.3}{27}{The Choose X axis dialog}{section.6.3}{}}
\@writefile{toc}{\contentsline {section}{\numberline {6.4}The parameter\sphinxhyphen {}plot window}{27}{section.6.4}\protected@file@percent }
\newlabel{parameters-plots:the-parameter-plot-window}{{6.4}{27}{The parameter\sphinxhyphen {}plot window}{section.6.4}{}}
\@writefile{toc}{\contentsline {subsection}{\numberline {6.4.1}Plot options}{28}{subsection.6.4.1}\protected@file@percent }
\newlabel{parameters-plots:plot-options}{{6.4.1}{28}{Plot options}{subsection.6.4.1}{}}
\@writefile{toc}{\contentsline {subsection}{\numberline {6.4.2}Remembered plot configurations}{28}{subsection.6.4.2}\protected@file@percent }
\newlabel{parameters-plots:remembered-plot-configurations}{{6.4.2}{28}{Remembered plot configurations}{subsection.6.4.2}{}}
\newlabel{parameters-plots:id1}{{6.4.2}{28}{Remembered plot configurations}{subsection.6.4.2}{}}
\@writefile{toc}{\contentsline {subsection}{\numberline {6.4.3}Overlay data sets (multiple files in one panel)}{29}{subsection.6.4.3}\protected@file@percent }
\newlabel{parameters-plots:overlay-data-sets-multiple-files-in-one-panel}{{6.4.3}{29}{Overlay data sets (multiple files in one panel)}{subsection.6.4.3}{}}
\@writefile{toc}{\contentsline {subsection}{\numberline {6.4.4}Editing trace styles}{29}{subsection.6.4.4}\protected@file@percent }
\newlabel{parameters-plots:editing-trace-styles}{{6.4.4}{29}{Editing trace styles}{subsection.6.4.4}{}}
\@writefile{toc}{\contentsline {subsection}{\numberline {6.4.5}Template and series presets}{30}{subsection.6.4.5}\protected@file@percent }
\newlabel{parameters-plots:template-and-series-presets}{{6.4.5}{30}{Template and series presets}{subsection.6.4.5}{}}
\@writefile{toc}{\contentsline {subsection}{\numberline {6.4.6}Keyboard shortcuts}{30}{subsection.6.4.6}\protected@file@percent }
\newlabel{parameters-plots:keyboard-shortcuts}{{6.4.6}{30}{Keyboard shortcuts}{subsection.6.4.6}{}}
\@writefile{toc}{\contentsline {chapter}{\numberline {7}Constraints}{31}{chapter.7}\protected@file@percent }
\@writefile{lof}{\addvspace {10\p@ }}
\@writefile{lot}{\addvspace {10\p@ }}
\newlabel{constraints:constraints}{{7}{27}{Constraints}{chapter.7}{}}
\newlabel{constraints::doc}{{7}{27}{Constraints}{chapter.7}{}}
\@writefile{toc}{\contentsline {section}{\numberline {7.1}Custom parameters}{27}{section.7.1}\protected@file@percent }
\newlabel{constraints:custom-parameters}{{7.1}{27}{Custom parameters}{section.7.1}{}}
\@writefile{toc}{\contentsline {section}{\numberline {7.2}Constraints}{27}{section.7.2}\protected@file@percent }
\newlabel{constraints:id1}{{7.2}{27}{Constraints}{section.7.2}{}}
\@writefile{toc}{\contentsline {section}{\numberline {7.3}Example: couple the magnetic field to the Larmor frequency}{28}{section.7.3}\protected@file@percent }
\newlabel{constraints:example-couple-the-magnetic-field-to-the-larmor-frequency}{{7.3}{28}{Example: couple the magnetic field to the Larmor frequency}{section.7.3}{}}
\@writefile{toc}{\contentsline {section}{\numberline {7.4}Preview}{28}{section.7.4}\protected@file@percent }
\newlabel{constraints:preview}{{7.4}{28}{Preview}{section.7.4}{}}
\@writefile{toc}{\contentsline {chapter}{\numberline {8}t0 / background}{29}{chapter.8}\protected@file@percent }
\newlabel{constraints:constraints}{{7}{31}{Constraints}{chapter.7}{}}
\newlabel{constraints::doc}{{7}{31}{Constraints}{chapter.7}{}}
\@writefile{toc}{\contentsline {section}{\numberline {7.1}Custom parameters}{31}{section.7.1}\protected@file@percent }
\newlabel{constraints:custom-parameters}{{7.1}{31}{Custom parameters}{section.7.1}{}}
\@writefile{toc}{\contentsline {section}{\numberline {7.2}Constraints}{31}{section.7.2}\protected@file@percent }
\newlabel{constraints:id1}{{7.2}{31}{Constraints}{section.7.2}{}}
\@writefile{toc}{\contentsline {section}{\numberline {7.3}Example: couple the magnetic field to the Larmor frequency}{32}{section.7.3}\protected@file@percent }
\newlabel{constraints:example-couple-the-magnetic-field-to-the-larmor-frequency}{{7.3}{32}{Example: couple the magnetic field to the Larmor frequency}{section.7.3}{}}
\@writefile{toc}{\contentsline {section}{\numberline {7.4}Preview}{32}{section.7.4}\protected@file@percent }
\newlabel{constraints:preview}{{7.4}{32}{Preview}{section.7.4}{}}
\@writefile{toc}{\contentsline {chapter}{\numberline {8}t0 / background}{33}{chapter.8}\protected@file@percent }
\@writefile{lof}{\addvspace {10\p@ }}
\@writefile{lot}{\addvspace {10\p@ }}
\newlabel{t0-background:t0-background}{{8}{29}{t0 / background}{chapter.8}{}}
\newlabel{t0-background::doc}{{8}{29}{t0 / background}{chapter.8}{}}
\@writefile{toc}{\contentsline {section}{\numberline {8.1}Multi\sphinxhyphen {}group asymmetry fits}{29}{section.8.1}\protected@file@percent }
\newlabel{t0-background:multi-group-asymmetry-fits}{{8.1}{29}{Multi\sphinxhyphen {}group asymmetry fits}{section.8.1}{}}
\@writefile{toc}{\contentsline {chapter}{\numberline {9}MSR editor}{31}{chapter.9}\protected@file@percent }
\newlabel{t0-background:t0-background}{{8}{33}{t0 / background}{chapter.8}{}}
\newlabel{t0-background::doc}{{8}{33}{t0 / background}{chapter.8}{}}
\@writefile{toc}{\contentsline {section}{\numberline {8.1}Multi\sphinxhyphen {}group asymmetry fits}{33}{section.8.1}\protected@file@percent }
\newlabel{t0-background:multi-group-asymmetry-fits}{{8.1}{33}{Multi\sphinxhyphen {}group asymmetry fits}{section.8.1}{}}
\@writefile{toc}{\contentsline {chapter}{\numberline {9}MSR editor}{35}{chapter.9}\protected@file@percent }
\@writefile{lof}{\addvspace {10\p@ }}
\@writefile{lot}{\addvspace {10\p@ }}
\newlabel{msr-editor:msr-editor}{{9}{31}{MSR editor}{chapter.9}{}}
\newlabel{msr-editor::doc}{{9}{31}{MSR editor}{chapter.9}{}}
\@writefile{toc}{\contentsline {section}{\numberline {9.1}Ownership: GUI or editor}{31}{section.9.1}\protected@file@percent }
\newlabel{msr-editor:ownership-gui-or-editor}{{9.1}{31}{Ownership: GUI or editor}{section.9.1}{}}
\@writefile{toc}{\contentsline {section}{\numberline {9.2}Workflow}{31}{section.9.2}\protected@file@percent }
\newlabel{msr-editor:workflow}{{9.2}{31}{Workflow}{section.9.2}{}}
\@writefile{toc}{\contentsline {section}{\numberline {9.3}File handling}{32}{section.9.3}\protected@file@percent }
\newlabel{msr-editor:file-handling}{{9.3}{32}{File handling}{section.9.3}{}}
\@writefile{toc}{\contentsline {chapter}{\numberline {10}Results and diagnostics}{33}{chapter.10}\protected@file@percent }
\newlabel{msr-editor:msr-editor}{{9}{35}{MSR editor}{chapter.9}{}}
\newlabel{msr-editor::doc}{{9}{35}{MSR editor}{chapter.9}{}}
\@writefile{lof}{\contentsline {figure}{\numberline {1}{\ignorespaces \xpg@aux {}{english}\ignorespaces A document generated with \sphinxstylestrong {GUI \sphinxhyphen {}> MSR}, before any fit. Syntax colours separate keywords and comments. The open padlock shows that the GUI still owns this document; editing it by hand changes that state.}}{35}{figure.9.1}\protected@file@percent }
\newlabel{msr-editor:id1}{{1}{35}{\texorpdfstring {\xpg@aux {\xpg@current@opts }{\languagename }}{}\ignorespaces A document generated with \sphinxstylestrong {GUI \sphinxhyphen {}> MSR}, before any fit. Syntax colours separate keywords and comments. The open padlock shows that the GUI still owns this document; editing it by hand changes that state}{figure.9.1}{}}
\@writefile{toc}{\contentsline {section}{\numberline {9.1}Ownership: GUI or editor}{36}{section.9.1}\protected@file@percent }
\newlabel{msr-editor:ownership-gui-or-editor}{{9.1}{36}{Ownership: GUI or editor}{section.9.1}{}}
\@writefile{toc}{\contentsline {section}{\numberline {9.2}Workflow}{36}{section.9.2}\protected@file@percent }
\newlabel{msr-editor:workflow}{{9.2}{36}{Workflow}{section.9.2}{}}
\@writefile{toc}{\contentsline {section}{\numberline {9.3}File handling}{36}{section.9.3}\protected@file@percent }
\newlabel{msr-editor:file-handling}{{9.3}{36}{File handling}{section.9.3}{}}
\@writefile{toc}{\contentsline {chapter}{\numberline {10}Results and diagnostics}{37}{chapter.10}\protected@file@percent }
\@writefile{lof}{\addvspace {10\p@ }}
\@writefile{lot}{\addvspace {10\p@ }}
\newlabel{results-diagnostics:results-and-diagnostics}{{10}{33}{Results and diagnostics}{chapter.10}{}}
\newlabel{results-diagnostics::doc}{{10}{33}{Results and diagnostics}{chapter.10}{}}
\@writefile{toc}{\contentsline {section}{\numberline {10.1}Result files}{33}{section.10.1}\protected@file@percent }
\newlabel{results-diagnostics:result-files}{{10.1}{33}{Result files}{section.10.1}{}}
\@writefile{toc}{\contentsline {section}{\numberline {10.2}Execution details}{33}{section.10.2}\protected@file@percent }
\newlabel{results-diagnostics:execution-details}{{10.2}{33}{Execution details}{section.10.2}{}}
\@writefile{toc}{\contentsline {section}{\numberline {10.3}Command log}{34}{section.10.3}\protected@file@percent }
\newlabel{results-diagnostics:command-log}{{10.3}{34}{Command log}{section.10.3}{}}
\@writefile{toc}{\contentsline {section}{\numberline {10.4}The status bar}{34}{section.10.4}\protected@file@percent }
\newlabel{results-diagnostics:the-status-bar}{{10.4}{34}{The status bar}{section.10.4}{}}
\@writefile{toc}{\contentsline {section}{\numberline {10.5}Run log window}{34}{section.10.5}\protected@file@percent }
\newlabel{results-diagnostics:run-log-window}{{10.5}{34}{Run log window}{section.10.5}{}}
\@writefile{toc}{\contentsline {section}{\numberline {10.6}Outcome dialog}{34}{section.10.6}\protected@file@percent }
\newlabel{results-diagnostics:outcome-dialog}{{10.6}{34}{Outcome dialog}{section.10.6}{}}
\@writefile{toc}{\contentsline {chapter}{\numberline {11}Configuration sharing}{35}{chapter.11}\protected@file@percent }
\newlabel{results-diagnostics:results-and-diagnostics}{{10}{37}{Results and diagnostics}{chapter.10}{}}
\newlabel{results-diagnostics::doc}{{10}{37}{Results and diagnostics}{chapter.10}{}}
\@writefile{toc}{\contentsline {section}{\numberline {10.1}Result files}{37}{section.10.1}\protected@file@percent }
\newlabel{results-diagnostics:result-files}{{10.1}{37}{Result files}{section.10.1}{}}
\@writefile{toc}{\contentsline {section}{\numberline {10.2}Execution details}{37}{section.10.2}\protected@file@percent }
\newlabel{results-diagnostics:execution-details}{{10.2}{37}{Execution details}{section.10.2}{}}
\@writefile{toc}{\contentsline {section}{\numberline {10.3}Command log}{38}{section.10.3}\protected@file@percent }
\newlabel{results-diagnostics:command-log}{{10.3}{38}{Command log}{section.10.3}{}}
\@writefile{toc}{\contentsline {section}{\numberline {10.4}The status bar}{38}{section.10.4}\protected@file@percent }
\newlabel{results-diagnostics:the-status-bar}{{10.4}{38}{The status bar}{section.10.4}{}}
\@writefile{toc}{\contentsline {section}{\numberline {10.5}Run log window}{38}{section.10.5}\protected@file@percent }
\newlabel{results-diagnostics:run-log-window}{{10.5}{38}{Run log window}{section.10.5}{}}
\@writefile{toc}{\contentsline {section}{\numberline {10.6}Outcome dialog}{38}{section.10.6}\protected@file@percent }
\newlabel{results-diagnostics:outcome-dialog}{{10.6}{38}{Outcome dialog}{section.10.6}{}}
\@writefile{toc}{\contentsline {chapter}{\numberline {11}Configuration sharing}{39}{chapter.11}\protected@file@percent }
\@writefile{lof}{\addvspace {10\p@ }}
\@writefile{lot}{\addvspace {10\p@ }}
\newlabel{configuration-sharing:configuration-sharing}{{11}{35}{Configuration sharing}{chapter.11}{}}
\newlabel{configuration-sharing::doc}{{11}{35}{Configuration sharing}{chapter.11}{}}
\@writefile{toc}{\contentsline {section}{\numberline {11.1}What is shared}{35}{section.11.1}\protected@file@percent }
\newlabel{configuration-sharing:what-is-shared}{{11.1}{35}{What is shared}{section.11.1}{}}
\@writefile{toc}{\contentsline {section}{\numberline {11.2}On the web}{35}{section.11.2}\protected@file@percent }
\newlabel{configuration-sharing:on-the-web}{{11.2}{35}{On the web}{section.11.2}{}}
\@writefile{toc}{\contentsline {section}{\numberline {11.3}On the desktop}{36}{section.11.3}\protected@file@percent }
\newlabel{configuration-sharing:on-the-desktop}{{11.3}{36}{On the desktop}{section.11.3}{}}
\@writefile{toc}{\contentsline {section}{\numberline {11.4}Notes}{36}{section.11.4}\protected@file@percent }
\newlabel{configuration-sharing:notes}{{11.4}{36}{Notes}{section.11.4}{}}
\@writefile{toc}{\contentsline {chapter}{\numberline {12}Preferences}{37}{chapter.12}\protected@file@percent }
\newlabel{configuration-sharing:configuration-sharing}{{11}{39}{Configuration sharing}{chapter.11}{}}
\newlabel{configuration-sharing::doc}{{11}{39}{Configuration sharing}{chapter.11}{}}
\@writefile{toc}{\contentsline {section}{\numberline {11.1}What is shared}{39}{section.11.1}\protected@file@percent }
\newlabel{configuration-sharing:what-is-shared}{{11.1}{39}{What is shared}{section.11.1}{}}
\@writefile{toc}{\contentsline {section}{\numberline {11.2}On the web}{39}{section.11.2}\protected@file@percent }
\newlabel{configuration-sharing:on-the-web}{{11.2}{39}{On the web}{section.11.2}{}}
\@writefile{toc}{\contentsline {section}{\numberline {11.3}On the desktop}{40}{section.11.3}\protected@file@percent }
\newlabel{configuration-sharing:on-the-desktop}{{11.3}{40}{On the desktop}{section.11.3}{}}
\@writefile{toc}{\contentsline {section}{\numberline {11.4}Notes}{40}{section.11.4}\protected@file@percent }
\newlabel{configuration-sharing:notes}{{11.4}{40}{Notes}{section.11.4}{}}
\@writefile{toc}{\contentsline {chapter}{\numberline {12}Preferences}{41}{chapter.12}\protected@file@percent }
\@writefile{lof}{\addvspace {10\p@ }}
\@writefile{lot}{\addvspace {10\p@ }}
\newlabel{preferences:preferences}{{12}{37}{Preferences}{chapter.12}{}}
\newlabel{preferences::doc}{{12}{37}{Preferences}{chapter.12}{}}
\@writefile{toc}{\contentsline {chapter}{\numberline {13}Web and desktop editions}{39}{chapter.13}\protected@file@percent }
\newlabel{preferences:preferences}{{12}{41}{Preferences}{chapter.12}{}}
\newlabel{preferences::doc}{{12}{41}{Preferences}{chapter.12}{}}
\@writefile{toc}{\contentsline {chapter}{\numberline {13}Web and desktop editions}{43}{chapter.13}\protected@file@percent }
\@writefile{lof}{\addvspace {10\p@ }}
\@writefile{lot}{\addvspace {10\p@ }}
\newlabel{platforms:web-and-desktop-editions}{{13}{39}{Web and desktop editions}{chapter.13}{}}
\newlabel{platforms::doc}{{13}{39}{Web and desktop editions}{chapter.13}{}}
\@writefile{toc}{\contentsline {section}{\numberline {13.1}Bundled ROOT and musrfit}{39}{section.13.1}\protected@file@percent }
\newlabel{platforms:bundled-root-and-musrfit}{{13.1}{39}{Bundled ROOT and musrfit}{section.13.1}{}}
\@writefile{toc}{\contentsline {section}{\numberline {13.2}Downloading missing runs}{40}{section.13.2}\protected@file@percent }
\newlabel{platforms:downloading-missing-runs}{{13.2}{40}{Downloading missing runs}{section.13.2}{}}
\@writefile{toc}{\contentsline {chapter}{\numberline {14}Keyboard shortcuts}{41}{chapter.14}\protected@file@percent }
\newlabel{platforms:web-and-desktop-editions}{{13}{43}{Web and desktop editions}{chapter.13}{}}
\newlabel{platforms::doc}{{13}{43}{Web and desktop editions}{chapter.13}{}}
\@writefile{lof}{\contentsline {figure}{\numberline {1}{\ignorespaces \xpg@aux {}{english}\ignorespaces Standard execution paths. Windows can also use explicitly configured native binaries instead of the bundled WSL runtime.}}{43}{figure.13.1}\protected@file@percent }
\newlabel{platforms:id1}{{1}{43}{\texorpdfstring {\xpg@aux {\xpg@current@opts }{\languagename }}{}\ignorespaces Standard execution paths. Windows can also use explicitly configured native binaries instead of the bundled WSL runtime}{figure.13.1}{}}
\@writefile{toc}{\contentsline {section}{\numberline {13.1}Bundled ROOT and musrfit}{44}{section.13.1}\protected@file@percent }
\newlabel{platforms:bundled-root-and-musrfit}{{13.1}{44}{Bundled ROOT and musrfit}{section.13.1}{}}
\@writefile{toc}{\contentsline {section}{\numberline {13.2}Downloading missing runs}{44}{section.13.2}\protected@file@percent }
\newlabel{platforms:downloading-missing-runs}{{13.2}{44}{Downloading missing runs}{section.13.2}{}}
\@writefile{toc}{\contentsline {chapter}{\numberline {14}Keyboard shortcuts}{47}{chapter.14}\protected@file@percent }
\@writefile{lof}{\addvspace {10\p@ }}
\@writefile{lot}{\addvspace {10\p@ }}
\newlabel{keyboard-shortcuts:keyboard-shortcuts}{{14}{41}{Keyboard shortcuts}{chapter.14}{}}
\newlabel{keyboard-shortcuts::doc}{{14}{41}{Keyboard shortcuts}{chapter.14}{}}
\@writefile{toc}{\contentsline {section}{\numberline {14.1}Parameter selection (Parameters tab)}{41}{section.14.1}\protected@file@percent }
\newlabel{keyboard-shortcuts:parameter-selection-parameters-tab}{{14.1}{41}{Parameter selection (Parameters tab)}{section.14.1}{}}
\@writefile{toc}{\contentsline {section}{\numberline {14.2}Parameter\sphinxhyphen {}plot window}{41}{section.14.2}\protected@file@percent }
\newlabel{keyboard-shortcuts:parameter-plot-window}{{14.2}{41}{Parameter\sphinxhyphen {}plot window}{section.14.2}{}}
\@writefile{toc}{\contentsline {section}{\numberline {14.3}MSR editor}{41}{section.14.3}\protected@file@percent }
\newlabel{keyboard-shortcuts:msr-editor}{{14.3}{41}{MSR editor}{section.14.3}{}}
\@writefile{toc}{\contentsline {section}{\numberline {14.4}General notes}{42}{section.14.4}\protected@file@percent }
\newlabel{keyboard-shortcuts:general-notes}{{14.4}{42}{General notes}{section.14.4}{}}
\@writefile{toc}{\contentsline {chapter}{\numberline {15}Troubleshooting}{43}{chapter.15}\protected@file@percent }
\newlabel{keyboard-shortcuts:keyboard-shortcuts}{{14}{47}{Keyboard shortcuts}{chapter.14}{}}
\newlabel{keyboard-shortcuts::doc}{{14}{47}{Keyboard shortcuts}{chapter.14}{}}
\@writefile{toc}{\contentsline {section}{\numberline {14.1}Parameter selection (Parameters tab)}{47}{section.14.1}\protected@file@percent }
\newlabel{keyboard-shortcuts:parameter-selection-parameters-tab}{{14.1}{47}{Parameter selection (Parameters tab)}{section.14.1}{}}
\@writefile{toc}{\contentsline {section}{\numberline {14.2}Parameter\sphinxhyphen {}plot window}{47}{section.14.2}\protected@file@percent }
\newlabel{keyboard-shortcuts:parameter-plot-window}{{14.2}{47}{Parameter\sphinxhyphen {}plot window}{section.14.2}{}}
\@writefile{toc}{\contentsline {section}{\numberline {14.3}MSR editor}{47}{section.14.3}\protected@file@percent }
\newlabel{keyboard-shortcuts:msr-editor}{{14.3}{47}{MSR editor}{section.14.3}{}}
\@writefile{toc}{\contentsline {section}{\numberline {14.4}General notes}{48}{section.14.4}\protected@file@percent }
\newlabel{keyboard-shortcuts:general-notes}{{14.4}{48}{General notes}{section.14.4}{}}
\@writefile{toc}{\contentsline {chapter}{\numberline {15}Troubleshooting}{49}{chapter.15}\protected@file@percent }
\@writefile{lof}{\addvspace {10\p@ }}
\@writefile{lot}{\addvspace {10\p@ }}
\newlabel{troubleshooting:troubleshooting}{{15}{43}{Troubleshooting}{chapter.15}{}}
\newlabel{troubleshooting::doc}{{15}{43}{Troubleshooting}{chapter.15}{}}
\@writefile{toc}{\contentsline {section}{\numberline {15.1}Fit or plot will not start}{43}{section.15.1}\protected@file@percent }
\newlabel{troubleshooting:fit-or-plot-will-not-start}{{15.1}{43}{Fit or plot will not start}{section.15.1}{}}
\@writefile{toc}{\contentsline {section}{\numberline {15.2}“Nothing to fit”}{43}{section.15.2}\protected@file@percent }
\newlabel{troubleshooting:nothing-to-fit}{{15.2}{43}{“Nothing to fit”}{section.15.2}{}}
\@writefile{toc}{\contentsline {section}{\numberline {15.3}Fitted parameters look wrong or unchanged}{43}{section.15.3}\protected@file@percent }
\newlabel{troubleshooting:fitted-parameters-look-wrong-or-unchanged}{{15.3}{43}{Fitted parameters look wrong or unchanged}{section.15.3}{}}
\@writefile{toc}{\contentsline {section}{\numberline {15.4}Parameter plot is empty or missing data}{44}{section.15.4}\protected@file@percent }
\newlabel{troubleshooting:parameter-plot-is-empty-or-missing-data}{{15.4}{44}{Parameter plot is empty or missing data}{section.15.4}{}}
\@writefile{toc}{\contentsline {section}{\numberline {15.5}Parameter plot hangs on “Preparing plot files”}{44}{section.15.5}\protected@file@percent }
\newlabel{troubleshooting:parameter-plot-hangs-on-preparing-plot-files}{{15.5}{44}{Parameter plot hangs on “Preparing plot files”}{section.15.5}{}}
\@writefile{toc}{\contentsline {section}{\numberline {15.6}Web page cannot load data}{44}{section.15.6}\protected@file@percent }
\newlabel{troubleshooting:web-page-cannot-load-data}{{15.6}{44}{Web page cannot load data}{section.15.6}{}}
\@writefile{toc}{\contentsline {section}{\numberline {15.7}Restored configuration differs from the original machine}{44}{section.15.7}\protected@file@percent }
\newlabel{troubleshooting:restored-configuration-differs-from-the-original-machine}{{15.7}{44}{Restored configuration differs from the original machine}{section.15.7}{}}
\@writefile{toc}{\contentsline {section}{\numberline {15.8}Some links start with a different prefix}{44}{section.15.8}\protected@file@percent }
\newlabel{troubleshooting:some-links-start-with-a-different-prefix}{{15.8}{44}{Some links start with a different prefix}{section.15.8}{}}
\@writefile{toc}{\contentsline {section}{\numberline {15.9}Reporting problems}{45}{section.15.9}\protected@file@percent }
\newlabel{troubleshooting:reporting-problems}{{15.9}{45}{Reporting problems}{section.15.9}{}}
\@writefile{toc}{\contentsline {chapter}{\numberline {16}Glossary}{47}{chapter.16}\protected@file@percent }
\newlabel{troubleshooting:troubleshooting}{{15}{49}{Troubleshooting}{chapter.15}{}}
\newlabel{troubleshooting::doc}{{15}{49}{Troubleshooting}{chapter.15}{}}
\@writefile{toc}{\contentsline {section}{\numberline {15.1}Fit or plot will not start}{49}{section.15.1}\protected@file@percent }
\newlabel{troubleshooting:fit-or-plot-will-not-start}{{15.1}{49}{Fit or plot will not start}{section.15.1}{}}
\@writefile{toc}{\contentsline {section}{\numberline {15.2}“Nothing to fit”}{49}{section.15.2}\protected@file@percent }
\newlabel{troubleshooting:nothing-to-fit}{{15.2}{49}{“Nothing to fit”}{section.15.2}{}}
\@writefile{toc}{\contentsline {section}{\numberline {15.3}Fitted parameters look wrong or unchanged}{49}{section.15.3}\protected@file@percent }
\newlabel{troubleshooting:fitted-parameters-look-wrong-or-unchanged}{{15.3}{49}{Fitted parameters look wrong or unchanged}{section.15.3}{}}
\@writefile{toc}{\contentsline {section}{\numberline {15.4}Parameter plot is empty or missing data}{50}{section.15.4}\protected@file@percent }
\newlabel{troubleshooting:parameter-plot-is-empty-or-missing-data}{{15.4}{50}{Parameter plot is empty or missing data}{section.15.4}{}}
\@writefile{toc}{\contentsline {section}{\numberline {15.5}Parameter plot hangs on “Preparing plot files”}{50}{section.15.5}\protected@file@percent }
\newlabel{troubleshooting:parameter-plot-hangs-on-preparing-plot-files}{{15.5}{50}{Parameter plot hangs on “Preparing plot files”}{section.15.5}{}}
\@writefile{toc}{\contentsline {section}{\numberline {15.6}Web page cannot load data}{50}{section.15.6}\protected@file@percent }
\newlabel{troubleshooting:web-page-cannot-load-data}{{15.6}{50}{Web page cannot load data}{section.15.6}{}}
\@writefile{toc}{\contentsline {section}{\numberline {15.7}Restored configuration differs from the original machine}{50}{section.15.7}\protected@file@percent }
\newlabel{troubleshooting:restored-configuration-differs-from-the-original-machine}{{15.7}{50}{Restored configuration differs from the original machine}{section.15.7}{}}
\@writefile{toc}{\contentsline {section}{\numberline {15.8}Some links start with a different prefix}{50}{section.15.8}\protected@file@percent }
\newlabel{troubleshooting:some-links-start-with-a-different-prefix}{{15.8}{50}{Some links start with a different prefix}{section.15.8}{}}
\@writefile{toc}{\contentsline {section}{\numberline {15.9}Reporting problems}{51}{section.15.9}\protected@file@percent }
\newlabel{troubleshooting:reporting-problems}{{15.9}{51}{Reporting problems}{section.15.9}{}}
\@writefile{toc}{\contentsline {chapter}{\numberline {16}Glossary}{53}{chapter.16}\protected@file@percent }
\@writefile{lof}{\addvspace {10\p@ }}
\@writefile{lot}{\addvspace {10\p@ }}
\newlabel{glossary:glossary}{{16}{47}{Glossary}{chapter.16}{}}
\newlabel{glossary::doc}{{16}{47}{Glossary}{chapter.16}{}}
\newlabel{glossary:term-MSR}{{16}{47}{\kern \labelwidth \kern -\itemindent \kern -\leftmargin {\parbox [t]{\dimexpr \linewidth +\leftmargin \relax }{\raggedright \the \spx@lineitemlabel \strut MSR\index {MSR@\spxentry {MSR}|spxpagem}\phantomsection \label {\detokenize {glossary:term-MSR}}}}\kern -\labelsep }{section*.3}{}}
\newlabel{glossary:term-fit-document}{{16}{47}{\kern \labelwidth \kern -\itemindent \kern -\leftmargin {\parbox [t]{\dimexpr \linewidth +\leftmargin \relax }{\raggedright \the \spx@lineitemlabel \strut fit document\index {fit document@\spxentry {fit document}|spxpagem}\phantomsection \label {\detokenize {glossary:term-fit-document}}}}\kern -\labelsep }{section*.4}{}}
\newlabel{glossary:term-RUN}{{16}{47}{\kern \labelwidth \kern -\itemindent \kern -\leftmargin {\parbox [t]{\dimexpr \linewidth +\leftmargin \relax }{\raggedright \the \spx@lineitemlabel \strut RUN\index {RUN@\spxentry {RUN}|spxpagem}\phantomsection \label {\detokenize {glossary:term-RUN}}}}\kern -\labelsep }{section*.5}{}}
\newlabel{glossary:term-ADDRUN}{{16}{47}{\kern \labelwidth \kern -\itemindent \kern -\leftmargin {\parbox [t]{\dimexpr \linewidth +\leftmargin \relax }{\raggedright \the \spx@lineitemlabel \strut ADDRUN\index {ADDRUN@\spxentry {ADDRUN}|spxpagem}\phantomsection \label {\detokenize {glossary:term-ADDRUN}}}}\kern -\labelsep }{section*.6}{}}
\newlabel{glossary:term-independent-series-fit}{{16}{47}{\kern \labelwidth \kern -\itemindent \kern -\leftmargin {\parbox [t]{\dimexpr \linewidth +\leftmargin \relax }{\raggedright \the \spx@lineitemlabel \strut independent\sphinxhyphen {}series fit\index {independent\sphinxhyphen {}series fit@\spxentry {independent\sphinxhyphen {}series fit}|spxpagem}\phantomsection \label {\detokenize {glossary:term-independent-series-fit}}}}\kern -\labelsep }{section*.7}{}}
\newlabel{glossary:term-global-parameter}{{16}{47}{\kern \labelwidth \kern -\itemindent \kern -\leftmargin {\parbox [t]{\dimexpr \linewidth +\leftmargin \relax }{\raggedright \the \spx@lineitemlabel \strut global parameter\index {global parameter@\spxentry {global parameter}|spxpagem}\phantomsection \label {\detokenize {glossary:term-global-parameter}}}}\kern -\labelsep }{section*.8}{}}
\newlabel{glossary:term-par.dat}{{16}{47}{\kern \labelwidth \kern -\itemindent \kern -\leftmargin {\parbox [t]{\dimexpr \linewidth +\leftmargin \relax }{\raggedright \the \spx@lineitemlabel \strut par.dat\index {par.dat@\spxentry {par.dat}|spxpagem}\phantomsection \label {\detokenize {glossary:term-par.dat}}}}\kern -\labelsep }{section*.9}{}}
\newlabel{glossary:term-musrfit}{{16}{47}{\kern \labelwidth \kern -\itemindent \kern -\leftmargin {\parbox [t]{\dimexpr \linewidth +\leftmargin \relax }{\raggedright \the \spx@lineitemlabel \strut musrfit\index {musrfit@\spxentry {musrfit}|spxpagem}\phantomsection \label {\detokenize {glossary:term-musrfit}}}}\kern -\labelsep }{section*.10}{}}
\newlabel{glossary:term-musrview}{{16}{48}{\kern \labelwidth \kern -\itemindent \kern -\leftmargin {\parbox [t]{\dimexpr \linewidth +\leftmargin \relax }{\raggedright \the \spx@lineitemlabel \strut musrview\index {musrview@\spxentry {musrview}|spxpagem}\phantomsection \label {\detokenize {glossary:term-musrview}}}}\kern -\labelsep }{section*.11}{}}
\newlabel{glossary:term-msr2data}{{16}{48}{\kern \labelwidth \kern -\itemindent \kern -\leftmargin {\parbox [t]{\dimexpr \linewidth +\leftmargin \relax }{\raggedright \the \spx@lineitemlabel \strut msr2data\index {msr2data@\spxentry {msr2data}|spxpagem}\phantomsection \label {\detokenize {glossary:term-msr2data}}}}\kern -\labelsep }{section*.12}{}}
\newlabel{glossary:term-dump_header}{{16}{48}{\kern \labelwidth \kern -\itemindent \kern -\leftmargin {\parbox [t]{\dimexpr \linewidth +\leftmargin \relax }{\raggedright \the \spx@lineitemlabel \strut dump\_header\index {dump\_header@\spxentry {dump\_header}|spxpagem}\phantomsection \label {\detokenize {glossary:term-dump_header}}}}\kern -\labelsep }{section*.13}{}}
\newlabel{glossary:term-ROOT-plot}{{16}{48}{\kern \labelwidth \kern -\itemindent \kern -\leftmargin {\parbox [t]{\dimexpr \linewidth +\leftmargin \relax }{\raggedright \the \spx@lineitemlabel \strut ROOT plot\index {ROOT plot@\spxentry {ROOT plot}|spxpagem}\phantomsection \label {\detokenize {glossary:term-ROOT-plot}}}}\kern -\labelsep }{section*.14}{}}
\newlabel{glossary:term-RRF}{{16}{48}{\kern \labelwidth \kern -\itemindent \kern -\leftmargin {\parbox [t]{\dimexpr \linewidth +\leftmargin \relax }{\raggedright \the \spx@lineitemlabel \strut RRF\index {RRF@\spxentry {RRF}|spxpagem}\phantomsection \label {\detokenize {glossary:term-RRF}}}}\kern -\labelsep }{section*.15}{}}
\newlabel{glossary:term-FFT}{{16}{48}{\kern \labelwidth \kern -\itemindent \kern -\leftmargin {\parbox [t]{\dimexpr \linewidth +\leftmargin \relax }{\raggedright \the \spx@lineitemlabel \strut FFT\index {FFT@\spxentry {FFT}|spxpagem}\phantomsection \label {\detokenize {glossary:term-FFT}}}}\kern -\labelsep }{section*.16}{}}
\newlabel{glossary:term-configuration-link}{{16}{48}{\kern \labelwidth \kern -\itemindent \kern -\leftmargin {\parbox [t]{\dimexpr \linewidth +\leftmargin \relax }{\raggedright \the \spx@lineitemlabel \strut configuration link\index {configuration link@\spxentry {configuration link}|spxpagem}\phantomsection \label {\detokenize {glossary:term-configuration-link}}}}\kern -\labelsep }{section*.17}{}}
\@writefile{toc}{\contentsline {chapter}{Index}{49}{section*.18}\protected@file@percent }
\gdef \@abspage@last{55}
\newlabel{glossary:glossary}{{16}{53}{Glossary}{chapter.16}{}}
\newlabel{glossary::doc}{{16}{53}{Glossary}{chapter.16}{}}
\newlabel{glossary:term-MSR}{{16}{53}{\kern \labelwidth \kern -\itemindent \kern -\leftmargin {\parbox [t]{\dimexpr \linewidth +\leftmargin \relax }{\raggedright \the \spx@lineitemlabel \strut MSR\index {MSR@\spxentry {MSR}|spxpagem}\phantomsection \label {\detokenize {glossary:term-MSR}}}}\kern -\labelsep }{section*.3}{}}
\newlabel{glossary:term-fit-document}{{16}{53}{\kern \labelwidth \kern -\itemindent \kern -\leftmargin {\parbox [t]{\dimexpr \linewidth +\leftmargin \relax }{\raggedright \the \spx@lineitemlabel \strut fit document\index {fit document@\spxentry {fit document}|spxpagem}\phantomsection \label {\detokenize {glossary:term-fit-document}}}}\kern -\labelsep }{section*.4}{}}
\newlabel{glossary:term-RUN}{{16}{53}{\kern \labelwidth \kern -\itemindent \kern -\leftmargin {\parbox [t]{\dimexpr \linewidth +\leftmargin \relax }{\raggedright \the \spx@lineitemlabel \strut RUN\index {RUN@\spxentry {RUN}|spxpagem}\phantomsection \label {\detokenize {glossary:term-RUN}}}}\kern -\labelsep }{section*.5}{}}
\newlabel{glossary:term-ADDRUN}{{16}{53}{\kern \labelwidth \kern -\itemindent \kern -\leftmargin {\parbox [t]{\dimexpr \linewidth +\leftmargin \relax }{\raggedright \the \spx@lineitemlabel \strut ADDRUN\index {ADDRUN@\spxentry {ADDRUN}|spxpagem}\phantomsection \label {\detokenize {glossary:term-ADDRUN}}}}\kern -\labelsep }{section*.6}{}}
\newlabel{glossary:term-independent-series-fit}{{16}{53}{\kern \labelwidth \kern -\itemindent \kern -\leftmargin {\parbox [t]{\dimexpr \linewidth +\leftmargin \relax }{\raggedright \the \spx@lineitemlabel \strut independent\sphinxhyphen {}series fit\index {independent\sphinxhyphen {}series fit@\spxentry {independent\sphinxhyphen {}series fit}|spxpagem}\phantomsection \label {\detokenize {glossary:term-independent-series-fit}}}}\kern -\labelsep }{section*.7}{}}
\newlabel{glossary:term-global-parameter}{{16}{53}{\kern \labelwidth \kern -\itemindent \kern -\leftmargin {\parbox [t]{\dimexpr \linewidth +\leftmargin \relax }{\raggedright \the \spx@lineitemlabel \strut global parameter\index {global parameter@\spxentry {global parameter}|spxpagem}\phantomsection \label {\detokenize {glossary:term-global-parameter}}}}\kern -\labelsep }{section*.8}{}}
\newlabel{glossary:term-par.dat}{{16}{53}{\kern \labelwidth \kern -\itemindent \kern -\leftmargin {\parbox [t]{\dimexpr \linewidth +\leftmargin \relax }{\raggedright \the \spx@lineitemlabel \strut par.dat\index {par.dat@\spxentry {par.dat}|spxpagem}\phantomsection \label {\detokenize {glossary:term-par.dat}}}}\kern -\labelsep }{section*.9}{}}
\newlabel{glossary:term-musrfit}{{16}{53}{\kern \labelwidth \kern -\itemindent \kern -\leftmargin {\parbox [t]{\dimexpr \linewidth +\leftmargin \relax }{\raggedright \the \spx@lineitemlabel \strut musrfit\index {musrfit@\spxentry {musrfit}|spxpagem}\phantomsection \label {\detokenize {glossary:term-musrfit}}}}\kern -\labelsep }{section*.10}{}}
\newlabel{glossary:term-musrview}{{16}{54}{\kern \labelwidth \kern -\itemindent \kern -\leftmargin {\parbox [t]{\dimexpr \linewidth +\leftmargin \relax }{\raggedright \the \spx@lineitemlabel \strut musrview\index {musrview@\spxentry {musrview}|spxpagem}\phantomsection \label {\detokenize {glossary:term-musrview}}}}\kern -\labelsep }{section*.11}{}}
\newlabel{glossary:term-msr2data}{{16}{54}{\kern \labelwidth \kern -\itemindent \kern -\leftmargin {\parbox [t]{\dimexpr \linewidth +\leftmargin \relax }{\raggedright \the \spx@lineitemlabel \strut msr2data\index {msr2data@\spxentry {msr2data}|spxpagem}\phantomsection \label {\detokenize {glossary:term-msr2data}}}}\kern -\labelsep }{section*.12}{}}
\newlabel{glossary:term-dump_header}{{16}{54}{\kern \labelwidth \kern -\itemindent \kern -\leftmargin {\parbox [t]{\dimexpr \linewidth +\leftmargin \relax }{\raggedright \the \spx@lineitemlabel \strut dump\_header\index {dump\_header@\spxentry {dump\_header}|spxpagem}\phantomsection \label {\detokenize {glossary:term-dump_header}}}}\kern -\labelsep }{section*.13}{}}
\newlabel{glossary:term-ROOT-plot}{{16}{54}{\kern \labelwidth \kern -\itemindent \kern -\leftmargin {\parbox [t]{\dimexpr \linewidth +\leftmargin \relax }{\raggedright \the \spx@lineitemlabel \strut ROOT plot\index {ROOT plot@\spxentry {ROOT plot}|spxpagem}\phantomsection \label {\detokenize {glossary:term-ROOT-plot}}}}\kern -\labelsep }{section*.14}{}}
\newlabel{glossary:term-RRF}{{16}{54}{\kern \labelwidth \kern -\itemindent \kern -\leftmargin {\parbox [t]{\dimexpr \linewidth +\leftmargin \relax }{\raggedright \the \spx@lineitemlabel \strut RRF\index {RRF@\spxentry {RRF}|spxpagem}\phantomsection \label {\detokenize {glossary:term-RRF}}}}\kern -\labelsep }{section*.15}{}}
\newlabel{glossary:term-FFT}{{16}{54}{\kern \labelwidth \kern -\itemindent \kern -\leftmargin {\parbox [t]{\dimexpr \linewidth +\leftmargin \relax }{\raggedright \the \spx@lineitemlabel \strut FFT\index {FFT@\spxentry {FFT}|spxpagem}\phantomsection \label {\detokenize {glossary:term-FFT}}}}\kern -\labelsep }{section*.16}{}}
\newlabel{glossary:term-configuration-link}{{16}{54}{\kern \labelwidth \kern -\itemindent \kern -\leftmargin {\parbox [t]{\dimexpr \linewidth +\leftmargin \relax }{\raggedright \the \spx@lineitemlabel \strut configuration link\index {configuration link@\spxentry {configuration link}|spxpagem}\phantomsection \label {\detokenize {glossary:term-configuration-link}}}}\kern -\labelsep }{section*.17}{}}
\@writefile{toc}{\contentsline {chapter}{Index}{55}{section*.18}\protected@file@percent }
\gdef \@abspage@last{61}
+15 -10
View File
@@ -1,11 +1,11 @@
# Fdb version 4
["makeindex muSRFlow.idx"] 1793204525.53118 "muSRFlow.idx" "muSRFlow.ind" "muSRFlow" 1793204528.17168 0
"muSRFlow.idx" 1793204528.0544 1189 836524d7a2d297107884b9a35219f43e "pdflatex"
["makeindex muSRFlow.idx"] 1793373806.66487 "muSRFlow.idx" "muSRFlow.ind" "muSRFlow" 1793373809.76829 0
"muSRFlow.idx" 1793373809.635 1189 965d5982d4e130c95f4404a1de41b15e "pdflatex"
(generated)
"muSRFlow.ilg"
"muSRFlow.ind"
(rewritten before read)
["pdflatex"] 1793204525.61009 "muSRFlow.tex" "muSRFlow.pdf" "muSRFlow" 1793204528.17182 0
["pdflatex"] 1793373806.7517 "muSRFlow.tex" "muSRFlow.pdf" "muSRFlow" 1793373809.76842 0
"/usr/share/texmf-dist/fonts/map/fontname/texfonts.map" 1577235249 3524 cb3e574dea2d1052e39280babc910dc8 ""
"/usr/share/texmf-dist/fonts/tfm/adobe/zapfding/pzdr.tfm" 1136768653 1528 f853c4d1b4e0550255e02831fdc8496f ""
"/usr/share/texmf-dist/fonts/tfm/public/amsfonts/cmextra/cmex7.tfm" 1246382020 1004 54797486969f23fa377b128694d548df ""
@@ -119,13 +119,18 @@
"/usr/share/texmf-dist/tex/latex/xcolor/xcolor.sty" 1727642399 55384 b454dec21c2d9f45ec0b793f0995b992 ""
"/usr/share/texmf-dist/web2c/texmf.cnf" 1772498184 43617 0f84662189cad3132fecd51f17dd9276 ""
"/var/lib/texmf/web2c/xetex/xelatex.fmt" 1783332064 6760887 1c6d1ad838ac2a3dddf7a0433c780710 ""
"muSRFlow.aux" 1793204528.0499 30661 e8355b4411cd5dd9dc00c8d9e84ed2d5 "pdflatex"
"muSRFlow.ind" 1793204525.60391 1435 b46c81d1bc39d1decbc92aff2d2ef2d3 "makeindex muSRFlow.idx"
"muSRFlow.out" 1793204528.0519 16289 b4b00072c876b1c734e859e1f5ea2f7b "pdflatex"
"muSRFlow.tex" 1793204522.72436 107011 58a5848a5f2b2629f51cef46478e9882 ""
"muSRFlow.toc" 1793204528.0544 8401 91ecd1e094d1d5be9afc33f0b30b0309 "pdflatex"
"execution-locations.png" 1793373790.74531 179209 ed7de629c14eb354beb0d5ebff8a1e7a ""
"fit-workflow.png" 1793373790.64532 249993 611e00e8c6a0561b562d4100bc3d5943 ""
"msr-editor-tab.png" 1793373790.51724 115679 1aaeecfa8ada59828a4fdc1e4439bdac ""
"muSRFlow.aux" 1793373809.6312 34262 3d7cfac48ef751a299d43dc2d826b844 "pdflatex"
"muSRFlow.ind" 1793373806.74689 1435 0a2a639d60eb0ba3962e6e7e32e80505 "makeindex muSRFlow.idx"
"muSRFlow.out" 1793373809.63443 16289 b4b00072c876b1c734e859e1f5ea2f7b "pdflatex"
"muSRFlow.tex" 1793373803.48871 109347 db0e18a9dab5ad0b15fe06ea47aacefa ""
"muSRFlow.toc" 1793373809.635 8408 03136dee1843e8bdee1d931861644869 "pdflatex"
"parameters-tab.png" 1793373790.51488 80179 bfadb14db6cd38ded601d77a46ddd55a ""
"runs-tab.png" 1793373790.51282 97146 43ea233dc005a69cf2274d067ec6be2f ""
"sphinx.sty" 1789374174.58095 54203 ee7fe875437470f5328ee20661bb9f1d ""
"sphinxhighlight.sty" 1793204522.50945 7553 83fb52292c17957d9f4aadcb28c57a87 ""
"sphinxhighlight.sty" 1793373803.34429 7553 83fb52292c17957d9f4aadcb28c57a87 ""
"sphinxlatexadmonitions.sty" 1789374174.58095 19111 5e67a0f91439018bceb7cadf319345e6 ""
"sphinxlatexcontainers.sty" 1789374174.58295 900 d61f923db071a7b54d3cee8a1e6935d3 ""
"sphinxlatexgraphics.sty" 1789374174.58295 4918 c9266041d02bc615d54b890e96e3acd3 ""
@@ -140,7 +145,7 @@
"sphinxlatexstyletext.sty" 1789374174.58495 6759 9e932c65374cfb62686485d331bc975c ""
"sphinxlatextables.sty" 1789374174.58495 57643 7f1013c2fa11942370d867527bdda568 ""
"sphinxmanual.cls" 1789374174.58495 4241 7b0d7a37df7b5715fb0dbd585c52ecdb ""
"sphinxmessages.sty" 1793204522.72886 745 3f5fcd6cdd7964ed608767954a8ced6f ""
"sphinxmessages.sty" 1793373803.49424 745 3f5fcd6cdd7964ed608767954a8ced6f ""
"sphinxoptionsgeometry.sty" 1789374174.58695 2060 6c27b3eba37bde592ae8908ab2c1ac0f ""
"sphinxoptionshyperref.sty" 1789374174.58695 1093 e468489bae7631a7f387b4b0f7bc15d4 ""
"sphinxpackageboxes.sty" 1789374174.58695 36106 1be2053eb1cb9b083b3a75e3657bcb24 ""
+30
View File
@@ -290,9 +290,39 @@ INPUT /usr/share/texmf-dist/fonts/tfm/public/amsfonts/symbols/msbm7.tfm
INPUT /usr/share/texmf-dist/fonts/tfm/public/cm/cmr8.tfm
INPUT /usr/share/texmf-dist/fonts/tfm/public/cm/cmr6.tfm
OUTPUT muSRFlow.toc
INPUT ./fit-workflow.png
INPUT ./fit-workflow.png
INPUT ./fit-workflow.png
INPUT ./fit-workflow.png
INPUT ./fit-workflow.png
INPUT ./fit-workflow.png
INPUT ./runs-tab.png
INPUT ./runs-tab.png
INPUT ./runs-tab.png
INPUT ./runs-tab.png
INPUT ./runs-tab.png
INPUT ./runs-tab.png
INPUT /usr/share/texmf-dist/fonts/tfm/public/amsfonts/cmextra/cmex7.tfm
INPUT /usr/share/texmf-dist/fonts/tfm/public/amsfonts/symbols/msam5.tfm
INPUT /usr/share/texmf-dist/fonts/tfm/public/amsfonts/symbols/msbm5.tfm
INPUT ./parameters-tab.png
INPUT ./parameters-tab.png
INPUT ./parameters-tab.png
INPUT ./parameters-tab.png
INPUT ./parameters-tab.png
INPUT ./parameters-tab.png
INPUT ./msr-editor-tab.png
INPUT ./msr-editor-tab.png
INPUT ./msr-editor-tab.png
INPUT ./msr-editor-tab.png
INPUT ./msr-editor-tab.png
INPUT ./msr-editor-tab.png
INPUT ./execution-locations.png
INPUT ./execution-locations.png
INPUT ./execution-locations.png
INPUT ./execution-locations.png
INPUT ./execution-locations.png
INPUT ./execution-locations.png
INPUT ./muSRFlow.ind
INPUT ./muSRFlow.ind
INPUT muSRFlow.ind
+15 -15
View File
@@ -1,15 +1,15 @@
\indexentry{MSR@\spxentry{MSR}|hyperxindexformat{\spxpagem}}{47}
\indexentry{fit document@\spxentry{fit document}|hyperxindexformat{\spxpagem}}{47}
\indexentry{RUN@\spxentry{RUN}|hyperxindexformat{\spxpagem}}{47}
\indexentry{ADDRUN@\spxentry{ADDRUN}|hyperxindexformat{\spxpagem}}{47}
\indexentry{independent\sphinxhyphen {}series fit@\spxentry{independent\sphinxhyphen {}series fit}|hyperxindexformat{\spxpagem}}{47}
\indexentry{global parameter@\spxentry{global parameter}|hyperxindexformat{\spxpagem}}{47}
\indexentry{par.dat@\spxentry{par.dat}|hyperxindexformat{\spxpagem}}{47}
\indexentry{musrfit@\spxentry{musrfit}|hyperxindexformat{\spxpagem}}{47}
\indexentry{musrview@\spxentry{musrview}|hyperxindexformat{\spxpagem}}{48}
\indexentry{msr2data@\spxentry{msr2data}|hyperxindexformat{\spxpagem}}{48}
\indexentry{dump\_header@\spxentry{dump\_header}|hyperxindexformat{\spxpagem}}{48}
\indexentry{ROOT plot@\spxentry{ROOT plot}|hyperxindexformat{\spxpagem}}{48}
\indexentry{RRF@\spxentry{RRF}|hyperxindexformat{\spxpagem}}{48}
\indexentry{FFT@\spxentry{FFT}|hyperxindexformat{\spxpagem}}{48}
\indexentry{configuration link@\spxentry{configuration link}|hyperxindexformat{\spxpagem}}{48}
\indexentry{MSR@\spxentry{MSR}|hyperxindexformat{\spxpagem}}{53}
\indexentry{fit document@\spxentry{fit document}|hyperxindexformat{\spxpagem}}{53}
\indexentry{RUN@\spxentry{RUN}|hyperxindexformat{\spxpagem}}{53}
\indexentry{ADDRUN@\spxentry{ADDRUN}|hyperxindexformat{\spxpagem}}{53}
\indexentry{independent\sphinxhyphen {}series fit@\spxentry{independent\sphinxhyphen {}series fit}|hyperxindexformat{\spxpagem}}{53}
\indexentry{global parameter@\spxentry{global parameter}|hyperxindexformat{\spxpagem}}{53}
\indexentry{par.dat@\spxentry{par.dat}|hyperxindexformat{\spxpagem}}{53}
\indexentry{musrfit@\spxentry{musrfit}|hyperxindexformat{\spxpagem}}{53}
\indexentry{musrview@\spxentry{musrview}|hyperxindexformat{\spxpagem}}{54}
\indexentry{msr2data@\spxentry{msr2data}|hyperxindexformat{\spxpagem}}{54}
\indexentry{dump\_header@\spxentry{dump\_header}|hyperxindexformat{\spxpagem}}{54}
\indexentry{ROOT plot@\spxentry{ROOT plot}|hyperxindexformat{\spxpagem}}{54}
\indexentry{RRF@\spxentry{RRF}|hyperxindexformat{\spxpagem}}{54}
\indexentry{FFT@\spxentry{FFT}|hyperxindexformat{\spxpagem}}{54}
\indexentry{configuration link@\spxentry{configuration link}|hyperxindexformat{\spxpagem}}{54}
+15 -15
View File
@@ -5,44 +5,44 @@
\let\spxextra \sphinxstyleindexextra
\bigletter A
\item \spxentry{ADDRUN}, \hyperxindexformat{\spxpagem}{47}
\item \spxentry{ADDRUN}, \hyperxindexformat{\spxpagem}{53}
\indexspace
\bigletter C
\item \spxentry{configuration link}, \hyperxindexformat{\spxpagem}{48}
\item \spxentry{configuration link}, \hyperxindexformat{\spxpagem}{54}
\indexspace
\bigletter D
\item \spxentry{dump\_header}, \hyperxindexformat{\spxpagem}{48}
\item \spxentry{dump\_header}, \hyperxindexformat{\spxpagem}{54}
\indexspace
\bigletter F
\item \spxentry{FFT}, \hyperxindexformat{\spxpagem}{48}
\item \spxentry{fit document}, \hyperxindexformat{\spxpagem}{47}
\item \spxentry{FFT}, \hyperxindexformat{\spxpagem}{54}
\item \spxentry{fit document}, \hyperxindexformat{\spxpagem}{53}
\indexspace
\bigletter G
\item \spxentry{global parameter}, \hyperxindexformat{\spxpagem}{47}
\item \spxentry{global parameter}, \hyperxindexformat{\spxpagem}{53}
\indexspace
\bigletter I
\item \spxentry{independent\sphinxhyphen {}series fit}, \hyperxindexformat{\spxpagem}{47}
\item \spxentry{independent\sphinxhyphen {}series fit}, \hyperxindexformat{\spxpagem}{53}
\indexspace
\bigletter M
\item \spxentry{MSR}, \hyperxindexformat{\spxpagem}{47}
\item \spxentry{msr2data}, \hyperxindexformat{\spxpagem}{48}
\item \spxentry{musrfit}, \hyperxindexformat{\spxpagem}{47}
\item \spxentry{musrview}, \hyperxindexformat{\spxpagem}{48}
\item \spxentry{MSR}, \hyperxindexformat{\spxpagem}{53}
\item \spxentry{msr2data}, \hyperxindexformat{\spxpagem}{54}
\item \spxentry{musrfit}, \hyperxindexformat{\spxpagem}{53}
\item \spxentry{musrview}, \hyperxindexformat{\spxpagem}{54}
\indexspace
\bigletter P
\item \spxentry{par.dat}, \hyperxindexformat{\spxpagem}{47}
\item \spxentry{par.dat}, \hyperxindexformat{\spxpagem}{53}
\indexspace
\bigletter R
\item \spxentry{ROOT plot}, \hyperxindexformat{\spxpagem}{48}
\item \spxentry{RRF}, \hyperxindexformat{\spxpagem}{48}
\item \spxentry{RUN}, \hyperxindexformat{\spxpagem}{47}
\item \spxentry{ROOT plot}, \hyperxindexformat{\spxpagem}{54}
\item \spxentry{RRF}, \hyperxindexformat{\spxpagem}{54}
\item \spxentry{RUN}, \hyperxindexformat{\spxpagem}{53}
\end{sphinxtheindex}
BIN
View File
Binary file not shown.
+68 -18
View File
@@ -71,8 +71,8 @@
\title{muSRFlow User Manual}
\date{Oct 28, 2026}
\release{1.0.0\sphinxhyphen{}rc.5}
\date{Oct 30, 2026}
\release{1.0.0\sphinxhyphen{}rc.6}
\author{Zaher Salman}
\newcommand{\sphinxlogo}{\vbox{}}
\renewcommand{\releasename}{Release}
@@ -113,6 +113,14 @@ muSRFlow provides a modern interface over the classic µSR analysis tools. A
typical session selects the data, chooses a fit model, fits it, inspects the
result, and finally inspects how the fitted parameters vary run by run.
\begin{figure}[htbp]
\centering
\capstart
\noindent\sphinxincludegraphics[width=1.000\linewidth]{{fit-workflow}.png}
\caption{The basic fit workflow. See {\hyperref[\detokenize{runs-fitting::doc}]{\sphinxcrossref{\DUrole{doc}{Runs and fitting}}}} for independent series
and shared\sphinxhyphen{}parameter fits, and {\hyperref[\detokenize{msr-editor::doc}]{\sphinxcrossref{\DUrole{doc}{MSR editor}}}} for document ownership.}\label{\detokenize{overview:id1}}\end{figure}
\section{What you get}
\label{\detokenize{overview:what-you-get}}\begin{itemize}
@@ -324,6 +332,15 @@ spectrum. Press \sphinxstylestrong{Fit} to fit it and refresh the parameter tabl
files go to the selected work directory; the \sphinxstylestrong{Results} tab and run log
show the outcome.
\begin{figure}[htbp]
\centering
\capstart
\noindent\sphinxincludegraphics[width=1.000\linewidth]{{runs-tab}.png}
\caption{The browser edition before fitting. Run 514 (LEM, 2025) is an example
selection, not a validated fit configuration. Choose your runs and model
here; the Fit and Plot buttons remain available across tabs.}\label{\detokenize{getting-started:id2}}\end{figure}
\section{Opening the web edition}
\label{\detokenize{getting-started:opening-the-web-edition}}
@@ -381,17 +398,24 @@ Administrator access is needed to enable the Windows virtualization features.
\item {}
\sphinxAtStartPar
Obtain the Windows installer, named \sphinxcode{\sphinxupquote{muSRFlow\sphinxhyphen{}<version>\sphinxhyphen{}x64.exe}}. The
current release candidate is \sphinxcode{\sphinxupquote{1.0.0\sphinxhyphen{}rc.5}}.
Obtain the Windows installer, named \sphinxcode{\sphinxupquote{muSRFlow\sphinxhyphen{}<version>\sphinxhyphen{}x64.exe}}, from
the project’s \sphinxhref{https://gitea.psi.ch/salman/muSRFlow/releases}{Releases}
or the \sphinxstylestrong{musrflow\sphinxhyphen{}windows} package in
\sphinxhref{https://gitea.psi.ch/salman/muSRFlow/packages}{Packages}. Verify its
SHA\sphinxhyphen{}256 checksum against the accompanying \sphinxcode{\sphinxupquote{.sha256}} file.
\item {}
\sphinxAtStartPar
For a test build that has not been published yet, download the
\sphinxstylestrong{musrflow\sphinxhyphen{}windows\sphinxhyphen{}x64} artifact from a successful \sphinxstylestrong{Build Windows
installer} workflow run and extract the installer.
\end{itemize}
\sphinxAtStartPar
\sphinxstylestrong{Use the refreshed Windows build.} Earlier rc.5 installers have the same
filename but lack the WSL fixes. Obtain a build containing commit \sphinxcode{\sphinxupquote{a6981c4}}
or later. In the development workspace, the verified replacement is
\sphinxcode{\sphinxupquote{dist/windows\sphinxhyphen{}runtime\sphinxhyphen{}fix/muSRFlow\sphinxhyphen{}1.0.0\sphinxhyphen{}rc.5\sphinxhyphen{}x64.exe}}; this is a local build
output, not a public download address.
\sphinxstylestrong{Avoid old rc.5 installers.} Early builds lack the WSL fixes. The current
runner\sphinxhyphen{}built installer includes them and has passed Windows installation,
runtime setup, data download, Fit/Plot, and multi\sphinxhyphen{}run smoke tests.
\sphinxAtStartPar
See \sphinxhref{https://learn.microsoft.com/en-us/windows/wsl/tutorials/gui-apps}{Microsoft’s WSL GUI requirements} for the
@@ -616,7 +640,7 @@ runtime through Preferences. Node.js and npm are not needed on the target PC.
\sphinxAtStartPar
The current application packages are for x86\_64 Linux. Examples below use
\sphinxcode{\sphinxupquote{1.0.0\sphinxhyphen{}rc.5}}; substitute the version of the package you obtained. Run the
\sphinxcode{\sphinxupquote{1.0.0\sphinxhyphen{}rc.6}}; substitute the version of the package you obtained. Run the
commands from the folder containing the downloaded files.
@@ -632,7 +656,7 @@ Choose one application format.
On an RPM\sphinxhyphen{}based distribution with dnf:
\begin{sphinxVerbatim}[commandchars=\\\{\}]
sudo\PYG{+w}{ }dnf\PYG{+w}{ }install\PYG{+w}{ }./musrflow\PYGZhy{}1.0.0\PYGZhy{}rc.5\PYGZhy{}x86\PYGZus{}64.rpm
sudo\PYG{+w}{ }dnf\PYG{+w}{ }install\PYG{+w}{ }./musrflow\PYGZhy{}1.0.0\PYGZhy{}rc.6\PYGZhy{}x86\PYGZus{}64.rpm
musrflow
\end{sphinxVerbatim}
@@ -644,8 +668,8 @@ RPM filename starts with lowercase \sphinxcode{\sphinxupquote{musrflow}}.
\subsection{AppImage}
\label{\detokenize{install-linux:appimage}}
\begin{sphinxVerbatim}[commandchars=\\\{\}]
chmod\PYG{+w}{ }+x\PYG{+w}{ }muSRFlow\PYGZhy{}1.0.0\PYGZhy{}rc.5\PYGZhy{}x86\PYGZus{}64.AppImage
./muSRFlow\PYGZhy{}1.0.0\PYGZhy{}rc.5\PYGZhy{}x86\PYGZus{}64.AppImage
chmod\PYG{+w}{ }+x\PYG{+w}{ }muSRFlow\PYGZhy{}1.0.0\PYGZhy{}rc.6\PYGZhy{}x86\PYGZus{}64.AppImage
./muSRFlow\PYGZhy{}1.0.0\PYGZhy{}rc.6\PYGZhy{}x86\PYGZus{}64.AppImage
\end{sphinxVerbatim}
\sphinxAtStartPar
@@ -701,7 +725,7 @@ A compatible Linux system and desktop/display services are still required.
\subsection{Alternative: system runtime RPM}
\label{\detokenize{install-linux:alternative-system-runtime-rpm}}
\begin{sphinxVerbatim}[commandchars=\\\{\}]
sudo\PYG{+w}{ }dnf\PYG{+w}{ }install\PYG{+w}{ }./musrflow\PYGZhy{}runtime\PYGZhy{}1.0.0\PYGZhy{}rc.5\PYGZhy{}x86\PYGZus{}64.rpm
sudo\PYG{+w}{ }dnf\PYG{+w}{ }install\PYG{+w}{ }./musrflow\PYGZhy{}runtime\PYGZhy{}1.0.0\PYGZhy{}rc.6\PYGZhy{}x86\PYGZus{}64.rpm
\end{sphinxVerbatim}
\sphinxAtStartPar
@@ -715,8 +739,8 @@ recognizes automatically when no explicit tool directory takes precedence.
For a user\sphinxhyphen{}writable runtime location:
\begin{sphinxVerbatim}[commandchars=\\\{\}]
chmod\PYG{+w}{ }+x\PYG{+w}{ }musrflow\PYGZhy{}runtime\PYGZhy{}1.0.0\PYGZhy{}rc.5\PYGZhy{}x86\PYGZus{}64.AppImage
./musrflow\PYGZhy{}runtime\PYGZhy{}1.0.0\PYGZhy{}rc.5\PYGZhy{}x86\PYGZus{}64.AppImage\PYG{+w}{ }\PYGZhy{}\PYGZhy{}install\PYG{+w}{ }\PYG{l+s+s2}{\PYGZdq{}}\PYG{n+nv}{\PYGZdl{}HOME}\PYG{l+s+s2}{/.local/share/musrflow/runtime}\PYG{l+s+s2}{\PYGZdq{}}
chmod\PYG{+w}{ }+x\PYG{+w}{ }musrflow\PYGZhy{}runtime\PYGZhy{}1.0.0\PYGZhy{}rc.6\PYGZhy{}x86\PYGZus{}64.AppImage
./musrflow\PYGZhy{}runtime\PYGZhy{}1.0.0\PYGZhy{}rc.6\PYGZhy{}x86\PYGZus{}64.AppImage\PYG{+w}{ }\PYGZhy{}\PYGZhy{}install\PYG{+w}{ }\PYG{l+s+s2}{\PYGZdq{}}\PYG{n+nv}{\PYGZdl{}HOME}\PYG{l+s+s2}{/.local/share/musrflow/runtime}\PYG{l+s+s2}{\PYGZdq{}}
\end{sphinxVerbatim}
\sphinxAtStartPar
@@ -817,7 +841,7 @@ sequence, for example \sphinxcode{\sphinxupquote{520:540:2}}.
\sphinxAtStartPar
Each comma\sphinxhyphen{} or range\sphinxhyphen{}separated data set is fit independently and merged
into one fit document, so \sphinxcode{\sphinxupquote{514, 516, 520\sphinxhyphen{}525}} prepares six data sets.
into one fit document, so \sphinxcode{\sphinxupquote{514, 516, 520\sphinxhyphen{}525}} prepares eight data sets.
\sphinxAtStartPar
A \sphinxcode{\sphinxupquote{+}} between runs adds the run to the previous data set via the MSR
@@ -833,7 +857,7 @@ Examples:
\item {}
\sphinxAtStartPar
\sphinxcode{\sphinxupquote{514, 520\sphinxhyphen{}525}} – two data sets: 514 and each of 520..525.
\sphinxcode{\sphinxupquote{514, 520\sphinxhyphen{}525}} – seven data sets: 514 and each of 520..525.
\item {}
\sphinxAtStartPar
@@ -1205,6 +1229,15 @@ parameter, per data set, with starting values, steps, and limits. Fitting
feeds the measured values back, and the same table drives the interactive
parameter plots.
\begin{figure}[htbp]
\centering
\capstart
\noindent\sphinxincludegraphics[width=1.000\linewidth]{{parameters-tab}.png}
\caption{Example parameter table before fitting, for the same run and model as
{\hyperref[\detokenize{getting-started::doc}]{\sphinxcrossref{\DUrole{doc}{Getting started}}}}. These are initial values, not measured results;
the Error column contains starting steps at this stage.}\label{\detokenize{parameters-plots:id2}}\end{figure}
\section{The parameter table}
\label{\detokenize{parameters-plots:the-parameter-table}}
@@ -1746,6 +1779,15 @@ The \sphinxstylestrong{MSR Editor} tab displays the complete MSR file that muSRF
It is a real editor, not just a preview: you can edit the text by hand, and
the edited document becomes the source of truth for the next Fit or Plot.
\begin{figure}[htbp]
\centering
\capstart
\noindent\sphinxincludegraphics[width=1.000\linewidth]{{msr-editor-tab}.png}
\caption{A document generated with \sphinxstylestrong{GUI \sphinxhyphen{}> MSR}, before any fit. Syntax colours
separate keywords and comments. The open padlock shows that the GUI still
owns this document; editing it by hand changes that state.}\label{\detokenize{msr-editor:id1}}\end{figure}
\section{Ownership: GUI or editor}
\label{\detokenize{msr-editor:ownership-gui-or-editor}}
@@ -2141,6 +2183,14 @@ Both editions share the tabs, fit engine, model library, parameter plots, and
configuration\sphinxhyphen{}sharing protocol. The differences come from where the data and
the command\sphinxhyphen{}line tools live.
\begin{figure}[htbp]
\centering
\capstart
\noindent\sphinxincludegraphics[width=1.000\linewidth]{{execution-locations}.png}
\caption{Standard execution paths. Windows can also use explicitly configured
native binaries instead of the bundled WSL runtime.}\label{\detokenize{platforms:id1}}\end{figure}
\begin{savenotes}\sphinxattablestart
\sphinxthistablewithglobalstyle
+98 -98
View File
@@ -1,101 +1,101 @@
\xpg@aux {}{english}
\contentsline {chapter}{\numberline {1}Overview}{3}{chapter.1}%
\contentsline {section}{\numberline {1.1}What you get}{3}{section.1.1}%
\contentsline {section}{\numberline {1.2}Under the hood}{4}{section.1.2}%
\contentsline {section}{\numberline {1.3}Two editions}{4}{section.1.3}%
\contentsline {section}{\numberline {1.4}A first fit}{4}{section.1.4}%
\contentsline {chapter}{\numberline {2}Getting started}{5}{chapter.2}%
\contentsline {section}{\numberline {2.1}Choose your edition}{5}{section.2.1}%
\contentsline {section}{\numberline {2.2}Desktop installation}{5}{section.2.2}%
\contentsline {section}{\numberline {2.3}Windows installation}{5}{section.2.3}%
\contentsline {section}{\numberline {2.4}Running the desktop app}{6}{section.2.4}%
\contentsline {section}{\numberline {2.5}Opening the web edition}{6}{section.2.5}%
\contentsline {section}{\numberline {2.6}The Quick Start guide}{6}{section.2.6}%
\contentsline {section}{\numberline {2.7}Support}{6}{section.2.7}%
\contentsline {chapter}{\numberline {3}Windows installation}{7}{chapter.3}%
\contentsline {section}{\numberline {3.1}Before you start}{7}{section.3.1}%
\contentsline {section}{\numberline {3.2}Install step by step}{8}{section.3.2}%
\contentsline {section}{\numberline {3.3}Existing installations}{9}{section.3.3}%
\contentsline {section}{\numberline {3.4}Troubleshooting}{9}{section.3.4}%
\contentsline {subsection}{\numberline {3.4.1}Required feature is not installed}{9}{subsection.3.4.1}%
\contentsline {subsection}{\numberline {3.4.2}Cannot find wsl.exe}{9}{subsection.3.4.2}%
\contentsline {subsection}{\numberline {3.4.3}Cannot load libCore.so}{10}{subsection.3.4.3}%
\contentsline {subsection}{\numberline {3.4.4}Missing boost/version.hpp or plotting crash}{10}{subsection.3.4.4}%
\contentsline {subsection}{\numberline {3.4.5}No spectrum window appears}{10}{subsection.3.4.5}%
\contentsline {subsection}{\numberline {3.4.6}Reporting a problem}{10}{subsection.3.4.6}%
\contentsline {chapter}{\numberline {4}Linux installation}{11}{chapter.4}%
\contentsline {section}{\numberline {4.1}Install the application}{11}{section.4.1}%
\contentsline {subsection}{\numberline {4.1.1}RPM}{11}{subsection.4.1.1}%
\contentsline {subsection}{\numberline {4.1.2}AppImage}{11}{subsection.4.1.2}%
\contentsline {section}{\numberline {4.2}Set up ROOT and musrfit}{12}{section.4.2}%
\contentsline {subsection}{\numberline {4.2.1}Use an existing installation}{12}{subsection.4.2.1}%
\contentsline {subsection}{\numberline {4.2.2}Install the separate runtime from a local bundle}{12}{subsection.4.2.2}%
\contentsline {subsection}{\numberline {4.2.3}Alternative: system runtime RPM}{12}{subsection.4.2.3}%
\contentsline {subsection}{\numberline {4.2.4}Alternative: runtime AppImage}{12}{subsection.4.2.4}%
\contentsline {section}{\numberline {4.3}Choose folders and test}{13}{section.4.3}%
\contentsline {section}{\numberline {4.4}Updating and troubleshooting}{13}{section.4.4}%
\contentsline {chapter}{\numberline {5}Runs and fitting}{15}{chapter.5}%
\contentsline {section}{\numberline {5.1}Run selection}{15}{section.5.1}%
\contentsline {section}{\numberline {5.2}Fit range}{16}{section.5.2}%
\contentsline {section}{\numberline {5.3}Fit model}{16}{section.5.3}%
\contentsline {section}{\numberline {5.4}Fit options}{17}{section.5.4}%
\contentsline {section}{\numberline {5.5}Series fit actions}{17}{section.5.5}%
\contentsline {subsection}{\numberline {5.5.1}Per\sphinxhyphen {}run statistics}{17}{subsection.5.5.1}%
\contentsline {section}{\numberline {5.6}View settings}{18}{section.5.6}%
\contentsline {section}{\numberline {5.7}Fit and Plot}{18}{section.5.7}%
\contentsline {chapter}{\numberline {6}Parameters and parameter plots}{21}{chapter.6}%
\contentsline {section}{\numberline {6.1}The parameter table}{21}{section.6.1}%
\contentsline {subsection}{\numberline {6.1.1}The \sphinxstylestrong {Shared} column}{22}{subsection.6.1.1}%
\contentsline {section}{\numberline {6.2}Selecting parameters for plotting}{22}{section.6.2}%
\contentsline {section}{\numberline {6.3}The Choose X axis dialog}{22}{section.6.3}%
\contentsline {section}{\numberline {6.4}The parameter\sphinxhyphen {}plot window}{22}{section.6.4}%
\contentsline {subsection}{\numberline {6.4.1}Plot options}{23}{subsection.6.4.1}%
\contentsline {subsection}{\numberline {6.4.2}Remembered plot configurations}{23}{subsection.6.4.2}%
\contentsline {subsection}{\numberline {6.4.3}Overlay data sets (multiple files in one panel)}{24}{subsection.6.4.3}%
\contentsline {subsection}{\numberline {6.4.4}Editing trace styles}{25}{subsection.6.4.4}%
\contentsline {subsection}{\numberline {6.4.5}Template and series presets}{25}{subsection.6.4.5}%
\contentsline {subsection}{\numberline {6.4.6}Keyboard shortcuts}{25}{subsection.6.4.6}%
\contentsline {chapter}{\numberline {7}Constraints}{27}{chapter.7}%
\contentsline {section}{\numberline {7.1}Custom parameters}{27}{section.7.1}%
\contentsline {section}{\numberline {7.2}Constraints}{27}{section.7.2}%
\contentsline {section}{\numberline {7.3}Example: couple the magnetic field to the Larmor frequency}{28}{section.7.3}%
\contentsline {section}{\numberline {7.4}Preview}{28}{section.7.4}%
\contentsline {chapter}{\numberline {8}t0 / background}{29}{chapter.8}%
\contentsline {section}{\numberline {8.1}Multi\sphinxhyphen {}group asymmetry fits}{29}{section.8.1}%
\contentsline {chapter}{\numberline {9}MSR editor}{31}{chapter.9}%
\contentsline {section}{\numberline {9.1}Ownership: GUI or editor}{31}{section.9.1}%
\contentsline {section}{\numberline {9.2}Workflow}{31}{section.9.2}%
\contentsline {section}{\numberline {9.3}File handling}{32}{section.9.3}%
\contentsline {chapter}{\numberline {10}Results and diagnostics}{33}{chapter.10}%
\contentsline {section}{\numberline {10.1}Result files}{33}{section.10.1}%
\contentsline {section}{\numberline {10.2}Execution details}{33}{section.10.2}%
\contentsline {section}{\numberline {10.3}Command log}{34}{section.10.3}%
\contentsline {section}{\numberline {10.4}The status bar}{34}{section.10.4}%
\contentsline {section}{\numberline {10.5}Run log window}{34}{section.10.5}%
\contentsline {section}{\numberline {10.6}Outcome dialog}{34}{section.10.6}%
\contentsline {chapter}{\numberline {11}Configuration sharing}{35}{chapter.11}%
\contentsline {section}{\numberline {11.1}What is shared}{35}{section.11.1}%
\contentsline {section}{\numberline {11.2}On the web}{35}{section.11.2}%
\contentsline {section}{\numberline {11.3}On the desktop}{36}{section.11.3}%
\contentsline {section}{\numberline {11.4}Notes}{36}{section.11.4}%
\contentsline {chapter}{\numberline {12}Preferences}{37}{chapter.12}%
\contentsline {chapter}{\numberline {13}Web and desktop editions}{39}{chapter.13}%
\contentsline {section}{\numberline {13.1}Bundled ROOT and musrfit}{39}{section.13.1}%
\contentsline {section}{\numberline {13.2}Downloading missing runs}{40}{section.13.2}%
\contentsline {chapter}{\numberline {14}Keyboard shortcuts}{41}{chapter.14}%
\contentsline {section}{\numberline {14.1}Parameter selection (Parameters tab)}{41}{section.14.1}%
\contentsline {section}{\numberline {14.2}Parameter\sphinxhyphen {}plot window}{41}{section.14.2}%
\contentsline {section}{\numberline {14.3}MSR editor}{41}{section.14.3}%
\contentsline {section}{\numberline {14.4}General notes}{42}{section.14.4}%
\contentsline {chapter}{\numberline {15}Troubleshooting}{43}{chapter.15}%
\contentsline {section}{\numberline {15.1}Fit or plot will not start}{43}{section.15.1}%
\contentsline {section}{\numberline {15.2}“Nothing to fit”}{43}{section.15.2}%
\contentsline {section}{\numberline {15.3}Fitted parameters look wrong or unchanged}{43}{section.15.3}%
\contentsline {section}{\numberline {15.4}Parameter plot is empty or missing data}{44}{section.15.4}%
\contentsline {section}{\numberline {15.5}Parameter plot hangs on “Preparing plot files”}{44}{section.15.5}%
\contentsline {section}{\numberline {15.6}Web page cannot load data}{44}{section.15.6}%
\contentsline {section}{\numberline {15.7}Restored configuration differs from the original machine}{44}{section.15.7}%
\contentsline {section}{\numberline {15.8}Some links start with a different prefix}{44}{section.15.8}%
\contentsline {section}{\numberline {15.9}Reporting problems}{45}{section.15.9}%
\contentsline {chapter}{\numberline {16}Glossary}{47}{chapter.16}%
\contentsline {chapter}{Index}{49}{section*.18}%
\contentsline {section}{\numberline {1.2}Under the hood}{5}{section.1.2}%
\contentsline {section}{\numberline {1.3}Two editions}{5}{section.1.3}%
\contentsline {section}{\numberline {1.4}A first fit}{5}{section.1.4}%
\contentsline {chapter}{\numberline {2}Getting started}{7}{chapter.2}%
\contentsline {section}{\numberline {2.1}Choose your edition}{7}{section.2.1}%
\contentsline {section}{\numberline {2.2}Desktop installation}{7}{section.2.2}%
\contentsline {section}{\numberline {2.3}Windows installation}{7}{section.2.3}%
\contentsline {section}{\numberline {2.4}Running the desktop app}{8}{section.2.4}%
\contentsline {section}{\numberline {2.5}Opening the web edition}{8}{section.2.5}%
\contentsline {section}{\numberline {2.6}The Quick Start guide}{8}{section.2.6}%
\contentsline {section}{\numberline {2.7}Support}{9}{section.2.7}%
\contentsline {chapter}{\numberline {3}Windows installation}{11}{chapter.3}%
\contentsline {section}{\numberline {3.1}Before you start}{11}{section.3.1}%
\contentsline {section}{\numberline {3.2}Install step by step}{12}{section.3.2}%
\contentsline {section}{\numberline {3.3}Existing installations}{13}{section.3.3}%
\contentsline {section}{\numberline {3.4}Troubleshooting}{13}{section.3.4}%
\contentsline {subsection}{\numberline {3.4.1}Required feature is not installed}{13}{subsection.3.4.1}%
\contentsline {subsection}{\numberline {3.4.2}Cannot find wsl.exe}{13}{subsection.3.4.2}%
\contentsline {subsection}{\numberline {3.4.3}Cannot load libCore.so}{14}{subsection.3.4.3}%
\contentsline {subsection}{\numberline {3.4.4}Missing boost/version.hpp or plotting crash}{14}{subsection.3.4.4}%
\contentsline {subsection}{\numberline {3.4.5}No spectrum window appears}{14}{subsection.3.4.5}%
\contentsline {subsection}{\numberline {3.4.6}Reporting a problem}{14}{subsection.3.4.6}%
\contentsline {chapter}{\numberline {4}Linux installation}{15}{chapter.4}%
\contentsline {section}{\numberline {4.1}Install the application}{15}{section.4.1}%
\contentsline {subsection}{\numberline {4.1.1}RPM}{15}{subsection.4.1.1}%
\contentsline {subsection}{\numberline {4.1.2}AppImage}{15}{subsection.4.1.2}%
\contentsline {section}{\numberline {4.2}Set up ROOT and musrfit}{16}{section.4.2}%
\contentsline {subsection}{\numberline {4.2.1}Use an existing installation}{16}{subsection.4.2.1}%
\contentsline {subsection}{\numberline {4.2.2}Install the separate runtime from a local bundle}{16}{subsection.4.2.2}%
\contentsline {subsection}{\numberline {4.2.3}Alternative: system runtime RPM}{16}{subsection.4.2.3}%
\contentsline {subsection}{\numberline {4.2.4}Alternative: runtime AppImage}{16}{subsection.4.2.4}%
\contentsline {section}{\numberline {4.3}Choose folders and test}{17}{section.4.3}%
\contentsline {section}{\numberline {4.4}Updating and troubleshooting}{17}{section.4.4}%
\contentsline {chapter}{\numberline {5}Runs and fitting}{19}{chapter.5}%
\contentsline {section}{\numberline {5.1}Run selection}{19}{section.5.1}%
\contentsline {section}{\numberline {5.2}Fit range}{20}{section.5.2}%
\contentsline {section}{\numberline {5.3}Fit model}{20}{section.5.3}%
\contentsline {section}{\numberline {5.4}Fit options}{21}{section.5.4}%
\contentsline {section}{\numberline {5.5}Series fit actions}{21}{section.5.5}%
\contentsline {subsection}{\numberline {5.5.1}Per\sphinxhyphen {}run statistics}{21}{subsection.5.5.1}%
\contentsline {section}{\numberline {5.6}View settings}{22}{section.5.6}%
\contentsline {section}{\numberline {5.7}Fit and Plot}{22}{section.5.7}%
\contentsline {chapter}{\numberline {6}Parameters and parameter plots}{25}{chapter.6}%
\contentsline {section}{\numberline {6.1}The parameter table}{26}{section.6.1}%
\contentsline {subsection}{\numberline {6.1.1}The \sphinxstylestrong {Shared} column}{26}{subsection.6.1.1}%
\contentsline {section}{\numberline {6.2}Selecting parameters for plotting}{26}{section.6.2}%
\contentsline {section}{\numberline {6.3}The Choose X axis dialog}{27}{section.6.3}%
\contentsline {section}{\numberline {6.4}The parameter\sphinxhyphen {}plot window}{27}{section.6.4}%
\contentsline {subsection}{\numberline {6.4.1}Plot options}{28}{subsection.6.4.1}%
\contentsline {subsection}{\numberline {6.4.2}Remembered plot configurations}{28}{subsection.6.4.2}%
\contentsline {subsection}{\numberline {6.4.3}Overlay data sets (multiple files in one panel)}{29}{subsection.6.4.3}%
\contentsline {subsection}{\numberline {6.4.4}Editing trace styles}{29}{subsection.6.4.4}%
\contentsline {subsection}{\numberline {6.4.5}Template and series presets}{30}{subsection.6.4.5}%
\contentsline {subsection}{\numberline {6.4.6}Keyboard shortcuts}{30}{subsection.6.4.6}%
\contentsline {chapter}{\numberline {7}Constraints}{31}{chapter.7}%
\contentsline {section}{\numberline {7.1}Custom parameters}{31}{section.7.1}%
\contentsline {section}{\numberline {7.2}Constraints}{31}{section.7.2}%
\contentsline {section}{\numberline {7.3}Example: couple the magnetic field to the Larmor frequency}{32}{section.7.3}%
\contentsline {section}{\numberline {7.4}Preview}{32}{section.7.4}%
\contentsline {chapter}{\numberline {8}t0 / background}{33}{chapter.8}%
\contentsline {section}{\numberline {8.1}Multi\sphinxhyphen {}group asymmetry fits}{33}{section.8.1}%
\contentsline {chapter}{\numberline {9}MSR editor}{35}{chapter.9}%
\contentsline {section}{\numberline {9.1}Ownership: GUI or editor}{36}{section.9.1}%
\contentsline {section}{\numberline {9.2}Workflow}{36}{section.9.2}%
\contentsline {section}{\numberline {9.3}File handling}{36}{section.9.3}%
\contentsline {chapter}{\numberline {10}Results and diagnostics}{37}{chapter.10}%
\contentsline {section}{\numberline {10.1}Result files}{37}{section.10.1}%
\contentsline {section}{\numberline {10.2}Execution details}{37}{section.10.2}%
\contentsline {section}{\numberline {10.3}Command log}{38}{section.10.3}%
\contentsline {section}{\numberline {10.4}The status bar}{38}{section.10.4}%
\contentsline {section}{\numberline {10.5}Run log window}{38}{section.10.5}%
\contentsline {section}{\numberline {10.6}Outcome dialog}{38}{section.10.6}%
\contentsline {chapter}{\numberline {11}Configuration sharing}{39}{chapter.11}%
\contentsline {section}{\numberline {11.1}What is shared}{39}{section.11.1}%
\contentsline {section}{\numberline {11.2}On the web}{39}{section.11.2}%
\contentsline {section}{\numberline {11.3}On the desktop}{40}{section.11.3}%
\contentsline {section}{\numberline {11.4}Notes}{40}{section.11.4}%
\contentsline {chapter}{\numberline {12}Preferences}{41}{chapter.12}%
\contentsline {chapter}{\numberline {13}Web and desktop editions}{43}{chapter.13}%
\contentsline {section}{\numberline {13.1}Bundled ROOT and musrfit}{44}{section.13.1}%
\contentsline {section}{\numberline {13.2}Downloading missing runs}{44}{section.13.2}%
\contentsline {chapter}{\numberline {14}Keyboard shortcuts}{47}{chapter.14}%
\contentsline {section}{\numberline {14.1}Parameter selection (Parameters tab)}{47}{section.14.1}%
\contentsline {section}{\numberline {14.2}Parameter\sphinxhyphen {}plot window}{47}{section.14.2}%
\contentsline {section}{\numberline {14.3}MSR editor}{47}{section.14.3}%
\contentsline {section}{\numberline {14.4}General notes}{48}{section.14.4}%
\contentsline {chapter}{\numberline {15}Troubleshooting}{49}{chapter.15}%
\contentsline {section}{\numberline {15.1}Fit or plot will not start}{49}{section.15.1}%
\contentsline {section}{\numberline {15.2}“Nothing to fit”}{49}{section.15.2}%
\contentsline {section}{\numberline {15.3}Fitted parameters look wrong or unchanged}{49}{section.15.3}%
\contentsline {section}{\numberline {15.4}Parameter plot is empty or missing data}{50}{section.15.4}%
\contentsline {section}{\numberline {15.5}Parameter plot hangs on “Preparing plot files”}{50}{section.15.5}%
\contentsline {section}{\numberline {15.6}Web page cannot load data}{50}{section.15.6}%
\contentsline {section}{\numberline {15.7}Restored configuration differs from the original machine}{50}{section.15.7}%
\contentsline {section}{\numberline {15.8}Some links start with a different prefix}{50}{section.15.8}%
\contentsline {section}{\numberline {15.9}Reporting problems}{51}{section.15.9}%
\contentsline {chapter}{\numberline {16}Glossary}{53}{chapter.16}%
\contentsline {chapter}{Index}{55}{section*.18}%
Binary file not shown.

After

Width:  |  Height:  |  Size: 78 KiB

BIN
View File
Binary file not shown.

After

Width:  |  Height:  |  Size: 95 KiB

+8
View File
@@ -42,6 +42,14 @@ spectrum. Press **Fit** to fit it and refresh the parameter table. Generated
files go to the selected work directory; the **Results** tab and run log
show the outcome.
.. figure:: images/runs-tab.png
:alt: Runs tab showing LEM run 514 from 2025, fit range, exponential cosine model, and Fit and Plot buttons.
:width: 100%
The browser edition before fitting. Run 514 (LEM, 2025) is an example
selection, not a validated fit configuration. Choose your runs and model
here; the Fit and Plot buttons remain available across tabs.
Opening the web edition
-----------------------
+33
View File
@@ -0,0 +1,33 @@
Documentation illustrations
===========================
The PNG screenshots show the actual browser interface from muSRFlow 1.0.0-rc.6
(source commit 12ecbf4), captured locally with Chrome. They are not mockups.
Only the app panel is captured, excluding browser chrome and unused space.
No fit was performed and no run data was downloaded.
To refresh the screenshots:
1. Open the local web interface in a clean browser profile.
2. Use a 1960 x 700 CSS-pixel viewport (capture scale: 1.5).
3. Enter run 514, year 2025, instrument LEM. Keep the default exponential
cosine model and initial parameters; do not press Fit or Plot.
4. Capture the appShell panel in Runs and Parameters.
5. In MSR Editor, choose GUI -> MSR, then select MSR Editor again and capture
the panel with the generated, unfitted document visible.
6. Check the captions, especially the initial-value versus fitted-value wording.
fit-workflow.svg and execution-locations.svg are editable, hand-authored
workflow diagrams. The PNG copies support the PDF manual; HTML uses SVG.
After changing an SVG, refresh its PNG with librsvg:
rsvg-convert -w 1560 -o fit-workflow.png fit-workflow.svg
rsvg-convert -w 1560 -o execution-locations.png execution-locations.svg
Build checks (from the repository root):
make -C docs html SPHINXOPTS="-W --keep-going"
make -C docs latexpdf SPHINXOPTS="-W --keep-going"
Keep the diagrams illustrative: do not invent fitted curves or numerical
results. Add real spectrum screenshots only with a verified fit and enough
context to identify the data, model, and whether the plot is before or after fit.
Binary file not shown.

After

Width:  |  Height:  |  Size: 175 KiB

@@ -0,0 +1,40 @@
<svg xmlns="http://www.w3.org/2000/svg" width="780" height="510" viewBox="0 0 780 510" role="img" aria-labelledby="title desc">
<title id="title">Where muSRFlow runs the scientific tools</title>
<desc id="desc">Linux runs native tools locally. Windows runs the bundled tools in WSL2 and keeps work files on Windows. The web interface calls a CGI server and shows ROOT plots using JSROOT.</desc>
<defs>
<marker id="arrow" markerWidth="8" markerHeight="8" refX="7" refY="4" orient="auto"><path d="M0 0 L8 4 L0 8" fill="#347249"/></marker>
<style>
text { font-family: DejaVu Sans, sans-serif; fill: #193724; }
.title { font-size: 25px; font-weight: bold; }
.heading { font-size: 18px; font-weight: bold; }
.body { font-size: 15px; }
.label { font-size: 16px; font-weight: bold; fill: #347249; }
.card { fill: white; stroke: #b8cbbd; stroke-width: 1.5; }
.arrow { stroke: #347249; stroke-width: 2; marker-end: url(#arrow); }
</style>
</defs>
<rect width="780" height="510" rx="16" fill="#f6f8f2"/>
<text x="28" y="43" class="title">One interface, three execution paths</text>
<text x="28" y="72" class="body">The place where the tools run determines data access and plotting.</text>
<text x="28" y="111" class="label">LINUX DESKTOP</text>
<rect x="28" y="124" width="200" height="82" rx="10" class="card"/>
<text x="48" y="154" class="heading">muSRFlow</text><text x="48" y="180" class="body">Electron application</text>
<path d="M233 165 H265" class="arrow"/>
<rect x="276" y="124" width="476" height="82" rx="10" class="card"/>
<text x="296" y="154" class="heading">Local ROOT + musrfit</text>
<text x="296" y="180" class="body">Existing installation or separate optional runtime</text>
<text x="28" y="241" class="label">WINDOWS DESKTOP</text>
<rect x="28" y="254" width="200" height="82" rx="10" class="card"/>
<text x="48" y="284" class="heading">muSRFlow</text><text x="48" y="310" class="body">Electron application</text>
<path d="M233 295 H265" class="arrow"/>
<rect x="276" y="254" width="476" height="82" rx="10" class="card"/>
<text x="296" y="284" class="heading">Bundled runtime inside WSL2</text>
<text x="296" y="310" class="body">Windows work files; musrview window via WSLg</text>
<text x="28" y="371" class="label">WEB BROWSER</text>
<rect x="28" y="384" width="200" height="82" rx="10" class="card"/>
<text x="48" y="414" class="heading">muSRFlow</text><text x="48" y="440" class="body">Browser interface</text>
<path d="M233 425 H265" class="arrow"/>
<rect x="276" y="384" width="476" height="82" rx="10" class="card"/>
<text x="296" y="414" class="heading">CGI server + ROOT + musrfit</text>
<text x="296" y="440" class="body">Server data; ROOT plots displayed with JSROOT</text>
</svg>

After

Width:  |  Height:  |  Size: 2.7 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 244 KiB

+52
View File
@@ -0,0 +1,52 @@
<svg xmlns="http://www.w3.org/2000/svg" width="780" height="540" viewBox="0 0 780 540" role="img" aria-labelledby="title desc">
<title id="title">From run selection to fitted parameters</title>
<desc id="desc">Choose runs and a model, prepare an MSR document, run musrfit, then review fitted values and plots. Plot prepares a document but does not run the minimizer.</desc>
<defs>
<marker id="arrow" markerWidth="8" markerHeight="8" refX="7" refY="4" orient="auto"><path d="M0 0 L8 4 L0 8" fill="#347249"/></marker>
<style>
text { font-family: DejaVu Sans, sans-serif; fill: #193724; }
.title { font-size: 25px; font-weight: bold; }
.heading { font-size: 19px; font-weight: bold; }
.body { font-size: 16px; }
.note { font-size: 15px; fill: #44594a; }
.number { font-size: 18px; font-weight: bold; fill: white; }
.card { fill: white; stroke: #b8cbbd; stroke-width: 1.5; }
.arrow { fill: none; stroke: #347249; stroke-width: 2; marker-end: url(#arrow); }
</style>
</defs>
<rect width="780" height="540" rx="16" fill="#f6f8f2"/>
<text x="28" y="43" class="title">A fit, step by step</text>
<text x="28" y="69" class="note">A workflow diagram, not a fit result</text>
<rect x="28" y="92" width="350" height="76" rx="10" class="card"/>
<circle cx="55" cy="119" r="16" fill="#347249"/><text x="49" y="125" class="number">1</text>
<text x="82" y="121" class="heading">Choose the analysis</text>
<text x="82" y="148" class="body">Runs, model, range, parameters</text>
<path d="M203 169 V186" class="arrow"/>
<rect x="28" y="192" width="350" height="76" rx="10" class="card"/>
<circle cx="55" cy="219" r="16" fill="#347249"/><text x="49" y="225" class="number">2</text>
<text x="82" y="221" class="heading">Prepare the MSR</text>
<text x="82" y="248" class="body">Settings become a fit document</text>
<path d="M203 269 V286" class="arrow"/>
<rect x="28" y="292" width="350" height="76" rx="10" class="card"/>
<circle cx="55" cy="319" r="16" fill="#347249"/><text x="49" y="325" class="number">3</text>
<text x="82" y="321" class="heading">Fit with musrfit</text>
<text x="82" y="348" class="body">The fitted MSR holds the results</text>
<path d="M203 369 V386" class="arrow"/>
<rect x="28" y="392" width="350" height="76" rx="10" class="card"/>
<circle cx="55" cy="419" r="16" fill="#347249"/><text x="49" y="425" class="number">4</text>
<text x="82" y="421" class="heading">Review and refine</text>
<text x="82" y="448" class="body">Inspect values, spectra, and logs</text>
<rect x="408" y="92" width="344" height="176" rx="10" fill="#e7eee3"/>
<text x="430" y="122" class="heading">Who controls the document?</text>
<text x="430" y="152" class="body">GUI-owned: generate from settings.</text>
<text x="430" y="182" class="body">Editor-owned: use the edited MSR.</text>
<text x="430" y="219" class="note">An editor-owned document is not</text>
<text x="430" y="242" class="note">silently replaced by GUI settings.</text>
<rect x="408" y="292" width="344" height="174" rx="10" fill="#e7eee3"/>
<text x="430" y="322" class="heading">After fitting</text>
<text x="430" y="353" class="body">Fitted values update the table.</text>
<text x="430" y="382" class="body">musrview displays the spectra.</text>
<text x="430" y="411" class="body">msr2data collects parameters</text>
<text x="430" y="435" class="body">for parameter plots.</text>
<text x="28" y="508" class="body">Plot prepares the MSR and opens the viewer without running the minimizer.</text>
</svg>

After

Width:  |  Height:  |  Size: 3.5 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 113 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 78 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 95 KiB

+9 -1
View File
@@ -5,6 +5,14 @@ The **MSR Editor** tab displays the complete MSR file that muSRFlow prepares.
It is a real editor, not just a preview: you can edit the text by hand, and
the edited document becomes the source of truth for the next Fit or Plot.
.. figure:: images/msr-editor-tab.png
:alt: MSR Editor showing a generated unfitted MSR with highlighted block keywords and comments, the GUI to MSR button, and the ownership lock.
:width: 100%
A document generated with **GUI -> MSR**, before any fit. Syntax colours
separate keywords and comments. The open padlock shows that the GUI still
owns this document; editing it by hand changes that state.
Ownership: GUI or editor
------------------------
@@ -52,4 +60,4 @@ artifacts.
The editor also shows which source document it currently displays. For a
multiple-run fit it can expose the generated document and the template it
was built from; the active tab (**MSR** or **Template**) selects which one
is shown.
is shown.
+8 -1
View File
@@ -5,6 +5,13 @@ muSRFlow provides a modern interface over the classic µSR analysis tools. A
typical session selects the data, chooses a fit model, fits it, inspects the
result, and finally inspects how the fitted parameters vary run by run.
.. figure:: images/fit-workflow.*
:alt: Four steps: choose the analysis, prepare the MSR, fit with musrfit, then review fitted values and plots. Plot skips the minimizer.
:width: 100%
The basic fit workflow. See :doc:`runs-fitting` for independent series
and shared-parameter fits, and :doc:`msr-editor` for document ownership.
What you get
------------
@@ -79,4 +86,4 @@ A first fit
The Quick Start button (``?``) at the right of the tab bar opens a short
guide that highlights the section relevant to the active tab. Its sections
are expanded into the chapters of this manual.
are expanded into the chapters of this manual.
+9 -1
View File
@@ -6,6 +6,14 @@ parameter, per data set, with starting values, steps, and limits. Fitting
feeds the measured values back, and the same table drives the interactive
parameter plots.
.. figure:: images/parameters-tab.png
:alt: Parameters tab with editable starting values, error or step fields, bounds, and the Plot parameters button.
:width: 100%
Example parameter table before fitting, for the same run and model as
:doc:`getting-started`. These are initial values, not measured results;
the Error column contains starting steps at this stage.
The parameter table
-------------------
@@ -248,4 +256,4 @@ With a panel focused (and not while typing in a field), the shortcut keys are:
The plotly mode bar at the top-right of each panel provides zoom, pan, box
select, and download, and a custom button toggles each axis between linear
and logarithmic. Trace colours are assigned automatically per series --
clicking a marker opens the style editor described above to change them.
clicking a marker opens the style editor described above to change them.
+7
View File
@@ -5,6 +5,13 @@ Both editions share the tabs, fit engine, model library, parameter plots, and
configuration-sharing protocol. The differences come from where the data and
the command-line tools live.
.. figure:: images/execution-locations.*
:alt: Linux runs native tools locally; Windows runs its bundled tools in WSL2; the browser sends work to the CGI server.
:width: 100%
Standard execution paths. Windows can also use explicitly configured
native binaries instead of the bundled WSL runtime.
.. list-table::
:header-rows: 1
:widths: 25 35 40
+3 -3
View File
@@ -14,7 +14,7 @@ Run(s)
sequence, for example ``520:540:2``.
Each comma- or range-separated data set is fit independently and merged
into one fit document, so ``514, 516, 520-525`` prepares six data sets.
into one fit document, so ``514, 516, 520-525`` prepares eight data sets.
A ``+`` between runs adds the run to the previous data set via the MSR
``ADDRUN`` directive rather than starting a new data set. ``514+515`` is
@@ -23,7 +23,7 @@ Run(s)
Examples:
* ``514`` -- one run.
* ``514, 520-525`` -- two data sets: 514 and each of 520..525.
* ``514, 520-525`` -- seven data sets: 514 and each of 520..525.
* ``514+515, 520:540:2`` -- one ADDRUN data set and a stepped range.
Year
@@ -223,4 +223,4 @@ edition always fits on the server and ignores the setting.
If the MSR editor owns the document (a hand-edited MSR is authoritative), the
editor block is used for Fit and Plot as-is and GUI changes do not silently
replace it -- see :doc:`msr-editor`.
replace it -- see :doc:`msr-editor`.
+17 -1
View File
@@ -11,6 +11,14 @@ cgi_target="${MUSRFLOW_CGI_TARGET:-/var/www/cgi-bin/single_musrfit.cgi}"
# part of this deployment (not a system config file) and lives beside the CGI,
# outside the web document root so it is never served to browsers.
startup_target="${MUSRFLOW_STARTUP_XML_TARGET:-/var/www/cgi-bin/musrfit_startup.xml}"
docs_source="$project_root/docs/_build/html"
# Build as the normal user beforehand, not inside a possibly privileged deploy.
# Check before changing the installed application so missing docs fail cleanly.
if [ ! -s "$docs_source/index.html" ]; then
printf 'HTML manual missing. Run make -C "%s/docs" html before deploying.\n' "$project_root" >&2
exit 1
fi
# Install only assets used by the browser build. Parameter plotting and ROOT
# rendering are loaded as separate browser modules.
@@ -29,6 +37,13 @@ install -m 0644 \
"$project_root/assets/musrflow-icon.png" \
"$web_target/assets/"
# Copy the entire Sphinx site, including search data, styles, and source links.
# Build-machine permissions must not prevent Apache from reading the manual.
install -d -m 0755 "$web_target/docs"
cp -R "$docs_source/." "$web_target/docs/"
find "$web_target/docs" -type d -exec chmod 0755 {} +
find "$web_target/docs" -type f -exec chmod 0644 {} +
# Brand the installed help page with the current release version, matching the
# About dialog in the Electron edition. The source keeps a __MUSRFLOW_VERSION__
# token that renders as "development build" when left unsubstituted; the
@@ -111,10 +126,11 @@ if [ -n "$web_owner" ]; then
fi
printf 'Installed muSRFlow web assets in %s\n' "$web_target"
printf 'Installed muSRFlow HTML manual in %s/docs/\n' "$web_target"
printf 'Installed muSRFlow CGI runner at %s\n' "$cgi_target"
printf 'Installed muSRFlow startup XML at %s\n' "$startup_target"
if [ -n "$web_owner" ]; then
printf 'Ownership set to %s:%s\n' "$web_owner" "$web_group"
else
printf 'Ownership left unchanged (deployed by the owning user)\n'
fi
fi
+58
View File
@@ -4,6 +4,8 @@
const assert = require("assert");
const fs = require("fs");
const path = require("path");
const os = require("os");
const { spawnSync } = require("child_process");
const repoRoot = path.resolve(__dirname, "..");
@@ -46,5 +48,61 @@ function testSharedHelpWindowInfrastructure() {
assert.doesNotMatch(lib, /musrfit-gui|bitbucket\.org\/zaher-salman\/musrfit-gui/);
}
function testDocumentationDeployment() {
// The Apache deployment script targets Linux; no real web directory is used.
if (process.platform !== "linux") return;
const temporary = fs.mkdtempSync(path.join(os.tmpdir(), "musrflow web deploy "));
try {
const source = path.join(temporary, "source");
const target = path.join(temporary, "installed");
for (const directory of ["scripts", "assets", "cgi"]) {
fs.mkdirSync(path.join(source, directory), { recursive: true });
}
fs.mkdirSync(target);
fs.copyFileSync(path.join(repoRoot, "scripts/deploy-web.sh"), path.join(source, "scripts/deploy-web.sh"));
const assets = ["index.html", "quick-start.html", "ZGUI.css", "muSRFitweb.js", "muSRFitRoot.js",
"muSRFitParameterPlot.js", "muSRFitlib.js", "assets/musrflow-favicon.png", "assets/musrflow-icon.png",
"cgi/single_musrfit.cgi", "cgi/musrfit_startup.xml"];
for (const file of assets) fs.writeFileSync(path.join(source, file), "fixture\n");
fs.writeFileSync(path.join(source, "package.json"), JSON.stringify({ version: "1.2.3" }));
const options = { encoding: "utf8", env: { ...process.env,
MUSRFLOW_WEB_TARGET: path.join(target, "web"),
MUSRFLOW_CGI_TARGET: path.join(target, "runner.cgi"),
MUSRFLOW_STARTUP_XML_TARGET: path.join(target, "startup.xml"),
MUSRFLOW_WEB_OWNER: "", MUSRFLOW_WEB_GROUP: "", MUSRFLOW_DATA_ROOT: "" } };
const script = path.join(source, "scripts/deploy-web.sh");
const missing = spawnSync("bash", [script], options);
assert.strictEqual(missing.status, 1, missing.stderr);
assert.match(missing.stderr, /HTML manual missing.*make -C/);
assert.deepStrictEqual(fs.readdirSync(target), [], "missing docs must not partially deploy the app");
const html = path.join(source, "docs/_build/html");
for (const directory of ["_static", "_sources"]) {
fs.mkdirSync(path.join(html, directory), { recursive: true, mode: 0o700 });
}
const pages = ["index.html", "searchindex.js", "_static/theme.css", "_sources/index.rst.txt"];
for (const file of pages) fs.writeFileSync(path.join(html, file), file, { mode: 0o600 });
const deployed = spawnSync("bash", [script], options);
assert.strictEqual(deployed.status, 0, deployed.stderr);
assert.match(deployed.stdout, /Installed muSRFlow HTML manual/);
for (const file of pages) {
const installed = path.join(target, "web/docs", file);
assert.strictEqual(fs.readFileSync(installed, "utf8"), file);
assert.strictEqual(fs.statSync(installed).mode & 0o777, 0o644);
}
assert.strictEqual(fs.statSync(path.join(target, "web/docs/_static")).mode & 0o777, 0o755);
fs.writeFileSync(path.join(html, "index.html"), "updated manual");
const updated = spawnSync("bash", [script], options);
assert.strictEqual(updated.status, 0, updated.stderr);
assert.strictEqual(fs.readFileSync(path.join(target, "web/docs/index.html"), "utf8"), "updated manual");
fs.writeFileSync(path.join(html, "index.html"), "");
assert.strictEqual(spawnSync("bash", [script], options).status, 1);
assert.strictEqual(fs.readFileSync(path.join(target, "web/docs/index.html"), "utf8"), "updated manual");
} finally {
fs.rmSync(temporary, { recursive: true, force: true });
}
}
testSharedHelpWindowInfrastructure();
testDocumentationDeployment();
console.log("help window tests passed");