Files
muSRFlow/quick-start.html
T
salman 5a91b1a043 Drop legacy musrfit-gui credit from MSRs and expose the version on the web
Generated MSRs no longer carry the old musrfit-gui repository URL; the
header names muSRFlow, the author, the licence, and the muSRFlow site,
and the reference fixtures follow. The Quick Start/help page gains an
About muSRFlow section with the version, author, and licence, mirroring
the Electron Help > About dialog: the Electron window is fed
app.getVersion() over the quickStartSection channel, while the web
deploy brands the installed page with the package.json version
(idempotent sed on a __MUSRFLOW_VERSION__ token that renders as
'development build' when unsubstituted).
2026-09-14 11:36:45 +02:00

112 lines
7.6 KiB
HTML

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>muSRFlow Quick Start</title>
<link rel="stylesheet" href="ZGUI.css">
</head>
<body class="quick-start-document">
<main class="quick-start-body" id="quickStartBody">
<section class="quick-start-section" id="helpRuns">
<h3>Runs and fitting</h3>
<ol>
<li>Select the instrument and year, then enter one or more runs.</li>
<li>Choose the fit type and add the theory components you need.</li>
<li>Use <b>Fit</b> to generate and fit the MSR, or <b>Plot</b> to inspect the spectra with musrview.</li>
</ol>
<p>When an independent series fit (two or more runs, no shared parameters) is eligible, the <b>Fit options</b> row adds an action chip per run. Click a chip to cycle it: <b>reuse</b> keeps the existing fit, <b>refit</b> rebuilds the MSR from the live GUI parameters, and <b>skip</b> leaves the run untouched. The <b>All</b> dropdown sets every chip at once from <b>Reuse all</b>, <b>Refit all</b>, or <b>Skip all</b>.</p>
<p>Plot, FFT and RRF settings are available from their compact option tickets. Plot options include independent time and Y-axis ranges; leaving a pair empty selects automatic limits. In Electron, machine-specific paths, output suffixes and automatic initial-parameter guessing are under <b>File &rarr; Preferences</b>.</p>
</section>
<section class="quick-start-section" id="helpParams">
<h3>Parameters and parameter plots</h3>
<p>Edit value, step and limits directly in the table. Once populated, the table is the source of the starting values used for fitting.</p>
<p>In a multi-run fit the table also has a <b>Shared</b> column: tick a parameter to keep a single shared starting value, step and limits for all runs instead of a separate per-run copy. Sharing any parameter takes the fit out of the independent-series route, so per-run refit/skip control is hidden; the parameter plot still works.</p>
<p>Click a parameter name to select or deselect it. Ctrl/Cmd-click adds individual parameters and Shift-click selects a range. Then choose <b>Plot parameters...</b> and select the common X axis.</p>
<p>In the parameter-plot window, <b>Refresh</b> rereads the current result file, <b>Data...</b> changes the data set for the active panel, and <b>Plot options</b> controls panel layout, X axis, style and displayed parameters. Click a panel before changing its panel-specific settings.</p>
</section>
<section class="quick-start-section" id="helpConstraints">
<h3>Constraints</h3>
<p>Use this tab to add fit functions and parameter constraints that are not represented by the main theory controls. Define any custom values first in <b>Custom parameters</b>, then express the dependency under <b>Constraints</b>. Changes are included the next time the MSR is generated.</p>
<p><i>Example:</i> couple the magnetic field to the Larmor frequency. Add a custom parameter named <b>Bfield</b> in <b>Custom parameters</b>. Then under <b>Constraints</b>, choose <b>Frq</b> from the <b>Parameter</b> dropdown, type <b>gamma_mu * Bfield</b> into the <b>Function</b> field, and press <b>Add</b>.</p>
</section>
<section class="quick-start-section" id="helpT0Bg">
<h3>t<sub>0</sub> / background</h3>
<p>Use these expert controls when detector timing or background handling needs to differ from the normal defaults. Leave them unchanged for standard fits.</p>
</section>
<section class="quick-start-section" id="helpEditor">
<h3>MSR Editor</h3>
<p>The editor can be used as a full MSR editor. <b>GUI &rarr; MSR</b> replaces the visible MSR with a fresh document built from the current analysis settings, so the GUI is the source of the text.</p>
<p>Editing the text by hand makes the MSR <i>authoritative</i>: it is now the source of truth, and the lock icon changes to a closed padlock <svg class="editor-help-lock" viewBox="0 0 24 24" aria-hidden="true" focusable="false"><rect x="5" y="10" width="14" height="11" rx="2"></rect><path class="editor-lock-closed" d="M8 10V7a4 4 0 0 1 8 0v3"></path></svg> to show that the editor owns the document. While locked, <b>Fit</b> and <b>Plot</b> use this text as-is and GUI changes do not silently replace it. Choose <b>MSR &rarr; GUI</b> to copy recognized settings back into the GUI fields; this does not surrender ownership. Click the closed lock icon to unlock and return control to the GUI (an open padlock <svg class="editor-help-lock" viewBox="0 0 24 24" aria-hidden="true" focusable="false"><rect x="5" y="10" width="14" height="11" rx="2"></rect><path class="editor-lock-open" d="M8 10V7a4 4 0 0 1 7.6-1.8"></path></svg> means the GUI owns it, and the next GUI generation or fit may replace the document).</p>
<p>In Electron, use the File menu to open and save MSR files directly.</p>
</section>
<section class="quick-start-section" id="helpResults">
<h3>Results and diagnostics</h3>
<p>The Results tab keeps generated files, fit statistics and the full command log. The status bar provides the short state; click its state or message to open the run log immediately. Hover over shortened values to see them in full.</p>
</section>
<section class="quick-start-section" id="helpAbout">
<h3>About muSRFlow</h3>
<p><b>muSRFlow <span id="musrflowVersion">__MUSRFLOW_VERSION__</span></b> is a desktop and web workflow for musrfit.</p>
<p>Author: <a href="mailto:zaher.salman@psi.ch">Zaher Salman</a>. Copyright (C) 2026 Zaher Salman. GNU GPL version 3 or later.</p>
</section>
</main>
<footer class="quick-start-footer" id="quickStartFooter">
<span>Questions? Contact <a href="mailto:zaher.salman@psi.ch">Zaher Salman</a>.</span>
<span>Full user manual: <a href="https://musruser.psi.ch/muSRFlow/docs/" target="_blank" rel="noopener">muSRFlow docs</a>.</span>
</footer>
<script>
(function() {
function focusSection(sectionId) {
let body = document.getElementById("quickStartBody");
if (!body) return;
for (let section of body.querySelectorAll(".quick-start-section")) {
section.classList.remove("quick-start-section-active");
}
let target = document.getElementById(sectionId || "helpRuns");
if (!target) target = document.getElementById("helpRuns");
if (!target) return;
target.classList.add("quick-start-section-active");
setTimeout(function() {
target.scrollIntoView({ block: "start" });
}, 0);
}
var versionSpan = document.getElementById("musrflowVersion");
function setVersion(version) {
if (!versionSpan) return;
if (version) {
versionSpan.textContent = version;
} else if (versionSpan.textContent.indexOf("__MUSRFLOW_VERSION__") !== -1) {
versionSpan.textContent = "development build";
}
}
window.focusQuickStartSection = focusSection;
setVersion();
focusSection(window.location.hash ? window.location.hash.slice(1) : "helpRuns");
window.addEventListener("hashchange", function() {
focusSection(window.location.hash ? window.location.hash.slice(1) : "helpRuns");
});
if (typeof require === "function") {
try {
require("electron").ipcRenderer.on("quickStartSection", function(event, payload) {
focusSection(payload && payload.sectionId ? payload.sectionId : "helpRuns");
setVersion(payload && payload.version);
});
} catch (error) {
console.log("Could not attach Quick Start Electron channel:", error);
}
}
})();
</script>
</body>
</html>