82 lines
4.2 KiB
HTML
82 lines
4.2 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<title>TRIMSP-NL 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="helpLayers">
|
|
<h3>Layers and simulation</h3>
|
|
<ol>
|
|
<li>Choose the output folder and a descriptive file prefix.</li>
|
|
<li>Set the number of layers, then enter each composition, density, and thickness.</li>
|
|
<li>Select the projectile and define its energy, angle, spread, random-number generator, and seed.</li>
|
|
<li>Choose <b>Run simulation</b>. Progress and the current state remain visible in the status bar.</li>
|
|
</ol>
|
|
<p>Known material densities are filled automatically. A highlighted density is an estimate and should be checked before running.</p>
|
|
</section>
|
|
|
|
<section class="quick-start-section" id="helpScans">
|
|
<h3>Energy and parameter scans</h3>
|
|
<p>Enable the scan, select its parameter, and choose either a regular range or an explicit set of values. The summary reports the number of points and workers before the run starts.</p>
|
|
<p>Electron can run scan points in parallel. The thread setting is local to the computer and is intentionally not stored in configuration files or shared links. The web backend executes scan points sequentially.</p>
|
|
</section>
|
|
|
|
<section class="quick-start-section" id="helpResults">
|
|
<h3>Results and output files</h3>
|
|
<p>Profiles and layer fractions appear as scan points finish. Completed data are sorted by scan value, so parallel jobs may finish in any order without changing the final plots.</p>
|
|
<p>In the web application, use <b>Outputs</b> in the status bar to download the result archive and <b>Details</b> to inspect CGI and engine diagnostics.</p>
|
|
</section>
|
|
|
|
<section class="quick-start-section" id="helpAdvanced">
|
|
<h3>Advanced transport parameters</h3>
|
|
<p>These controls select collision, recoil, interaction-potential, and stopping-power models used by TRIM.SP-NL. Hover over a parameter name for its description and leave the defaults unchanged unless the simulation requires a specific model.</p>
|
|
<p>The reference panel identifies the underlying TRIM.SP literature and the preferred citation for published work.</p>
|
|
</section>
|
|
|
|
<section class="quick-start-section" id="helpSharing">
|
|
<h3>Sharing a setup</h3>
|
|
<p>The share button copies a link containing the current layers, projectile, scan, RNG, and advanced settings. Opening the link restores those inputs in the web application.</p>
|
|
<p>Output folders, file prefixes, worker counts, logs, and generated data are never included. The recipient chooses their own output location before running.</p>
|
|
</section>
|
|
</main>
|
|
|
|
<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 || 'helpLayers');
|
|
if (!target) target = document.getElementById('helpLayers');
|
|
if (!target) return;
|
|
target.classList.add('quick-start-section-active');
|
|
setTimeout(function() {
|
|
body.scrollTop = Math.max(0, target.offsetTop - 8);
|
|
}, 0);
|
|
}
|
|
|
|
focusSection(window.location.hash ? window.location.hash.slice(1) : 'helpLayers');
|
|
window.addEventListener('hashchange', function() {
|
|
focusSection(window.location.hash ? window.location.hash.slice(1) : 'helpLayers');
|
|
});
|
|
|
|
if (typeof require === 'function') {
|
|
try {
|
|
require('electron').ipcRenderer.on('quickStartSection', function(event, payload) {
|
|
focusSection(payload && payload.sectionId ? payload.sectionId : 'helpLayers');
|
|
});
|
|
} catch (error) {
|
|
console.log('Could not attach Quick Start Electron channel:', error);
|
|
}
|
|
}
|
|
})();
|
|
</script>
|
|
</body>
|
|
</html>
|