Document series per-run statistics and the 1.0.0-rc.1 version
This commit is contained in:
1 parent
6238db9442
commit
646c0ff663
26 files changed
+118
-36
No files matched your search
@@ -31,8 +31,8 @@ Dependencies only need to be installed once. Later sessions can be started with
|
||||
|
||||
## Desktop Packages
|
||||
|
||||
The desktop beta is version `0.9.0-beta.5`. Linux RPM and AppImage release
|
||||
packages can be produced with:
|
||||
The desktop app is at version `1.0.0-rc.1` (release candidate). Linux RPM
|
||||
and AppImage release packages can be produced with:
|
||||
|
||||
```bash
|
||||
npm run dist:rpm
|
||||
@@ -42,8 +42,8 @@ npm run dist:appimage
|
||||
See [`docs/DESKTOP_DEPLOYMENT.md`](docs/DESKTOP_DEPLOYMENT.md) for build,
|
||||
runtime, and release requirements.
|
||||
|
||||
The planned path to version 1.0 and the prioritized workflow improvements are
|
||||
tracked in [`TODO.md`](TODO.md). Per-release notes are in
|
||||
The remaining work before 1.0 and the prioritized improvements are tracked in
|
||||
[`TODO.md`](TODO.md). Per-release notes are in
|
||||
[`CHANGELOG.md`](CHANGELOG.md).
|
||||
|
||||
## Web Deployment
|
||||
|
||||
@@ -76,7 +76,7 @@ After installing on a new PC, the minimum smoke test is:
|
||||
Use the native package manager where possible, for example:
|
||||
|
||||
```bash
|
||||
sudo dnf install ./dist/muSRFlow-0.9.0-beta.1-x86_64.rpm
|
||||
sudo dnf install ./dist/muSRFlow-1.0.0-rc.1-x86_64.rpm
|
||||
```
|
||||
|
||||
On RPM distributions with different package naming conventions, use the
|
||||
@@ -86,8 +86,8 @@ libraries.
|
||||
## Running the AppImage
|
||||
|
||||
```bash
|
||||
chmod +x dist/muSRFlow-0.9.0-beta.1-x86_64.AppImage
|
||||
./dist/muSRFlow-0.9.0-beta.1-x86_64.AppImage
|
||||
chmod +x dist/muSRFlow-1.0.0-rc.1-x86_64.AppImage
|
||||
./dist/muSRFlow-1.0.0-rc.1-x86_64.AppImage
|
||||
```
|
||||
|
||||
## Versioning
|
||||
@@ -96,17 +96,19 @@ chmod +x dist/muSRFlow-0.9.0-beta.1-x86_64.AppImage
|
||||
Electron reports it through `app.getVersion()` and the About dialog.
|
||||
`package-lock.json` should carry the same version.
|
||||
|
||||
For the next beta, for example:
|
||||
For the next release candidate or final release, keep `package.json`,
|
||||
`package-lock.json`, `tests/release-packaging.test.js`, and `CHANGELOG.md` in
|
||||
step. For example:
|
||||
|
||||
```bash
|
||||
npm version 0.9.0-beta.2 --no-git-tag-version
|
||||
npm version 1.0.0-rc.1 --no-git-tag-version
|
||||
npm test
|
||||
git commit -am "Prepare muSRFlow 0.9.0-beta.2"
|
||||
git tag v0.9.0-beta.2
|
||||
git commit -am "Prepare muSRFlow 1.0.0-rc.1"
|
||||
git tag v1.0.0-rc.1
|
||||
```
|
||||
|
||||
For `1.0.0`, update the version only after the beta has been exercised on the
|
||||
actual target Linux installations.
|
||||
For `1.0.0`, update the version only after the release candidate has been
|
||||
exercised on the actual target Linux installations.
|
||||
|
||||
## Application icon
|
||||
|
||||
|
||||
+4
-1
@@ -45,7 +45,10 @@ The status bar under the main window keeps a terse permanent status:
|
||||
* the **state** button (for example ``Idle``, ``Running musrfit``) -- click it
|
||||
to open the run log immediately;
|
||||
* the **fit statistic** (for example ``χ²/NDF 1.012``), kept from the fit
|
||||
so a later plot does not erase it;
|
||||
so a later plot does not erase it. For an independent-series fit the button
|
||||
instead shows the worst/best aggregate of the per-run statistics (or
|
||||
``Series did not converge`` when any run failed); clicking it opens the
|
||||
per-run statistics table -- see :doc:`runs-fitting`;
|
||||
* the **message** line for transient notices (click it to open the run log);
|
||||
* the **file** and **directory** the last action operated on.
|
||||
|
||||
|
||||
+23
@@ -116,6 +116,29 @@ parameter (the **Shared** column in the parameter table) disables this route
|
||||
and the chips disappear; see :doc:`parameters-plots`. The parameter plot is
|
||||
unaffected and still works.
|
||||
|
||||
Per-run statistics
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
|
||||
For an independent-series fit the status-bar statistic button summarises the
|
||||
series -- either **Series did not converge** (some runs failed to converge) or
|
||||
a worst/best aggregate such as ``χ²/NDF worst 1.24 / best 1.01 · 5 runs``.
|
||||
Clicking the button opens a per-run statistics table that lists every data set
|
||||
in run order with:
|
||||
|
||||
* the run identifier;
|
||||
* the action that produced it (**reuse**, **refit**, or **skip**);
|
||||
* the run's statistic text (χ²/NDF or max likelihood/NDF, or
|
||||
``Fit did not converge``);
|
||||
* the converged state;
|
||||
* the fitted file the value came from.
|
||||
|
||||
Reused or skipped runs show the values read from the MSRs already used for
|
||||
plotting. Rows are highlighted for contrast: runs whose value is more than
|
||||
twice the series median stand out as outliers (the spread a worst/best summary
|
||||
might hide), failed runs are marked as not converged, and reused/skipped rows
|
||||
that still carry the on-disk value are visually distinct from freshly fitted
|
||||
ones.
|
||||
|
||||
View settings
|
||||
-------------
|
||||
|
||||
|
||||
+1
-1
@@ -1,5 +1,5 @@
|
||||
const DOCUMENTATION_OPTIONS = {
|
||||
VERSION: '0.9.0-beta.4',
|
||||
VERSION: '1.0.0-rc.1',
|
||||
LANGUAGE: 'en',
|
||||
COLLAPSE_INDEX: false,
|
||||
BUILDER: 'html',
|
||||
|
||||
+1
-1
@@ -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=0a76b8f8"></script>
|
||||
<script src="_static/documentation_options.js?v=4b0c7688"></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>
|
||||
|
||||
Vendored
+1
-1
@@ -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=0a76b8f8"></script>
|
||||
<script src="_static/documentation_options.js?v=4b0c7688"></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>
|
||||
|
||||
Vendored
+1
-1
@@ -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=0a76b8f8"></script>
|
||||
<script src="_static/documentation_options.js?v=4b0c7688"></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
@@ -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=0a76b8f8"></script>
|
||||
<script src="_static/documentation_options.js?v=4b0c7688"></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>
|
||||
|
||||
Vendored
+1
-1
@@ -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=0a76b8f8"></script>
|
||||
<script src="_static/documentation_options.js?v=4b0c7688"></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>
|
||||
|
||||
Vendored
+1
-1
@@ -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=0a76b8f8"></script>
|
||||
<script src="_static/documentation_options.js?v=4b0c7688"></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
@@ -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=0a76b8f8"></script>
|
||||
<script src="_static/documentation_options.js?v=4b0c7688"></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>
|
||||
|
||||
Vendored
+1
-1
@@ -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=0a76b8f8"></script>
|
||||
<script src="_static/documentation_options.js?v=4b0c7688"></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>
|
||||
|
||||
Vendored
BIN
Binary file not shown.
Vendored
+1
-1
@@ -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=0a76b8f8"></script>
|
||||
<script src="_static/documentation_options.js?v=4b0c7688"></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
@@ -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=0a76b8f8"></script>
|
||||
<script src="_static/documentation_options.js?v=4b0c7688"></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>
|
||||
|
||||
Vendored
+1
-1
@@ -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=0a76b8f8"></script>
|
||||
<script src="_static/documentation_options.js?v=4b0c7688"></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>
|
||||
|
||||
Vendored
+1
-1
@@ -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=0a76b8f8"></script>
|
||||
<script src="_static/documentation_options.js?v=4b0c7688"></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>
|
||||
|
||||
+5
-2
@@ -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=0a76b8f8"></script>
|
||||
<script src="_static/documentation_options.js?v=4b0c7688"></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>
|
||||
@@ -133,7 +133,10 @@ diagnose unexpected behaviour.</p>
|
||||
<li><p>the <strong>state</strong> button (for example <code class="docutils literal notranslate"><span class="pre">Idle</span></code>, <code class="docutils literal notranslate"><span class="pre">Running</span> <span class="pre">musrfit</span></code>) – click it
|
||||
to open the run log immediately;</p></li>
|
||||
<li><p>the <strong>fit statistic</strong> (for example <code class="docutils literal notranslate"><span class="pre">χ²/NDF</span> <span class="pre">1.012</span></code>), kept from the fit
|
||||
so a later plot does not erase it;</p></li>
|
||||
so a later plot does not erase it. For an independent-series fit the button
|
||||
instead shows the worst/best aggregate of the per-run statistics (or
|
||||
<code class="docutils literal notranslate"><span class="pre">Series</span> <span class="pre">did</span> <span class="pre">not</span> <span class="pre">converge</span></code> when any run failed); clicking it opens the
|
||||
per-run statistics table – see <a class="reference internal" href="runs-fitting.html"><span class="doc">Runs and fitting</span></a>;</p></li>
|
||||
<li><p>the <strong>message</strong> line for transient notices (click it to open the run log);</p></li>
|
||||
<li><p>the <strong>file</strong> and <strong>directory</strong> the last action operated on.</p></li>
|
||||
</ul>
|
||||
|
||||
Vendored
+27
-2
@@ -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=0a76b8f8"></script>
|
||||
<script src="_static/documentation_options.js?v=4b0c7688"></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>
|
||||
@@ -51,7 +51,10 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="#fit-range">Fit range</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#fit-model">Fit model</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#fit-options">Fit options</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#series-fit-actions">Series fit actions</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#series-fit-actions">Series fit actions</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#per-run-statistics">Per-run statistics</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#view-settings">View settings</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#fit-and-plot">Fit and Plot</a></li>
|
||||
</ul>
|
||||
@@ -201,6 +204,28 @@ and then override single runs by clicking their chip.</p>
|
||||
parameter (the <strong>Shared</strong> column in the parameter table) disables this route
|
||||
and the chips disappear; see <a class="reference internal" href="parameters-plots.html"><span class="doc">Parameters and parameter plots</span></a>. The parameter plot is
|
||||
unaffected and still works.</p>
|
||||
<section id="per-run-statistics">
|
||||
<h3>Per-run statistics<a class="headerlink" href="#per-run-statistics" title="Link to this heading"></a></h3>
|
||||
<p>For an independent-series fit the status-bar statistic button summarises the
|
||||
series – either <strong>Series did not converge</strong> (some runs failed to converge) or
|
||||
a worst/best aggregate such as <code class="docutils literal notranslate"><span class="pre">χ²/NDF</span> <span class="pre">worst</span> <span class="pre">1.24</span> <span class="pre">/</span> <span class="pre">best</span> <span class="pre">1.01</span> <span class="pre">·</span> <span class="pre">5</span> <span class="pre">runs</span></code>.
|
||||
Clicking the button opens a per-run statistics table that lists every data set
|
||||
in run order with:</p>
|
||||
<ul class="simple">
|
||||
<li><p>the run identifier;</p></li>
|
||||
<li><p>the action that produced it (<strong>reuse</strong>, <strong>refit</strong>, or <strong>skip</strong>);</p></li>
|
||||
<li><p>the run’s statistic text (χ²/NDF or max likelihood/NDF, or
|
||||
<code class="docutils literal notranslate"><span class="pre">Fit</span> <span class="pre">did</span> <span class="pre">not</span> <span class="pre">converge</span></code>);</p></li>
|
||||
<li><p>the converged state;</p></li>
|
||||
<li><p>the fitted file the value came from.</p></li>
|
||||
</ul>
|
||||
<p>Reused or skipped runs show the values read from the MSRs already used for
|
||||
plotting. Rows are highlighted for contrast: runs whose value is more than
|
||||
twice the series median stand out as outliers (the spread a worst/best summary
|
||||
might hide), failed runs are marked as not converged, and reused/skipped rows
|
||||
that still carry the on-disk value are visually distinct from freshly fitted
|
||||
ones.</p>
|
||||
</section>
|
||||
</section>
|
||||
<section id="view-settings">
|
||||
<h2>View settings<a class="headerlink" href="#view-settings" title="Link to this heading"></a></h2>
|
||||
|
||||
Vendored
+1
-1
@@ -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=0a76b8f8"></script>
|
||||
<script src="_static/documentation_options.js?v=4b0c7688"></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>
|
||||
|
||||
Vendored
+1
-1
@@ -1 +1 @@
|
||||
Search.setIndex({"alltitles":{"A first fit":[[7,"a-first-fit"]],"Command log":[[11,"command-log"]],"Configuration sharing":[[0,null]],"Constraints":[[1,null],[1,"id1"]],"Contents":[[4,null]],"Custom parameters":[[1,"custom-parameters"]],"Desktop installation":[[2,"desktop-installation"]],"Example: couple the magnetic field to the Larmor frequency":[[1,"example-couple-the-magnetic-field-to-the-larmor-frequency"]],"Execution details":[[11,"execution-details"]],"File handling":[[6,"file-handling"]],"Fit and Plot":[[12,"fit-and-plot"]],"Fit model":[[12,"fit-model"]],"Fit options":[[12,"fit-options"]],"Fit or plot will not start":[[14,"fit-or-plot-will-not-start"]],"Fit range":[[12,"fit-range"]],"Fitted parameters look wrong or unchanged":[[14,"fitted-parameters-look-wrong-or-unchanged"]],"General notes":[[5,"general-notes"]],"Getting started":[[2,null]],"Glossary":[[3,null]],"Keyboard shortcuts":[[5,null],[8,"keyboard-shortcuts"]],"MSR editor":[[5,"msr-editor"],[6,null]],"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":[[11,"outcome-dialog"]],"Overview":[[7,null]],"Ownership: GUI or editor":[[6,"ownership-gui-or-editor"]],"Parameter plot hangs on \u201cPreparing plot files\u201d":[[14,"parameter-plot-hangs-on-preparing-plot-files"]],"Parameter plot is empty or missing data":[[14,"parameter-plot-is-empty-or-missing-data"]],"Parameter selection (Parameters tab)":[[5,"parameter-selection-parameters-tab"]],"Parameter-plot window":[[5,"parameter-plot-window"]],"Parameters and parameter plots":[[8,null]],"Plot options":[[8,"plot-options"]],"Preferences":[[10,null]],"Prerequisites":[[2,"prerequisites"]],"Preview":[[1,"preview"]],"Reporting problems":[[14,"reporting-problems"]],"Restored configuration differs from the original machine":[[14,"restored-configuration-differs-from-the-original-machine"]],"Result files":[[11,"result-files"]],"Results and diagnostics":[[11,null]],"Run log window":[[11,"run-log-window"]],"Run selection":[[12,"run-selection"]],"Running the desktop app":[[2,"running-the-desktop-app"]],"Runs and fitting":[[12,null]],"Selecting parameters for plotting":[[8,"selecting-parameters-for-plotting"]],"Series fit actions":[[12,"series-fit-actions"]],"Some links start with a different prefix":[[14,"some-links-start-with-a-different-prefix"]],"Support":[[2,"support"]],"Template and series presets":[[8,"template-and-series-presets"]],"The Choose X axis dialog":[[8,"the-choose-x-axis-dialog"]],"The Quick Start guide":[[2,"the-quick-start-guide"]],"The Shared column":[[8,"the-shared-column"]],"The parameter table":[[8,"the-parameter-table"]],"The parameter-plot window":[[8,"the-parameter-plot-window"]],"The status bar":[[11,"the-status-bar"]],"Troubleshooting":[[14,null]],"Two editions":[[7,"two-editions"]],"Under the hood":[[7,"under-the-hood"]],"View settings":[[12,"view-settings"]],"Web and desktop editions":[[9,null]],"Web page cannot load data":[[14,"web-page-cannot-load-data"]],"What is shared":[[0,"what-is-shared"]],"What you get":[[7,"what-you-get"]],"Workflow":[[6,"workflow"]],"muSRFlow User Manual":[[4,null]],"t0 / background":[[13,null]],"\u201cNothing to fit\u201d":[[14,"nothing-to-fit"]]},"docnames":["configuration-sharing","constraints","getting-started","glossary","index","keyboard-shortcuts","msr-editor","overview","parameters-plots","platforms","preferences","results-diagnostics","runs-fitting","t0-background","troubleshooting"],"envversion":{"sphinx":65,"sphinx.domains.c":3,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":9,"sphinx.domains.index":1,"sphinx.domains.javascript":3,"sphinx.domains.math":2,"sphinx.domains.python":4,"sphinx.domains.rst":2,"sphinx.domains.std":2},"filenames":["configuration-sharing.rst","constraints.rst","getting-started.rst","glossary.rst","index.rst","keyboard-shortcuts.rst","msr-editor.rst","overview.rst","parameters-plots.rst","platforms.rst","preferences.rst","results-diagnostics.rst","runs-fitting.rst","t0-background.rst","troubleshooting.rst"],"indexentries":{"addrun":[[3,"term-ADDRUN",true]],"configuration link":[[3,"term-configuration-link",true]],"dump_header":[[3,"term-dump_header",true]],"fft":[[3,"term-FFT",true]],"fit document":[[3,"term-fit-document",true]],"global parameter":[[3,"term-global-parameter",true]],"independent-series fit":[[3,"term-independent-series-fit",true]],"msr":[[3,"term-MSR",true]],"msr2data":[[3,"term-msr2data",true]],"musrfit":[[3,"term-musrfit",true]],"musrview":[[3,"term-musrview",true]],"par.dat":[[3,"term-par.dat",true]],"root plot":[[3,"term-ROOT-plot",true]],"rrf":[[3,"term-RRF",true]],"run":[[3,"term-RUN",true]]},"objects":{},"objnames":{},"objtypes":{},"terms":{"":[3,5,6,10,12,14],"0":12,"012":11,"1":[8,11,12],"100":12,"12":12,"16":12,"1998":12,"2":12,"3":8,"5":12,"514":[3,12],"515":[3,12],"516":12,"520":12,"525":12,"540":12,"7":12,"8":12,"A":[0,1,3,4,10,11,12,14],"For":[2Line truncated
|
||||
Search.setIndex({"alltitles":{"A first fit":[[7,"a-first-fit"]],"Command log":[[11,"command-log"]],"Configuration sharing":[[0,null]],"Constraints":[[1,null],[1,"id1"]],"Contents":[[4,null]],"Custom parameters":[[1,"custom-parameters"]],"Desktop installation":[[2,"desktop-installation"]],"Example: couple the magnetic field to the Larmor frequency":[[1,"example-couple-the-magnetic-field-to-the-larmor-frequency"]],"Execution details":[[11,"execution-details"]],"File handling":[[6,"file-handling"]],"Fit and Plot":[[12,"fit-and-plot"]],"Fit model":[[12,"fit-model"]],"Fit options":[[12,"fit-options"]],"Fit or plot will not start":[[14,"fit-or-plot-will-not-start"]],"Fit range":[[12,"fit-range"]],"Fitted parameters look wrong or unchanged":[[14,"fitted-parameters-look-wrong-or-unchanged"]],"General notes":[[5,"general-notes"]],"Getting started":[[2,null]],"Glossary":[[3,null]],"Keyboard shortcuts":[[5,null],[8,"keyboard-shortcuts"]],"MSR editor":[[5,"msr-editor"],[6,null]],"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":[[11,"outcome-dialog"]],"Overview":[[7,null]],"Ownership: GUI or editor":[[6,"ownership-gui-or-editor"]],"Parameter plot hangs on \u201cPreparing plot files\u201d":[[14,"parameter-plot-hangs-on-preparing-plot-files"]],"Parameter plot is empty or missing data":[[14,"parameter-plot-is-empty-or-missing-data"]],"Parameter selection (Parameters tab)":[[5,"parameter-selection-parameters-tab"]],"Parameter-plot window":[[5,"parameter-plot-window"]],"Parameters and parameter plots":[[8,null]],"Per-run statistics":[[12,"per-run-statistics"]],"Plot options":[[8,"plot-options"]],"Preferences":[[10,null]],"Prerequisites":[[2,"prerequisites"]],"Preview":[[1,"preview"]],"Reporting problems":[[14,"reporting-problems"]],"Restored configuration differs from the original machine":[[14,"restored-configuration-differs-from-the-original-machine"]],"Result files":[[11,"result-files"]],"Results and diagnostics":[[11,null]],"Run log window":[[11,"run-log-window"]],"Run selection":[[12,"run-selection"]],"Running the desktop app":[[2,"running-the-desktop-app"]],"Runs and fitting":[[12,null]],"Selecting parameters for plotting":[[8,"selecting-parameters-for-plotting"]],"Series fit actions":[[12,"series-fit-actions"]],"Some links start with a different prefix":[[14,"some-links-start-with-a-different-prefix"]],"Support":[[2,"support"]],"Template and series presets":[[8,"template-and-series-presets"]],"The Choose X axis dialog":[[8,"the-choose-x-axis-dialog"]],"The Quick Start guide":[[2,"the-quick-start-guide"]],"The Shared column":[[8,"the-shared-column"]],"The parameter table":[[8,"the-parameter-table"]],"The parameter-plot window":[[8,"the-parameter-plot-window"]],"The status bar":[[11,"the-status-bar"]],"Troubleshooting":[[14,null]],"Two editions":[[7,"two-editions"]],"Under the hood":[[7,"under-the-hood"]],"View settings":[[12,"view-settings"]],"Web and desktop editions":[[9,null]],"Web page cannot load data":[[14,"web-page-cannot-load-data"]],"What is shared":[[0,"what-is-shared"]],"What you get":[[7,"what-you-get"]],"Workflow":[[6,"workflow"]],"muSRFlow User Manual":[[4,null]],"t0 / background":[[13,null]],"\u201cNothing to fit\u201d":[[14,"nothing-to-fit"]]},"docnames":["configuration-sharing","constraints","getting-started","glossary","index","keyboard-shortcuts","msr-editor","overview","parameters-plots","platforms","preferences","results-diagnostics","runs-fitting","t0-background","troubleshooting"],"envversion":{"sphinx":65,"sphinx.domains.c":3,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":9,"sphinx.domains.index":1,"sphinx.domains.javascript":3,"sphinx.domains.math":2,"sphinx.domains.python":4,"sphinx.domains.rst":2,"sphinx.domains.std":2},"filenames":["configuration-sharing.rst","constraints.rst","getting-started.rst","glossary.rst","index.rst","keyboard-shortcuts.rst","msr-editor.rst","overview.rst","parameters-plots.rst","platforms.rst","preferences.rst","results-diagnostics.rst","runs-fitting.rst","t0-background.rst","troubleshooting.rst"],"indexentries":{"addrun":[[3,"term-ADDRUN",true]],"configuration link":[[3,"term-configuration-link",true]],"dump_header":[[3,"term-dump_header",true]],"fft":[[3,"term-FFT",true]],"fit document":[[3,"term-fit-document",true]],"global parameter":[[3,"term-global-parameter",true]],"independent-series fit":[[3,"term-independent-series-fit",true]],"msr":[[3,"term-MSR",true]],"msr2data":[[3,"term-msr2data",true]],"musrfit":[[3,"term-musrfit",true]],"musrview":[[3,"term-musrview",true]],"par.dat":[[3,"term-par.dat",true]],"root plot":[[3,"term-ROOT-plot",true]],"rrf":[[3,"term-RRF",true]],"run":[[3,"term-RUN",true]]},"objects":{},"objnames":{},"objtypes":{},"terms":{"":[3,5,6,10,12,14],"0":12,"01":12,"012":11,"1":[8,11,12],"100":12,"12":12,"16":12,"1998":12,"2":12,"24":12,"3":8,"5":12,"514":[3,12],"515":[3,12],"516":12,"520":12,"Line truncated
|
||||
Vendored
+1
-1
@@ -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=0a76b8f8"></script>
|
||||
<script src="_static/documentation_options.js?v=4b0c7688"></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
@@ -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=0a76b8f8"></script>
|
||||
<script src="_static/documentation_options.js?v=4b0c7688"></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>
|
||||
|
||||
@@ -45,7 +45,10 @@ The status bar under the main window keeps a terse permanent status:
|
||||
* the **state** button (for example ``Idle``, ``Running musrfit``) -- click it
|
||||
to open the run log immediately;
|
||||
* the **fit statistic** (for example ``χ²/NDF 1.012``), kept from the fit
|
||||
so a later plot does not erase it;
|
||||
so a later plot does not erase it. For an independent-series fit the button
|
||||
instead shows the worst/best aggregate of the per-run statistics (or
|
||||
``Series did not converge`` when any run failed); clicking it opens the
|
||||
per-run statistics table -- see :doc:`runs-fitting`;
|
||||
* the **message** line for transient notices (click it to open the run log);
|
||||
* the **file** and **directory** the last action operated on.
|
||||
|
||||
|
||||
@@ -116,6 +116,29 @@ parameter (the **Shared** column in the parameter table) disables this route
|
||||
and the chips disappear; see :doc:`parameters-plots`. The parameter plot is
|
||||
unaffected and still works.
|
||||
|
||||
Per-run statistics
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
|
||||
For an independent-series fit the status-bar statistic button summarises the
|
||||
series -- either **Series did not converge** (some runs failed to converge) or
|
||||
a worst/best aggregate such as ``χ²/NDF worst 1.24 / best 1.01 · 5 runs``.
|
||||
Clicking the button opens a per-run statistics table that lists every data set
|
||||
in run order with:
|
||||
|
||||
* the run identifier;
|
||||
* the action that produced it (**reuse**, **refit**, or **skip**);
|
||||
* the run's statistic text (χ²/NDF or max likelihood/NDF, or
|
||||
``Fit did not converge``);
|
||||
* the converged state;
|
||||
* the fitted file the value came from.
|
||||
|
||||
Reused or skipped runs show the values read from the MSRs already used for
|
||||
plotting. Rows are highlighted for contrast: runs whose value is more than
|
||||
twice the series median stand out as outliers (the spread a worst/best summary
|
||||
might hide), failed runs are marked as not converged, and reused/skipped rows
|
||||
that still carry the on-disk value are visually distinct from freshly fitted
|
||||
ones.
|
||||
|
||||
View settings
|
||||
-------------
|
||||
|
||||
|
||||
Reference in new issue
Block a user