Clarify installation guides and retire obsolete CGI parity references
Put Windows and Linux setup, upgrades, and troubleshooting in dedicated manual chapters linked directly from the README. Separate user installation from maintainer packaging instructions and refresh generated HTML/PDF manuals. Remove stale checklist references and completed legacy gap descriptions while preserving relevant future workflow improvements and historical release notes.
This commit is contained in:
1 parent
a6981c494d
commit
01df50c3ac
48 files changed
+2562
-1171
No files matched your search
@@ -1,64 +1,65 @@
|
||||
# muSRFlow
|
||||
|
||||
muSRFlow is a desktop and web workflow for creating, editing, fitting,
|
||||
plotting, and inspecting musrfit MSR files. It wraps the `musrfit`,
|
||||
`musrview`, `msr2data`, and `dump_header` command-line tools, and provides
|
||||
interactive plotting of the fitted parameters across runs.
|
||||
muSRFlow makes fitting muSR spectra easier: create and edit MSR models, fit
|
||||
single runs or run series, inspect spectra, and plot fitted parameters.
|
||||
It is available as a desktop application and a web application.
|
||||
|
||||
Current release candidate: **1.0.0-rc.5**.
|
||||
|
||||
## Installation
|
||||
|
||||
**Start with the guide for your platform.** Packaged desktop applications do
|
||||
not require Node.js or npm.
|
||||
|
||||
| Platform | Instructions | ROOT and musrfit |
|
||||
| --- | --- | --- |
|
||||
| **Windows** | **[Install muSRFlow on Windows](docs/source/install-windows.rst)** | Included in the installer; WSL2 must be enabled first. |
|
||||
| **Linux** | **[Install muSRFlow on Linux](docs/source/install-linux.rst)** | Use a local installation or install the separate runtime. |
|
||||
| **Web** | Open your site's muSRFlow URL in a browser. | Runs on the server; no local installation. |
|
||||
|
||||
**Already using Windows?** Read the [existing-installation update steps](docs/source/install-windows.rst#existing-installations).
|
||||
Older runtimes need the Boost-header update as well as the refreshed application.
|
||||
The Windows guide also covers WSL startup errors, `wsl.exe ENOENT`, and missing
|
||||
`libCore.so`. Native macOS packages and Flatpak packages are not available yet.
|
||||
|
||||
Before your first desktop fit, choose a **Work directory** and **Data directory**
|
||||
in **File -> Preferences**. Keep your MSRs and results outside the application
|
||||
installation folder.
|
||||
|
||||
## User Manual
|
||||
|
||||
The end-user manual is built with [Sphinx](https://www.sphinx-doc.org/) from
|
||||
`docs/source` (reStructuredText). The built HTML and PDF live under
|
||||
`docs/_build`. Rebuild it with:
|
||||
- [Getting started](docs/source/getting-started.rst)
|
||||
- [Manual contents and workflow chapters](docs/source/index.rst)
|
||||
- [PDF manual](docs/_build/latex/muSRFlow.pdf)
|
||||
- [HTML manual](docs/_build/html/index.html) (open locally in a browser)
|
||||
- [Troubleshooting](docs/source/troubleshooting.rst)
|
||||
|
||||
## Development and Packaging
|
||||
|
||||
These instructions are for working on the source code or producing installers.
|
||||
For installation on a user's computer, use the platform guides above.
|
||||
|
||||
With Node.js and npm installed, run from the repository:
|
||||
|
||||
```bash
|
||||
cd docs
|
||||
make html # HTML in docs/_build/html
|
||||
make latexpdf # PDF at docs/_build/latex/muSRFlow.pdf
|
||||
```
|
||||
|
||||
## Desktop Development
|
||||
|
||||
Install [Node.js](https://nodejs.org/) and npm, then run:
|
||||
|
||||
```bash
|
||||
npm install
|
||||
npm ci
|
||||
npm start
|
||||
```
|
||||
|
||||
Dependencies only need to be installed once. Later sessions can be started with
|
||||
`npm start`.
|
||||
- [Build desktop packages and prepare releases](docs/DESKTOP_DEPLOYMENT.md)
|
||||
- [Build the ROOT + musrfit runtime](packaging/runtime/README.md)
|
||||
- [Windows WSL runtime packaging](packaging/wsl2/README.md)
|
||||
- [Roadmap and remaining work](TODO.md)
|
||||
- [Release notes](CHANGELOG.md)
|
||||
|
||||
## Desktop Packages
|
||||
|
||||
The desktop app is at version `1.0.0-rc.5` (release candidate). Linux RPM
|
||||
and AppImage release packages can be produced with:
|
||||
The manual uses Sphinx. Rebuild its HTML and PDF with:
|
||||
|
||||
```bash
|
||||
npm run dist:rpm
|
||||
npm run dist:appimage
|
||||
cd docs
|
||||
make html
|
||||
make latexpdf
|
||||
```
|
||||
|
||||
Each command also builds a matching standalone ROOT + musrfit runtime
|
||||
(`musrflow-runtime` rpm / AppImage); use `npm run dist:runtime` to build only
|
||||
the runtime artifacts. See [`docs/DESKTOP_DEPLOYMENT.md`](docs/DESKTOP_DEPLOYMENT.md)
|
||||
for build, runtime, and release requirements.
|
||||
|
||||
### Windows installation
|
||||
|
||||
The Windows x64 installer includes ROOT and musrfit in a WSL2 runtime.
|
||||
Install WSL first, then run `muSRFlow-<version>-x64.exe`; muSRFlow prepares
|
||||
its bundled runtime automatically on first launch. Node.js, npm, and a separate
|
||||
musrfit installation are not needed on the target PC.
|
||||
|
||||
Follow the [step-by-step Windows installation guide](docs/DESKTOP_DEPLOYMENT.md#installing-on-windows)
|
||||
for WSL setup, folder preferences, and the first Plot/Fit check. Windows
|
||||
packaging instructions are in [packaging/wsl2/README.md](packaging/wsl2/README.md).
|
||||
|
||||
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
|
||||
|
||||
The browser application consists of `index.html`, `quick-start.html`, `ZGUI.css`,
|
||||
|
||||
@@ -1,10 +1,11 @@
|
||||
# muSRFlow Roadmap and TODO
|
||||
|
||||
Last reviewed: 2026-09-23. Current version: `1.0.0-rc.5`.
|
||||
Current version: `1.0.0-rc.5`. Roadmap reviewed: 2026-09-23; documentation
|
||||
and obsolete checklist references cleaned up: 2026-10-28.
|
||||
|
||||
The `1.0` target is a stable set of documented workflows, not complete parity
|
||||
with every historical CGI option. Work is grouped below by release gate and by
|
||||
the larger workflow features needed for routine analysis.
|
||||
The `1.0` target is a stable set of documented, regression-tested workflows.
|
||||
Work is grouped below by release gate and by the larger workflow features
|
||||
needed for routine analysis. Historical delivery details are in `CHANGELOG.md`.
|
||||
|
||||
## 1. Version 1.0 release path
|
||||
|
||||
@@ -62,8 +63,6 @@ history, manual run files, compound `ADDRUN`, and multiple fit ranges.
|
||||
unexpectedly by the `musrfit -t` behavior.
|
||||
(`runMSRFileLocal` omits `-t` when the MSR carries an explicit title;
|
||||
`tests/electron-msr-title.test.js` covers the regression.)
|
||||
- [x] Audit `CGI_PARITY_CHECKLIST.md` against the current implementation and
|
||||
remove stale gap descriptions.
|
||||
- [x] Implement the first scan-detection and built-in plot-template tasks from
|
||||
section 2.
|
||||
|
||||
@@ -140,31 +139,19 @@ Deferred past `1.0` (explicitly documented as out of scope):
|
||||
- opt-in web usage collection (config + outcomes as JSONL) to build a corpus
|
||||
for training fitting models — design in
|
||||
`docs/WEB_USAGE_COLLECTION.md`, not yet implemented.
|
||||
- Low priority: reorder the parameter catalogue so physical parameters (`Asy`,
|
||||
`Frq`, `Lam`, `Sgm`/`Sig`, ...) precede phase (`Phi`) and detector counts
|
||||
(`No`/`NBg`) in the dropdown and thus in generated FITPARAMETER blocks.
|
||||
Preferred approach: a global parameter-priority list applied inside
|
||||
`cfgConstraints()` when building `funSel`, leaving each `theoryBlk` signature
|
||||
text untouched. (Reordering the names inside `theoryBlk` would also work but
|
||||
changes emitted THEORY text; `No`/`NBg` already sort last because they are
|
||||
appended only in SingleHist mode.)
|
||||
|
||||
The legacy CGI parity audit (formerly `CGI_PARITY_CHECKLIST.md`) is closed: the
|
||||
shared Electron/web codebase deliberately replaces the static CGI rather than
|
||||
mirroring it, and its intentional differences are documented under
|
||||
"Intentional Differences". Only the following optional legacy-CGI conveniences
|
||||
remain for evaluation after `1.0` (none block a supported workflow today):
|
||||
- header/log metadata extraction (`TITLE`/temperature/field/energy used as GUI
|
||||
defaults or result context, beyond the `_par.dat` scan metadata already used
|
||||
by the parameter plot);
|
||||
- legacy plotted-data ASCII/`gzip` spectrum dump alongside the ROOT/JSROOT
|
||||
plots;
|
||||
- the `LEM (PPC)`/`ROOT-PPC` legacy filename format;
|
||||
- the asymmetric positive-MINOS error field in the parameter table;
|
||||
- fixed Y PLOT limits as an editor-synchronized display option;
|
||||
- a full musrfit command/output viewer (floating console on the web, native
|
||||
child window in Electron);
|
||||
- a durable job manifest with retry/reopen for reproducibility.
|
||||
#### Optional workflow enhancements after 1.0
|
||||
|
||||
These are product improvements to evaluate, not gaps against the old CGI.
|
||||
Header-based initial guesses, scan metadata, and the modeless Run log already
|
||||
exist; extend them only where a concrete analysis workflow needs more.
|
||||
|
||||
- [ ] Export plotted spectra as ASCII, optionally compressed, alongside the
|
||||
existing ROOT/JSROOT plots.
|
||||
- [ ] Evaluate support for archived LEM PPC/ROOT-PPC data if users need it.
|
||||
- [ ] Expose asymmetric positive MINOS errors in the parameter table.
|
||||
- [ ] Synchronize fixed Y plot limits between the editor and GUI.
|
||||
- [ ] Add a durable job manifest with retry/reopen for reproducibility.
|
||||
|
||||
### `1.0.0-rc.1`: hardening
|
||||
|
||||
@@ -472,8 +459,9 @@ plot, editor, synchronization, and result-collection behavior.
|
||||
(delivered across `beta.3`/`beta.4`).
|
||||
2. The `1.0.0-rc.1` hardening gates are complete (preload bridge, CGI
|
||||
hardening, package and clean-web-deploy validation).
|
||||
3. Focus the remaining pre-`1.0` work on `beta.5` workflow completeness and then
|
||||
`1.0.0-rc.2` user validation.
|
||||
3. Validate the current release candidate with real analyses on Electron and
|
||||
the web, including clean installation and upgrade checks on Linux and
|
||||
Windows/WSLg. Resolve workflow regressions before the stable release.
|
||||
4. The model-expression tree is deferred past 1.0 (see `beta.4`); the current
|
||||
flat-component generation and the synchronization layer are the supported
|
||||
`1.0` model and are protected by fixtures.
|
||||
+88
-207
@@ -1,220 +1,106 @@
|
||||
# muSRFlow desktop deployment
|
||||
# Desktop Packaging and Releases
|
||||
|
||||
The first public beta is version `0.9.0-beta.1`.
|
||||
This guide is for maintainers building installers and preparing releases.
|
||||
**Installing muSRFlow on a user's computer? Start here:**
|
||||
|
||||
## Recommended Linux packages
|
||||
- [Windows installation, updates, and troubleshooting](source/install-windows.rst)
|
||||
- [Linux installation and runtime selection](source/install-linux.rst)
|
||||
|
||||
For PSI/Linux desktops, build an **RPM** first. muSRFlow intentionally launches
|
||||
host-installed `musrfit`, `musrview`, `msr2data`, and `dump_header`, and it must
|
||||
read normal experiment-data mounts and user-selected work directories. An RPM
|
||||
therefore matches the application model better than a sandboxed Flatpak.
|
||||
|
||||
An **AppImage** target is provided as a fallback for systems where RPM package
|
||||
requirements differ between distributions. Flatpak can be revisited later if
|
||||
we decide how host musrfit executables and data mounts should cross the sandbox.
|
||||
Application version comes from `package.json`; the current release candidate
|
||||
is `1.0.0-rc.5`. Target PCs do not need the developer tools described below.
|
||||
|
||||
## Build host
|
||||
|
||||
A release build requires Node.js/npm and network access the first time
|
||||
`electron-builder` is downloaded. Application dependencies should be installed
|
||||
from the lock file first:
|
||||
Install Node.js/npm and the dependencies from the lock file:
|
||||
|
||||
```bash
|
||||
npm ci
|
||||
```
|
||||
|
||||
Run the Electron-side tests and build an x86_64 RPM:
|
||||
Package builds run the Electron tests. The first build needs network access
|
||||
for Electron and electron-builder downloads. Runtime source builds need Docker
|
||||
or Podman; see the [runtime build guide](../packaging/runtime/README.md).
|
||||
|
||||
## Linux packages
|
||||
|
||||
```bash
|
||||
npm run dist:rpm
|
||||
npm run dist:rpm # application RPM and runtime artifacts
|
||||
npm run dist:appimage # application AppImage and runtime artifacts
|
||||
npm run dist:linux # both application formats and runtime artifacts
|
||||
```
|
||||
|
||||
Build the portable AppImage instead:
|
||||
Each command packages the lean application and the matching separate runtime
|
||||
artifact(s), plus the runtime download bundle. Build the scientific runtime
|
||||
first with `packaging/runtime/build.sh` if `runtime/` is not ready.
|
||||
|
||||
```bash
|
||||
npm run dist:appimage
|
||||
```
|
||||
| Artifact | Filename or directory |
|
||||
| --- | --- |
|
||||
| Application RPM | `dist/musrflow-<version>-x86_64.rpm` |
|
||||
| Application AppImage | `dist/muSRFlow-<version>-x86_64.AppImage` |
|
||||
| Runtime RPM | `dist/musrflow-runtime-<version>-x86_64.rpm` |
|
||||
| Runtime AppImage | `dist/musrflow-runtime-<version>-x86_64.AppImage` |
|
||||
| Offline runtime bundle | `dist/runtime-downloads/`, with `runtime-download.json`, archive, and checksum |
|
||||
|
||||
Or build both:
|
||||
|
||||
```bash
|
||||
npm run dist:linux
|
||||
```
|
||||
|
||||
Artifacts are written to `dist/` and include the package version in their file
|
||||
name. Each of these commands also builds the matching standalone runtime
|
||||
artifact (`musrflow-runtime-<version>-x86_64.rpm` and/or
|
||||
`muSRFlow-runtime-<version>-x86_64.AppImage`) plus a checksummed download bundle
|
||||
under `dist/runtime-downloads/`. `npm run dist:runtime` builds only the runtime
|
||||
artifacts. `npm run dist:runtime:archive` builds just the plain download archive
|
||||
and its JSON descriptor without needing the RPM/AppImage packaging tools.
|
||||
|
||||
## Target PC requirements
|
||||
|
||||
The packaged Electron application includes Electron and its JavaScript
|
||||
runtime; target PCs do **not** need Node.js or npm.
|
||||
|
||||
The musrfit toolchain is not bundled in the Linux app package. The target PC
|
||||
can either provide it system-wide:
|
||||
|
||||
```text
|
||||
musrfit
|
||||
musrview
|
||||
msr2data
|
||||
dump_header
|
||||
```
|
||||
|
||||
or install the standalone runtime that muSRFlow ships: the `musrflow-runtime`
|
||||
rpm, or the portable `muSRFlow-runtime` AppImage run with `--install`. Both
|
||||
place ROOT and musrfit in `/opt/musrflow/runtime`. muSRFlow looks in the
|
||||
configured **musrfit binaries** directory, a bundled runtime,
|
||||
`/opt/musrflow/runtime`, `/usr/local/bin`, and `/usr/bin`. The user
|
||||
must also have access to the experiment data tree configured under
|
||||
**File -> Preferences -> Data directory** and write access to the configured
|
||||
**Work directory**.
|
||||
|
||||
After installing on a new PC, the minimum smoke test is:
|
||||
|
||||
1. Start muSRFlow and check **Help -> About muSRFlow** for the expected version.
|
||||
2. Set Data and Work directories under **File -> Preferences**.
|
||||
3. Open one known run and confirm header-based frequency initialization.
|
||||
4. Run Plot, then Fit, and verify that `musrview`/`musrfit` start successfully.
|
||||
5. Open a parameter plot and refresh it after another fit.
|
||||
|
||||
## Installing an RPM
|
||||
|
||||
Use the native package manager where possible, for example:
|
||||
|
||||
```bash
|
||||
sudo dnf install ./dist/muSRFlow-1.0.0-rc.1-x86_64.rpm
|
||||
```
|
||||
|
||||
On RPM distributions with different package naming conventions, use the
|
||||
AppImage if the RPM dependency resolver rejects otherwise available Electron
|
||||
libraries.
|
||||
|
||||
## Running the AppImage
|
||||
|
||||
```bash
|
||||
chmod +x dist/muSRFlow-1.0.0-rc.1-x86_64.AppImage
|
||||
./dist/muSRFlow-1.0.0-rc.1-x86_64.AppImage
|
||||
```
|
||||
|
||||
## Installing the standalone runtime
|
||||
|
||||
On a machine without a system musrfit, install the ROOT + musrfit runtime that
|
||||
muSRFlow ships. Either install the rpm:
|
||||
|
||||
```bash
|
||||
sudo dnf install ./dist/musrflow-runtime-1.0.0-rc.1-x86_64.rpm
|
||||
```
|
||||
|
||||
or run the portable runtime AppImage, which copies the same tree into
|
||||
`/opt/musrflow/runtime`:
|
||||
|
||||
```bash
|
||||
chmod +x dist/muSRFlow-runtime-1.0.0-rc.1-x86_64.AppImage
|
||||
./dist/muSRFlow-runtime-1.0.0-rc.1-x86_64.AppImage --install
|
||||
```
|
||||
|
||||
Pass an optional directory to `--install` for a user-local prefix, and set
|
||||
`MUSRFLOW_RUNTIME_ROOT` to point muSRFlow at it. Without a runtime the app falls
|
||||
back to the host `musrfit` installation as before.
|
||||
|
||||
The plain runtime download can also be checked with its SHA-256 sidecar and
|
||||
extracted into a fresh user-writable directory, without administrator access or
|
||||
FUSE. Set `MUSRFLOW_RUNTIME_ROOT` to the extracted `runtime/` directory. See the
|
||||
[runtime packaging guide](../packaging/runtime/README.md#download-archive) for
|
||||
the archive layout and descriptor format. On Linux, **File -> Preferences ->
|
||||
Install runtime...** installs a downloaded bundle after confirmation and selects
|
||||
its verified tools. **Check tools** tests the saved tool selection. In-app online
|
||||
downloads and missing-tool startup prompts will follow separately; no runtime
|
||||
is downloaded automatically.
|
||||
|
||||
## Installing on Windows
|
||||
|
||||
The Windows package is for **64-bit Intel/AMD PCs**. Windows 11 is recommended;
|
||||
Windows 10 needs build 19044 or newer for WSLg, which displays the `musrview`
|
||||
plot windows. See [Microsoft's WSL GUI requirements](https://learn.microsoft.com/en-us/windows/wsl/tutorials/gui-apps).
|
||||
|
||||
The installer includes ROOT and musrfit inside a private WSL2 distribution.
|
||||
You do not need Node.js, npm, Ubuntu, or a separate musrfit installation.
|
||||
|
||||
1. **Install WSL.** Open PowerShell as Administrator and run:
|
||||
|
||||
```powershell
|
||||
wsl --install --no-distribution
|
||||
```
|
||||
|
||||
Restart Windows afterwards. If WSL is already installed, skip this step.
|
||||
`--no-distribution` leaves the Linux distribution installation to muSRFlow.
|
||||
|
||||
2. **Update and check WSL.** In administrator PowerShell, run:
|
||||
|
||||
```powershell
|
||||
wsl --update
|
||||
wsl --version
|
||||
```
|
||||
|
||||
Follow any restart instructions. The version output should include WSL
|
||||
and WSLg. Microsoft's [WSL command reference](https://learn.microsoft.com/en-us/windows/wsl/basic-commands)
|
||||
describes these commands.
|
||||
|
||||
3. **Install muSRFlow.** Copy `muSRFlow-<version>-x64.exe` from the release
|
||||
artifacts to the Windows PC and double-click it. For the current release
|
||||
candidate, the build output is `dist/muSRFlow-1.0.0-rc.5-x64.exe`.
|
||||
The runtime archive `muSRFlow-runtime-rootfs.tar.gz` is included in the
|
||||
installer; you do not need to extract or import it manually.
|
||||
|
||||
4. **Launch muSRFlow** from the Start menu using your normal Windows account.
|
||||
The first launch imports the runtime as `muSRFlow-runtime`. Preparation
|
||||
can take several minutes; Fit and Plot wait for it to finish. After setup,
|
||||
check in PowerShell:
|
||||
|
||||
```powershell
|
||||
wsl --list --verbose
|
||||
```
|
||||
|
||||
The list should contain `muSRFlow-runtime` with **VERSION 2**. Either
|
||||
`Running` or `Stopped` is normal when idle. The imported runtime is stored
|
||||
under `%LOCALAPPDATA%\muSRFlow\muSRFlow-runtime` for this Windows account.
|
||||
|
||||
5. **Configure your folders.** Create writable folders, for example
|
||||
`C:\Users\<your-name>\muSRFlow\work` and
|
||||
`C:\Users\<your-name>\muSRFlow\data`. In **File -> Preferences**, select
|
||||
them as **Work directory** and **Data directory**. Leave **musrfit binaries**
|
||||
and **musrfit startup XML** on automatic detection, then save. Use normal
|
||||
Windows paths in Preferences; muSRFlow translates them for WSL.
|
||||
|
||||
6. **Test Plot and Fit.** Select a known instrument, year, and run, then click
|
||||
**Plot**. If the data are missing locally, muSRFlow offers to download them
|
||||
from `musruser.psi.ch` when the server is reachable. Confirm that the
|
||||
spectrum window opens, then run **Fit** and check that the parameter table
|
||||
updates. Results are written to the selected Windows work directory.
|
||||
|
||||
If runtime preparation fails, check that WSL is installed and updated, restart
|
||||
muSRFlow, and retry the action. If the runtime is ready but no spectrum window
|
||||
opens, check WSLg using `wsl --version` and inspect the application command log.
|
||||
The [WSL runtime guide](../packaging/wsl2/README.md) describes manual import for
|
||||
debugging. The Linux **Install runtime...** preference is not used on Windows.
|
||||
|
||||
The setup flow is covered by automated tests with simulated WSL commands;
|
||||
installation and graphical plotting still need validation on a Windows PC.
|
||||
`npm run dist:runtime` builds only runtime artifacts.
|
||||
`npm run dist:runtime:archive` builds just the plain runtime download bundle
|
||||
without the RPM/AppImage packaging tools. The AppImage runtime builder needs
|
||||
the electron-builder AppImage cache; see the runtime guide for prerequisites.
|
||||
|
||||
## Building the Windows installer
|
||||
|
||||
On the build host, install application dependencies with `npm ci`, prepare
|
||||
the Linux `runtime/` tree, then build its WSL root filesystem and the installer:
|
||||
Prepare the validated Linux `runtime/` tree, then run:
|
||||
|
||||
```bash
|
||||
bash packaging/wsl2/build-wsl2.sh
|
||||
npm run dist:win
|
||||
```
|
||||
|
||||
The rootfs builder requires Docker or Podman. `dist:win` packages the existing
|
||||
`packaging/wsl2/out/muSRFlow-runtime-rootfs.tar.gz`; it does not rebuild that
|
||||
archive. Output is `dist/muSRFlow-<version>-x64.exe`. See the
|
||||
[WSL packaging guide](../packaging/wsl2/README.md#packaging) for details.
|
||||
The rootfs builder uses Docker or Podman and includes the distribution libraries
|
||||
and Boost headers needed for plotting. It checks executable startup and ROOT
|
||||
plotting-header loading before exporting
|
||||
`packaging/wsl2/out/muSRFlow-runtime-rootfs.tar.gz`.
|
||||
|
||||
`dist:win` packages the existing archive; it does not rebuild it. The result is
|
||||
`dist/muSRFlow-<version>-x64.exe`, including both the app and the WSL2 runtime.
|
||||
See [WSL packaging](../packaging/wsl2/README.md) for implementation details.
|
||||
|
||||
**Existing Windows installations keep their imported runtime.** Link users to
|
||||
[the Windows update instructions](source/install-windows.rst#existing-installations)
|
||||
when distributing a runtime-related fix; reinstalling the app alone does not
|
||||
update that distribution.
|
||||
|
||||
## Release validation
|
||||
|
||||
1. Run `npm test` with the required scientific tools available. Record any
|
||||
environment-dependent checks that could not be exercised.
|
||||
2. Install each package on its target OS. Check the version in **Help -> About**.
|
||||
3. Follow the platform installation guide, including runtime setup and separate
|
||||
work/data directories.
|
||||
4. Exercise Plot, Fit, FFT, series/global fitting, parameter plotting, and MSR
|
||||
editing with known data. Confirm parameter feedback and result files.
|
||||
5. Test upgrades of existing installations as well as a fresh installation.
|
||||
Windows testing must include an interactive WSLg spectrum window.
|
||||
|
||||
Linux-container tests have exercised the Windows runtime's tools, a real fit,
|
||||
and PNG generation. Those tests do not replace interactive Windows testing.
|
||||
|
||||
## Installation links retained for older references
|
||||
|
||||
### Installing on Windows
|
||||
|
||||
The complete user guide is now [Windows installation](source/install-windows.rst).
|
||||
|
||||
### Installing an RPM
|
||||
|
||||
See [Linux application installation](source/install-linux.rst#install-the-application).
|
||||
|
||||
### Running the AppImage
|
||||
|
||||
See [Linux application installation](source/install-linux.rst#install-the-application).
|
||||
|
||||
### Installing the standalone runtime
|
||||
|
||||
See [Linux runtime setup](source/install-linux.rst#set-up-root-and-musrfit).
|
||||
|
||||
## Configuration link scheme
|
||||
|
||||
@@ -248,23 +134,18 @@ run controls, running the plot when `action=plot` is present.
|
||||
Electron reports it through `app.getVersion()` and the About dialog.
|
||||
`package-lock.json` should carry the same version.
|
||||
|
||||
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:
|
||||
For a version change, update `package.json`, `package-lock.json`,
|
||||
`tests/release-packaging.test.js`, and `CHANGELOG.md` together. Run the tests,
|
||||
rebuild the manuals and installers, and commit before tagging the release.
|
||||
Check the remaining release gates in [TODO.md](../TODO.md) before tagging 1.0.
|
||||
|
||||
```bash
|
||||
npm version 1.0.0-rc.1 --no-git-tag-version
|
||||
npm test
|
||||
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 release candidate has been
|
||||
exercised on the actual target Linux installations.
|
||||
`npm run checksums` produces MD5/SHA-256 sidecars for top-level RPM and AppImage
|
||||
artifacts. It does not cover Windows installers. For a Windows release, generate
|
||||
and publish a SHA-256 checksum for the actual installer as well. Runtime download
|
||||
bundles include their own SHA-256 sidecar and descriptor.
|
||||
|
||||
## Application icon
|
||||
|
||||
The repository currently does not contain a packaged application icon. The
|
||||
RPM/AppImage can be built and tested without one, but a final muSRFlow icon
|
||||
should be added before the 1.0 release and referenced from the electron-builder
|
||||
Linux configuration.
|
||||
Linux packages use `assets/musrflow-icon.png` through the electron-builder
|
||||
configuration in `package.json`. Windows packaging currently uses the default
|
||||
Electron icon; a Windows-specific icon remains a packaging improvement.
|
||||
+33
-106
@@ -1,138 +1,65 @@
|
||||
Getting started
|
||||
===============
|
||||
|
||||
Prerequisites
|
||||
-------------
|
||||
Choose your edition
|
||||
-------------------
|
||||
|
||||
muSRFlow wraps external ``musrfit`` tools. How they are supplied depends on
|
||||
the edition:
|
||||
* **Windows desktop:** follow :doc:`install-windows`. ROOT and musrfit are
|
||||
included in a WSL2 runtime. The guide covers first installation, existing
|
||||
runtime updates, and Windows-specific errors.
|
||||
* **Linux desktop:** follow :doc:`install-linux`. Use an existing musrfit
|
||||
installation or install the separate runtime through Preferences.
|
||||
* **Web:** open your site's muSRFlow URL, for example
|
||||
``http://musruser.psi.ch/muSRFlow/``. The server runs the tools; there is
|
||||
nothing to install on your computer.
|
||||
|
||||
* Linux desktop: use a local musrfit installation or install the separate
|
||||
ROOT + musrfit runtime. Select the tools through **File / Preferences**.
|
||||
* Windows desktop: the installer includes ROOT and musrfit in a WSL2 runtime.
|
||||
Install WSL first, following :ref:`windows-installation` below.
|
||||
* Web: the tools are installed on the server that hosts the CGI runner.
|
||||
|
||||
Packaged desktop applications do not require Node.js or npm on the target
|
||||
PC. The browser edition needs no local installation at all.
|
||||
Packaged desktop applications do not require Node.js or npm.
|
||||
|
||||
.. _desktop-installation:
|
||||
|
||||
Development and Linux packages
|
||||
------------------------------
|
||||
Desktop installation
|
||||
--------------------
|
||||
|
||||
From a checkout, with `Node.js <https://nodejs.org/>`_ and npm installed:
|
||||
The complete instructions are in :doc:`install-windows` and
|
||||
:doc:`install-linux`. Choose work and data folders in **File / Preferences**
|
||||
before your first analysis. Keep work files outside the application
|
||||
installation directory.
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ npm install
|
||||
$ npm start
|
||||
|
||||
`npm install` is only needed once; later sessions start with `npm start`.
|
||||
|
||||
Release packages (Linux RPM and AppImage) are produced with:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ npm run dist:rpm
|
||||
$ npm run dist:appimage
|
||||
|
||||
Each command also builds the matching standalone ROOT + musrfit runtime
|
||||
artifact (``musrflow-runtime`` rpm / AppImage); ``npm run dist:runtime`` builds
|
||||
only the runtime. The build and runtime requirements are described in
|
||||
``docs/DESKTOP_DEPLOYMENT.md``.
|
||||
|
||||
.. _windows-installation:
|
||||
.. _getting-started-windows-installation:
|
||||
|
||||
Windows installation
|
||||
--------------------
|
||||
|
||||
Use a 64-bit Intel/AMD Windows PC. Windows 11 is recommended; Windows 10
|
||||
requires build 19044 or newer for WSLg, which displays the ``musrview``
|
||||
windows. See `Microsoft's WSL GUI requirements
|
||||
<https://learn.microsoft.com/en-us/windows/wsl/tutorials/gui-apps>`_.
|
||||
|
||||
1. Open **PowerShell as Administrator** and install WSL:
|
||||
|
||||
.. code-block:: powershell
|
||||
|
||||
wsl --install --no-distribution
|
||||
|
||||
Restart Windows afterwards. Skip this step if WSL is already installed.
|
||||
You do not need Ubuntu: muSRFlow supplies its own distribution.
|
||||
|
||||
2. Update WSL and check its components in administrator PowerShell:
|
||||
|
||||
.. code-block:: powershell
|
||||
|
||||
wsl --update
|
||||
wsl --version
|
||||
|
||||
Follow any restart instructions. The output should include WSL and WSLg.
|
||||
See the `Microsoft WSL command reference
|
||||
<https://learn.microsoft.com/en-us/windows/wsl/basic-commands>`_.
|
||||
|
||||
3. Copy the release installer ``muSRFlow-<version>-x64.exe`` to Windows and
|
||||
double-click it. It includes ``muSRFlow-runtime-rootfs.tar.gz``; there is
|
||||
no separate ROOT or musrfit installation or manual archive import.
|
||||
|
||||
4. Launch muSRFlow from the Start menu using your normal Windows account.
|
||||
The first launch prepares the runtime, which can take several minutes.
|
||||
Fit and Plot wait until preparation finishes. Afterwards, verify:
|
||||
|
||||
.. code-block:: powershell
|
||||
|
||||
wsl --list --verbose
|
||||
|
||||
The list should contain ``muSRFlow-runtime`` with **VERSION 2**.
|
||||
``Running`` and ``Stopped`` are both normal when idle.
|
||||
|
||||
5. Create writable work and data folders, for example
|
||||
``C:\Users\<your-name>\muSRFlow\work`` and
|
||||
``C:\Users\<your-name>\muSRFlow\data``. Choose them in
|
||||
**File / Preferences**. Leave **musrfit binaries** and
|
||||
**musrfit startup XML** on automatic detection, then save.
|
||||
Enter Windows paths; muSRFlow translates them for WSL.
|
||||
|
||||
6. Select a known instrument, year, and run, then press **Plot**. If data
|
||||
are missing, muSRFlow offers to download them from ``musruser.psi.ch``
|
||||
when the server is reachable. Confirm the spectrum window opens, then
|
||||
try **Fit** and check that the parameter table updates. Results stay in
|
||||
your Windows work directory.
|
||||
|
||||
If setup fails, check WSL, restart muSRFlow, and retry. If plotting fails
|
||||
after setup, check that ``wsl --version`` includes WSLg and inspect the
|
||||
command log. The Linux **Install runtime...** preference does not apply to
|
||||
Windows. Installation and graphical plotting still need validation on a
|
||||
Windows PC; automated setup tests use simulated WSL commands.
|
||||
The Windows instructions have their own chapter: :doc:`install-windows`.
|
||||
It also contains the update steps for older WSL runtimes.
|
||||
|
||||
Running the desktop app
|
||||
-----------------------
|
||||
|
||||
When the window opens, the **Runs** tab is active and the current year is
|
||||
already selected. Enter run numbers, choose a model, and press **Fit**. The
|
||||
first fit writes the working files next to your MSR document and results
|
||||
appear in the **Results** tab.
|
||||
When the window opens, the **Runs** tab is active. Choose the instrument,
|
||||
year, and run numbers, check the model, and press **Plot** to inspect the
|
||||
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.
|
||||
|
||||
Opening the web edition
|
||||
-----------------------
|
||||
|
||||
Point your browser at the deployment URL (e.g.
|
||||
``http://musruser.psi.ch/muSRFlow/``). Instrument options and run numbers are
|
||||
the ones the server data tree supports. There is nothing to install; the
|
||||
parameter table is also served from the same data tree.
|
||||
Open the deployment URL in your browser. Instrument options and available
|
||||
run data depend on that site's server configuration. Fit and Plot run on
|
||||
the server; output files can be opened from the result links.
|
||||
|
||||
The Quick Start guide
|
||||
---------------------
|
||||
|
||||
The ``?`` button at the right of the tab bar opens a short, tab-aware guide.
|
||||
On the desktop it opens in an independent window; in the browser it opens a
|
||||
modeless dialog next to the main window. Each of its sections corresponds to
|
||||
one tab and is expanded into a chapter of this manual.
|
||||
modeless dialog next to the main window. The full workflow chapters follow
|
||||
the installation guides in this manual.
|
||||
|
||||
Support
|
||||
-------
|
||||
|
||||
For questions and bug reports contact Zaher Salman
|
||||
`<zaher.salman@psi.ch>`_. Issue tracking is linked from the project
|
||||
repository.
|
||||
For questions and bug reports, include the version and run log and contact
|
||||
`Zaher Salman <mailto:zaher.salman@psi.ch>`_. See :doc:`troubleshooting`
|
||||
for common workflow problems.
|
||||
+6
-1
@@ -7,6 +7,9 @@ application and as a browser application, and both editions wrap the same set
|
||||
of command-line tools (``musrfit``, ``musrview``, ``msr2data``, and
|
||||
``dump_header``).
|
||||
|
||||
Start with :doc:`install-windows` or :doc:`install-linux` for desktop setup.
|
||||
For the browser edition, see :doc:`getting-started`.
|
||||
|
||||
These pages describe the end-user workflow. They are organised around the
|
||||
main window tabs, mirroring the Quick Start help that is built into the
|
||||
application (the ``?`` button).
|
||||
@@ -17,6 +20,8 @@ application (the ``?`` button).
|
||||
|
||||
overview
|
||||
getting-started
|
||||
install-windows
|
||||
install-linux
|
||||
runs-fitting
|
||||
parameters-plots
|
||||
constraints
|
||||
@@ -33,6 +38,6 @@ application (the ``?`` button).
|
||||
If anything in this manual does not match the behaviour you see, contact
|
||||
`Zaher Salman <mailto:zaher.salman@psi.ch>`_.
|
||||
|
||||
Separate repository documents cover desk build and packaging
|
||||
Separate repository documents cover desktop builds and packaging
|
||||
(``docs/DESKTOP_DEPLOYMENT.md``) and the web-server/CGI deployment
|
||||
(``cgi/README.md``); this manual concentrates on using the application.
|
||||
+135
@@ -0,0 +1,135 @@
|
||||
.. _linux-installation:
|
||||
|
||||
Linux installation
|
||||
==================
|
||||
|
||||
Install the muSRFlow application, then select a working ROOT + musrfit
|
||||
installation. **The Linux application package does not include the scientific
|
||||
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
|
||||
commands from the folder containing the downloaded files.
|
||||
|
||||
Install the application
|
||||
-----------------------
|
||||
|
||||
Choose one application format.
|
||||
|
||||
RPM
|
||||
~~~
|
||||
|
||||
On an RPM-based distribution with dnf:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
sudo dnf install ./musrflow-1.0.0-rc.5-x86_64.rpm
|
||||
musrflow
|
||||
|
||||
On other RPM systems, use the distribution's package manager. The application
|
||||
RPM filename starts with lowercase ``musrflow``.
|
||||
|
||||
AppImage
|
||||
~~~~~~~~
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
chmod +x muSRFlow-1.0.0-rc.5-x86_64.AppImage
|
||||
./muSRFlow-1.0.0-rc.5-x86_64.AppImage
|
||||
|
||||
The application AppImage filename starts with ``muSRFlow``. It requires a
|
||||
compatible Linux desktop and AppImage/FUSE support. If it cannot start,
|
||||
check the terminal output or use the RPM on a supported RPM distribution.
|
||||
|
||||
Set up ROOT and musrfit
|
||||
-----------------------
|
||||
|
||||
Use an existing installation
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Open **File / Preferences**. Leave **musrfit binaries** on automatic detection
|
||||
for a standard installation, or choose the directory containing ``musrfit``,
|
||||
``musrview``, ``msr2data``, ``musrt0``, and ``dump_header``. Save your settings,
|
||||
then use **Check tools** to verify the saved selection.
|
||||
|
||||
Install the separate runtime from a local bundle
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
1. Obtain the runtime bundle for your architecture. Keep
|
||||
``runtime-download.json`` and its matching ``musrflow-runtime-*.tar.gz``
|
||||
archive in the same folder. You do not need to unpack it.
|
||||
2. Open **File / Preferences / Install runtime...** and select
|
||||
``runtime-download.json``.
|
||||
3. Review the versions and destination, then select **Install and use**.
|
||||
muSRFlow validates the archive, installs it in your personal application
|
||||
data directory, and selects its tools.
|
||||
4. Use **Check tools** to confirm the selected runtime starts.
|
||||
|
||||
This installation does not require administrator access. Runtime downloads
|
||||
are not automatic: obtain the bundle separately before opening the installer.
|
||||
A compatible Linux system and desktop/display services are still required.
|
||||
|
||||
Alternative: system runtime RPM
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
sudo dnf install ./musrflow-runtime-1.0.0-rc.5-x86_64.rpm
|
||||
|
||||
This installs the runtime into ``/opt/musrflow/runtime``, which muSRFlow
|
||||
recognizes automatically when no explicit tool directory takes precedence.
|
||||
|
||||
Alternative: runtime AppImage
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
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"
|
||||
|
||||
Launch the application with the installed runtime selected:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
MUSRFLOW_RUNTIME_ROOT="$HOME/.local/share/musrflow/runtime" musrflow
|
||||
|
||||
For the application AppImage, replace ``musrflow`` in that command with its
|
||||
path. Leave **musrfit binaries** on automatic detection so the selected
|
||||
runtime is used. Without a custom destination, the runtime AppImage installs
|
||||
to ``/opt/musrflow/runtime`` and needs permission to write there. Its filename
|
||||
is lowercase ``musrflow-runtime``, unlike the application AppImage.
|
||||
|
||||
Choose folders and test
|
||||
-----------------------
|
||||
|
||||
1. In **File / Preferences**, choose a writable **Work directory** outside
|
||||
the application installation folder, for example ``~/muSRFlow/work``.
|
||||
Use **Browse...** to select it.
|
||||
2. Set **Data directory** to the root of your instrument data tree, or to a
|
||||
writable folder such as ``~/muSRFlow/data`` for downloaded runs.
|
||||
3. Leave **musrfit startup XML** on automatic detection unless you have a
|
||||
specific installation configuration, then save.
|
||||
4. Select a known instrument, year, and run. Click **Plot**, then **Fit**.
|
||||
Confirm the spectrum opens, fitted parameters update, and output files
|
||||
appear in your work directory. Missing runs can be downloaded from
|
||||
``musruser.psi.ch`` after confirmation when the server is reachable.
|
||||
|
||||
Updating and troubleshooting
|
||||
----------------------------
|
||||
|
||||
* Upgrade the application RPM with your package manager, or replace the
|
||||
application AppImage. The separate runtime is not updated by an app upgrade.
|
||||
* Preserve work files outside the application/runtime installation directories.
|
||||
* For missing tools or shared libraries, run **Check tools** and inspect the
|
||||
reported executable paths. A configured binaries directory overrides
|
||||
automatic detection; clear an obsolete selection or choose the correct one.
|
||||
* If fitting works but no spectrum window opens, inspect the run log and
|
||||
confirm your desktop session can display native musrview windows.
|
||||
* If data are missing, check the instrument, year, run number, and data root.
|
||||
Downloaded files use the selected writable data root or the personal
|
||||
fallback folder reported in Preferences.
|
||||
|
||||
Include the application version and run log when reporting a problem.
|
||||
+193
@@ -0,0 +1,193 @@
|
||||
.. _windows-installation:
|
||||
|
||||
Windows installation
|
||||
====================
|
||||
|
||||
The Windows installer includes muSRFlow, ROOT, and musrfit. Install WSL2
|
||||
first; muSRFlow prepares its own Linux runtime on first launch. You do not
|
||||
need Node.js, npm, Ubuntu, or a separate ROOT/musrfit installation.
|
||||
|
||||
Already installed muSRFlow? Read `Existing installations`_ as well: updating
|
||||
the application does not update an already imported WSL runtime.
|
||||
|
||||
Before you start
|
||||
----------------
|
||||
|
||||
* Use a **64-bit Intel/AMD PC**. The current package is x64.
|
||||
* 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``.
|
||||
|
||||
**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.
|
||||
|
||||
See `Microsoft's WSL GUI requirements
|
||||
<https://learn.microsoft.com/en-us/windows/wsl/tutorials/gui-apps>`_ for the
|
||||
Windows prerequisites.
|
||||
|
||||
Install step by step
|
||||
--------------------
|
||||
|
||||
1. **Install WSL.** Open **PowerShell as Administrator** and run:
|
||||
|
||||
.. code-block:: powershell
|
||||
|
||||
wsl --install --no-distribution
|
||||
|
||||
**Restart Windows afterwards.** Skip this step if WSL is already installed.
|
||||
muSRFlow supplies its own distribution, so Ubuntu is not required.
|
||||
|
||||
2. **Update and check WSL.** In administrator PowerShell, run:
|
||||
|
||||
.. code-block:: powershell
|
||||
|
||||
wsl --update
|
||||
wsl --version
|
||||
|
||||
Follow any restart instructions. The output should include WSL and WSLg.
|
||||
These commands are described in the `Microsoft WSL command reference
|
||||
<https://learn.microsoft.com/en-us/windows/wsl/basic-commands>`_.
|
||||
|
||||
3. **Install muSRFlow.** Double-click the Windows installer and complete setup.
|
||||
The runtime archive ``muSRFlow-runtime-rootfs.tar.gz`` is included; do not
|
||||
extract or import it manually for a normal installation.
|
||||
|
||||
4. **Launch muSRFlow** from the Start menu using your normal Windows account.
|
||||
First launch imports the runtime as ``muSRFlow-runtime`` and can take
|
||||
several minutes. Fit and Plot wait until preparation finishes. Afterwards,
|
||||
verify in PowerShell:
|
||||
|
||||
.. code-block:: powershell
|
||||
|
||||
wsl --list --verbose
|
||||
|
||||
The list should contain ``muSRFlow-runtime`` with **VERSION 2**.
|
||||
``Running`` and ``Stopped`` are both normal when idle. The runtime is
|
||||
stored under ``%LOCALAPPDATA%\muSRFlow\muSRFlow-runtime`` for this account.
|
||||
|
||||
5. **Choose work and data folders before fitting.** Create folders such as:
|
||||
|
||||
.. code-block:: text
|
||||
|
||||
C:\Users\<your-name>\muSRFlow\work
|
||||
C:\Users\<your-name>\muSRFlow\data
|
||||
|
||||
In **File / Preferences**, select them as **Work directory** and
|
||||
**Data directory**. Leave **musrfit binaries** and **musrfit startup XML**
|
||||
on automatic detection, then save. Enter normal Windows paths; muSRFlow
|
||||
translates them for WSL.
|
||||
|
||||
Use a work folder outside the application installation directory. The
|
||||
default ``.`` can resolve to the installation folder and place your
|
||||
results among files managed by the installer.
|
||||
|
||||
6. **Try Plot, then Fit.** Select a known instrument, year, and run. Click
|
||||
**Plot** and confirm that the spectrum window opens. Missing run data
|
||||
can be downloaded from ``musruser.psi.ch`` after confirmation when the
|
||||
server is reachable. Then click **Fit**, check that the parameter table
|
||||
updates, and inspect the generated files in your work directory.
|
||||
|
||||
Existing installations
|
||||
----------------------
|
||||
|
||||
1. Preserve any MSR/data/result files currently stored inside the muSRFlow
|
||||
installation folder: move them to a separate work folder before upgrading.
|
||||
2. Close muSRFlow and install the refreshed Windows application.
|
||||
3. If your runtime was imported from an older bundle, add the missing Boost
|
||||
headers from PowerShell:
|
||||
|
||||
.. code-block:: powershell
|
||||
|
||||
wsl -d muSRFlow-runtime -- dnf -y install boost-devel
|
||||
|
||||
This needs access to the distribution's package repositories. ROOT uses
|
||||
these headers when loading musrview plotting classes. Fresh runtimes
|
||||
from the corrected installer already include them.
|
||||
4. Reopen muSRFlow, select your work directory in Preferences, and retry Plot
|
||||
and Fit.
|
||||
|
||||
Reinstalling the application preserves an existing ``muSRFlow-runtime``
|
||||
distribution, so the application update alone does not add those headers.
|
||||
The command above repairs it in place; do not unregister the distribution
|
||||
as part of this update. The Linux **Install runtime...** preference is not
|
||||
used on Windows.
|
||||
|
||||
Troubleshooting
|
||||
---------------
|
||||
|
||||
Required feature is not installed
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
For ``HCS_E_SERVICE_NOT_AVAILABLE`` during runtime preparation, Windows
|
||||
could not create the WSL virtual machine. In **administrator PowerShell**:
|
||||
|
||||
.. code-block:: powershell
|
||||
|
||||
dism.exe /online /enable-feature /featurename:VirtualMachinePlatform /all /norestart
|
||||
|
||||
Restart Windows. Check **Task Manager / Performance / CPU** for
|
||||
**Virtualization: Enabled**; if disabled, enable hardware virtualization in
|
||||
BIOS/UEFI. If Windows itself is a virtual machine, its host must expose nested
|
||||
virtualization. If the error persists, check the boot setting:
|
||||
|
||||
.. code-block:: powershell
|
||||
|
||||
bcdedit /enum | findstr -i hypervisorlaunchtype
|
||||
|
||||
Only if it reports ``Off``, enable it and restart:
|
||||
|
||||
.. code-block:: powershell
|
||||
|
||||
bcdedit /set hypervisorlaunchtype Auto
|
||||
|
||||
See `Microsoft's WSL troubleshooting guide
|
||||
<https://learn.microsoft.com/en-us/windows/wsl/troubleshooting>`_.
|
||||
|
||||
Cannot find wsl.exe
|
||||
~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
For ``spawn wsl.exe ENOENT``, first check that ``wsl --version`` works in
|
||||
PowerShell. If it does, install the refreshed muSRFlow build: early rc.5
|
||||
builds incorrectly replaced the Windows executable search path. Also check
|
||||
that the selected work directory exists and is writable.
|
||||
|
||||
Cannot load libCore.so
|
||||
~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Install the refreshed muSRFlow build. It passes the ROOT library directory
|
||||
inside WSL for every bundled command. Setting a Windows ``ROOTSYS`` or
|
||||
``LD_LIBRARY_PATH`` is not a substitute for this launcher fix.
|
||||
|
||||
Missing boost/version.hpp or plotting crash
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Follow `Existing installations`_ to install ``boost-devel`` in an older
|
||||
runtime. The corrected runtime includes it. If plotting still crashes,
|
||||
include the full command output when reporting the problem.
|
||||
|
||||
No spectrum window appears
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Confirm that ``wsl --version`` lists WSLg, update WSL, and inspect the
|
||||
muSRFlow run log. Successful runtime import or a successful fit alone does
|
||||
not verify interactive graphics support.
|
||||
|
||||
Reporting a problem
|
||||
~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Include the muSRFlow version, full run log, and the output of:
|
||||
|
||||
.. code-block:: powershell
|
||||
|
||||
wsl --version
|
||||
wsl --status
|
||||
wsl --list --verbose
|
||||
|
||||
The corrected runtime has completed a real fit and generated a PNG in a
|
||||
Linux container. Interactive Windows/WSLg plotting still needs validation
|
||||
on the target PC.
|
||||
+10
-21
@@ -38,28 +38,17 @@ the command-line tools live.
|
||||
Bundled ROOT and musrfit
|
||||
------------------------
|
||||
|
||||
Packaged desktop builds can use a self-contained ROOT + musrfit runtime, so a
|
||||
separate musrfit installation is not required on the machine. The runtime may
|
||||
be bundled inside the application or, on Linux, installed separately (the
|
||||
``musrflow-runtime`` rpm or the portable ``muSRFlow-runtime`` AppImage, both
|
||||
defaulting to ``/opt/musrflow/runtime``). When a runtime is found muSRFlow runs
|
||||
those tools with ``ROOTSYS``, ``MUSRFITPATH``, and ``LD_LIBRARY_PATH`` pointed
|
||||
at it; a directory set in **Preferences / musrfit binaries** still takes
|
||||
precedence, and on builds without a runtime the system installation is used
|
||||
exactly as before. The runtime is built with ``packaging/runtime/build.sh`` and
|
||||
packaged with ``packaging/runtime/build-runtime-rpm.sh`` /
|
||||
``build-runtime-appimage.sh`` (see ``packaging/runtime/README.md``).
|
||||
On Linux, the application and scientific runtime are separate. Use an
|
||||
existing ROOT + musrfit installation, install an offline runtime bundle in
|
||||
Preferences, or install the system runtime RPM/AppImage. An explicitly
|
||||
selected binaries directory takes precedence over automatic detection.
|
||||
See :doc:`install-linux` for installation and tool checks.
|
||||
|
||||
On Windows the bundled runtime runs inside a WSL2 distribution that muSRFlow
|
||||
ships: the tools are invoked through ``wsl.exe`` and file paths are translated
|
||||
between the Windows and WSL forms, so inputs and outputs stay on the Windows
|
||||
side. The rootfs is built with ``packaging/wsl2/build-wsl2.sh`` and imported
|
||||
once per user (see ``packaging/wsl2/README.md``).
|
||||
|
||||
Follow :ref:`windows-installation` for the WSL setup, Windows installer,
|
||||
folder preferences, and first Plot/Fit check. The Windows installer includes
|
||||
``muSRFlow-runtime-rootfs.tar.gz`` and imports it automatically; the separate
|
||||
Linux runtime archive and **Install runtime...** preference do not apply.
|
||||
On Windows, the application installer includes the runtime. It runs inside
|
||||
a WSL2 distribution named ``muSRFlow-runtime``. Tools are invoked through
|
||||
``wsl.exe``, with paths translated so inputs and outputs stay on the Windows
|
||||
side. The separate Linux runtime installer does not apply to Windows.
|
||||
See :doc:`install-windows` for WSL setup, installation, updates, and fixes.
|
||||
|
||||
The workflow chapters of this manual apply to both editions. Where a step is
|
||||
specific to one edition (handling files, Preferences), the text says so
|
||||
|
||||
+9
-1
@@ -7,7 +7,9 @@ configuration and never exposes this dialog.
|
||||
|
||||
Work directory
|
||||
Where generated files, MSR documents, and result artifacts are written.
|
||||
Defaults to the current directory (``.``).
|
||||
Defaults to the current directory (``.``), which can be the application
|
||||
installation folder. Choose a separate writable work folder before fitting
|
||||
so application upgrades do not affect your results.
|
||||
|
||||
Data directory
|
||||
The root of the instrument data tree (for example
|
||||
@@ -44,6 +46,12 @@ musrfit binaries
|
||||
sessions, while the web edition takes its tools from the server and never
|
||||
exposes this field.
|
||||
|
||||
Runtime installation and checks (Linux)
|
||||
**Check tools** checks the saved tool selection. **Install runtime...**
|
||||
installs a local runtime bundle after confirmation and selects its tools.
|
||||
See :doc:`install-linux` for the required files and installation steps.
|
||||
Windows uses its bundled WSL runtime instead; see :doc:`install-windows`.
|
||||
|
||||
musrfit threads
|
||||
The number of OpenMP threads passed to a local ``musrfit`` run (``-u``).
|
||||
Leave it blank to let musrfit use every available core. Set a lower
|
||||
|
||||
@@ -1,6 +1,10 @@
|
||||
Troubleshooting
|
||||
===============
|
||||
|
||||
For Windows setup, WSL startup errors, missing ROOT libraries, and older
|
||||
runtime updates, see :doc:`install-windows`. For Linux package/runtime setup,
|
||||
see :doc:`install-linux`. The sections below cover analysis workflows.
|
||||
|
||||
Fit or plot will not start
|
||||
--------------------------
|
||||
|
||||
|
||||
+2
@@ -46,6 +46,8 @@
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="overview.html">Overview</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="getting-started.html">Getting started</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="install-windows.html">Windows installation</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="install-linux.html">Linux installation</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="runs-fitting.html">Runs and fitting</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="parameters-plots.html">Parameters and parameter plots</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="constraints.html">Constraints</a></li>
|
||||
|
||||
Vendored
+2
@@ -46,6 +46,8 @@
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="overview.html">Overview</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="getting-started.html">Getting started</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="install-windows.html">Windows installation</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="install-linux.html">Linux installation</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="runs-fitting.html">Runs and fitting</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="parameters-plots.html">Parameters and parameter plots</a></li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">Constraints</a><ul>
|
||||
|
||||
Vendored
+2
@@ -43,6 +43,8 @@
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="overview.html">Overview</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="getting-started.html">Getting started</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="install-windows.html">Windows installation</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="install-linux.html">Linux installation</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="runs-fitting.html">Runs and fitting</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="parameters-plots.html">Parameters and parameter plots</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="constraints.html">Constraints</a></li>
|
||||
|
||||
+39
-94
@@ -19,7 +19,7 @@
|
||||
<script src="_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="Runs and fitting" href="runs-fitting.html" />
|
||||
<link rel="next" title="Windows installation" href="install-windows.html" />
|
||||
<link rel="prev" title="Overview" href="overview.html" />
|
||||
</head>
|
||||
|
||||
@@ -46,8 +46,8 @@
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="overview.html">Overview</a></li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">Getting started</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#prerequisites">Prerequisites</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#development-and-linux-packages">Development and Linux packages</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#choose-your-edition">Choose your edition</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#desktop-installation">Desktop installation</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#windows-installation">Windows installation</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#running-the-desktop-app">Running the desktop app</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#opening-the-web-edition">Opening the web edition</a></li>
|
||||
@@ -55,6 +55,8 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="#support">Support</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="install-windows.html">Windows installation</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="install-linux.html">Linux installation</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="runs-fitting.html">Runs and fitting</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="parameters-plots.html">Parameters and parameter plots</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="constraints.html">Constraints</a></li>
|
||||
@@ -95,115 +97,58 @@
|
||||
|
||||
<section id="getting-started">
|
||||
<h1>Getting started<a class="headerlink" href="#getting-started" title="Link to this heading"></a></h1>
|
||||
<section id="prerequisites">
|
||||
<h2>Prerequisites<a class="headerlink" href="#prerequisites" title="Link to this heading"></a></h2>
|
||||
<p>muSRFlow wraps external <code class="docutils literal notranslate"><span class="pre">musrfit</span></code> tools. How they are supplied depends on
|
||||
the edition:</p>
|
||||
<section id="choose-your-edition">
|
||||
<h2>Choose your edition<a class="headerlink" href="#choose-your-edition" title="Link to this heading"></a></h2>
|
||||
<ul class="simple">
|
||||
<li><p>Linux desktop: use a local musrfit installation or install the separate
|
||||
ROOT + musrfit runtime. Select the tools through <strong>File / Preferences</strong>.</p></li>
|
||||
<li><p>Windows desktop: the installer includes ROOT and musrfit in a WSL2 runtime.
|
||||
Install WSL first, following <a class="reference internal" href="#windows-installation"><span class="std std-ref">Windows installation</span></a> below.</p></li>
|
||||
<li><p>Web: the tools are installed on the server that hosts the CGI runner.</p></li>
|
||||
<li><p><strong>Windows desktop:</strong> follow <a class="reference internal" href="install-windows.html"><span class="doc">Windows installation</span></a>. ROOT and musrfit are
|
||||
included in a WSL2 runtime. The guide covers first installation, existing
|
||||
runtime updates, and Windows-specific errors.</p></li>
|
||||
<li><p><strong>Linux desktop:</strong> follow <a class="reference internal" href="install-linux.html"><span class="doc">Linux installation</span></a>. Use an existing musrfit
|
||||
installation or install the separate runtime through Preferences.</p></li>
|
||||
<li><p><strong>Web:</strong> open your site’s muSRFlow URL, for example
|
||||
<code class="docutils literal notranslate"><span class="pre">http://musruser.psi.ch/muSRFlow/</span></code>. The server runs the tools; there is
|
||||
nothing to install on your computer.</p></li>
|
||||
</ul>
|
||||
<p>Packaged desktop applications do not require Node.js or npm on the target
|
||||
PC. The browser edition needs no local installation at all.</p>
|
||||
<p>Packaged desktop applications do not require Node.js or npm.</p>
|
||||
</section>
|
||||
<section id="development-and-linux-packages">
|
||||
<span id="desktop-installation"></span><h2>Development and Linux packages<a class="headerlink" href="#development-and-linux-packages" title="Link to this heading"></a></h2>
|
||||
<p>From a checkout, with <a class="reference external" href="https://nodejs.org/">Node.js</a> and npm installed:</p>
|
||||
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span>npm<span class="w"> </span>install
|
||||
<span class="gp">$ </span>npm<span class="w"> </span>start
|
||||
</pre></div>
|
||||
</div>
|
||||
<p><cite>npm install</cite> is only needed once; later sessions start with <cite>npm start</cite>.</p>
|
||||
<p>Release packages (Linux RPM and AppImage) are produced with:</p>
|
||||
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span>npm<span class="w"> </span>run<span class="w"> </span>dist:rpm
|
||||
<span class="gp">$ </span>npm<span class="w"> </span>run<span class="w"> </span>dist:appimage
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Each command also builds the matching standalone ROOT + musrfit runtime
|
||||
artifact (<code class="docutils literal notranslate"><span class="pre">musrflow-runtime</span></code> rpm / AppImage); <code class="docutils literal notranslate"><span class="pre">npm</span> <span class="pre">run</span> <span class="pre">dist:runtime</span></code> builds
|
||||
only the runtime. The build and runtime requirements are described in
|
||||
<code class="docutils literal notranslate"><span class="pre">docs/DESKTOP_DEPLOYMENT.md</span></code>.</p>
|
||||
<section id="desktop-installation">
|
||||
<span id="id1"></span><h2>Desktop installation<a class="headerlink" href="#desktop-installation" title="Link to this heading"></a></h2>
|
||||
<p>The complete instructions are in <a class="reference internal" href="install-windows.html"><span class="doc">Windows installation</span></a> and
|
||||
<a class="reference internal" href="install-linux.html"><span class="doc">Linux installation</span></a>. Choose work and data folders in <strong>File / Preferences</strong>
|
||||
before your first analysis. Keep work files outside the application
|
||||
installation directory.</p>
|
||||
</section>
|
||||
<section id="windows-installation">
|
||||
<span id="id1"></span><h2>Windows installation<a class="headerlink" href="#windows-installation" title="Link to this heading"></a></h2>
|
||||
<p>Use a 64-bit Intel/AMD Windows PC. Windows 11 is recommended; Windows 10
|
||||
requires build 19044 or newer for WSLg, which displays the <code class="docutils literal notranslate"><span class="pre">musrview</span></code>
|
||||
windows. See <a class="reference external" href="https://learn.microsoft.com/en-us/windows/wsl/tutorials/gui-apps">Microsoft’s WSL GUI requirements</a>.</p>
|
||||
<ol class="arabic">
|
||||
<li><p>Open <strong>PowerShell as Administrator</strong> and install WSL:</p>
|
||||
<div class="highlight-powershell notranslate"><div class="highlight"><pre><span></span><span class="n">wsl</span> <span class="p">-</span><span class="n">-install</span> <span class="p">-</span><span class="n">-no-distribution</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Restart Windows afterwards. Skip this step if WSL is already installed.
|
||||
You do not need Ubuntu: muSRFlow supplies its own distribution.</p>
|
||||
</li>
|
||||
<li><p>Update WSL and check its components in administrator PowerShell:</p>
|
||||
<div class="highlight-powershell notranslate"><div class="highlight"><pre><span></span><span class="n">wsl</span> <span class="p">-</span><span class="n">-update</span>
|
||||
<span class="n">wsl</span> <span class="p">-</span><span class="n">-version</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Follow any restart instructions. The output should include WSL and WSLg.
|
||||
See the <a class="reference external" href="https://learn.microsoft.com/en-us/windows/wsl/basic-commands">Microsoft WSL command reference</a>.</p>
|
||||
</li>
|
||||
<li><p>Copy the release installer <code class="docutils literal notranslate"><span class="pre">muSRFlow-<version>-x64.exe</span></code> to Windows and
|
||||
double-click it. It includes <code class="docutils literal notranslate"><span class="pre">muSRFlow-runtime-rootfs.tar.gz</span></code>; there is
|
||||
no separate ROOT or musrfit installation or manual archive import.</p></li>
|
||||
<li><p>Launch muSRFlow from the Start menu using your normal Windows account.
|
||||
The first launch prepares the runtime, which can take several minutes.
|
||||
Fit and Plot wait until preparation finishes. Afterwards, verify:</p>
|
||||
<div class="highlight-powershell notranslate"><div class="highlight"><pre><span></span><span class="n">wsl</span> <span class="p">-</span><span class="n">-list</span> <span class="p">-</span><span class="n">-verbose</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>The list should contain <code class="docutils literal notranslate"><span class="pre">muSRFlow-runtime</span></code> with <strong>VERSION 2</strong>.
|
||||
<code class="docutils literal notranslate"><span class="pre">Running</span></code> and <code class="docutils literal notranslate"><span class="pre">Stopped</span></code> are both normal when idle.</p>
|
||||
</li>
|
||||
<li><p>Create writable work and data folders, for example
|
||||
<code class="docutils literal notranslate"><span class="pre">C:\Users\<your-name>\muSRFlow\work</span></code> and
|
||||
<code class="docutils literal notranslate"><span class="pre">C:\Users\<your-name>\muSRFlow\data</span></code>. Choose them in
|
||||
<strong>File / Preferences</strong>. Leave <strong>musrfit binaries</strong> and
|
||||
<strong>musrfit startup XML</strong> on automatic detection, then save.
|
||||
Enter Windows paths; muSRFlow translates them for WSL.</p></li>
|
||||
<li><p>Select a known instrument, year, and run, then press <strong>Plot</strong>. If data
|
||||
are missing, muSRFlow offers to download them from <code class="docutils literal notranslate"><span class="pre">musruser.psi.ch</span></code>
|
||||
when the server is reachable. Confirm the spectrum window opens, then
|
||||
try <strong>Fit</strong> and check that the parameter table updates. Results stay in
|
||||
your Windows work directory.</p></li>
|
||||
</ol>
|
||||
<p>If setup fails, check WSL, restart muSRFlow, and retry. If plotting fails
|
||||
after setup, check that <code class="docutils literal notranslate"><span class="pre">wsl</span> <span class="pre">--version</span></code> includes WSLg and inspect the
|
||||
command log. The Linux <strong>Install runtime…</strong> preference does not apply to
|
||||
Windows. Installation and graphical plotting still need validation on a
|
||||
Windows PC; automated setup tests use simulated WSL commands.</p>
|
||||
<span id="getting-started-windows-installation"></span><h2>Windows installation<a class="headerlink" href="#windows-installation" title="Link to this heading"></a></h2>
|
||||
<p>The Windows instructions have their own chapter: <a class="reference internal" href="install-windows.html"><span class="doc">Windows installation</span></a>.
|
||||
It also contains the update steps for older WSL runtimes.</p>
|
||||
</section>
|
||||
<section id="running-the-desktop-app">
|
||||
<h2>Running the desktop app<a class="headerlink" href="#running-the-desktop-app" title="Link to this heading"></a></h2>
|
||||
<p>When the window opens, the <strong>Runs</strong> tab is active and the current year is
|
||||
already selected. Enter run numbers, choose a model, and press <strong>Fit</strong>. The
|
||||
first fit writes the working files next to your MSR document and results
|
||||
appear in the <strong>Results</strong> tab.</p>
|
||||
<p>When the window opens, the <strong>Runs</strong> tab is active. Choose the instrument,
|
||||
year, and run numbers, check the model, and press <strong>Plot</strong> to inspect the
|
||||
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>
|
||||
</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>
|
||||
<p>Point your browser at the deployment URL (e.g.
|
||||
<code class="docutils literal notranslate"><span class="pre">http://musruser.psi.ch/muSRFlow/</span></code>). Instrument options and run numbers are
|
||||
the ones the server data tree supports. There is nothing to install; the
|
||||
parameter table is also served from the same data tree.</p>
|
||||
<p>Open the deployment URL in your browser. Instrument options and available
|
||||
run data depend on that site’s server configuration. Fit and Plot run on
|
||||
the server; output files can be opened from the result links.</p>
|
||||
</section>
|
||||
<section id="the-quick-start-guide">
|
||||
<h2>The Quick Start guide<a class="headerlink" href="#the-quick-start-guide" title="Link to this heading"></a></h2>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">?</span></code> button at the right of the tab bar opens a short, tab-aware guide.
|
||||
On the desktop it opens in an independent window; in the browser it opens a
|
||||
modeless dialog next to the main window. Each of its sections corresponds to
|
||||
one tab and is expanded into a chapter of this manual.</p>
|
||||
modeless dialog next to the main window. The full workflow chapters follow
|
||||
the installation guides in this manual.</p>
|
||||
</section>
|
||||
<section id="support">
|
||||
<h2>Support<a class="headerlink" href="#support" title="Link to this heading"></a></h2>
|
||||
<p>For questions and bug reports contact Zaher Salman
|
||||
<a class="reference external" href="mailto:zaher.salman%40psi.ch">mailto:zaher<span>.</span>salman<span>@</span>psi<span>.</span>ch</a>. Issue tracking is linked from the project
|
||||
repository.</p>
|
||||
<p>For questions and bug reports, include the version and run log and contact
|
||||
<a class="reference external" href="mailto:zaher.salman%40psi.ch">Zaher Salman</a>. See <a class="reference internal" href="troubleshooting.html"><span class="doc">Troubleshooting</span></a>
|
||||
for common workflow problems.</p>
|
||||
</section>
|
||||
</section>
|
||||
|
||||
@@ -212,7 +157,7 @@ repository.</p>
|
||||
</div>
|
||||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||
<a href="overview.html" class="btn btn-neutral float-left" title="Overview" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
<a href="runs-fitting.html" class="btn btn-neutral float-right" title="Runs and fitting" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
<a href="install-windows.html" class="btn btn-neutral float-right" title="Windows installation" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
</div>
|
||||
|
||||
<hr/>
|
||||
|
||||
Vendored
+2
@@ -45,6 +45,8 @@
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="overview.html">Overview</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="getting-started.html">Getting started</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="install-windows.html">Windows installation</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="install-linux.html">Linux installation</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="runs-fitting.html">Runs and fitting</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="parameters-plots.html">Parameters and parameter plots</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="constraints.html">Constraints</a></li>
|
||||
|
||||
Vendored
+21
-3
@@ -45,6 +45,8 @@
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="overview.html">Overview</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="getting-started.html">Getting started</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="install-windows.html">Windows installation</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="install-linux.html">Linux installation</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="runs-fitting.html">Runs and fitting</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="parameters-plots.html">Parameters and parameter plots</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="constraints.html">Constraints</a></li>
|
||||
@@ -90,6 +92,8 @@ inspecting <code class="docutils literal notranslate"><span class="pre">musrfit<
|
||||
application and as a browser application, and both editions wrap the same set
|
||||
of command-line tools (<code class="docutils literal notranslate"><span class="pre">musrfit</span></code>, <code class="docutils literal notranslate"><span class="pre">musrview</span></code>, <code class="docutils literal notranslate"><span class="pre">msr2data</span></code>, and
|
||||
<code class="docutils literal notranslate"><span class="pre">dump_header</span></code>).</p>
|
||||
<p>Start with <a class="reference internal" href="install-windows.html"><span class="doc">Windows installation</span></a> or <a class="reference internal" href="install-linux.html"><span class="doc">Linux installation</span></a> for desktop setup.
|
||||
For the browser edition, see <a class="reference internal" href="getting-started.html"><span class="doc">Getting started</span></a>.</p>
|
||||
<p>These pages describe the end-user workflow. They are organised around the
|
||||
main window tabs, mirroring the Quick Start help that is built into the
|
||||
application (the <code class="docutils literal notranslate"><span class="pre">?</span></code> button).</p>
|
||||
@@ -104,8 +108,8 @@ application (the <code class="docutils literal notranslate"><span class="pre">?<
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="getting-started.html">Getting started</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="getting-started.html#prerequisites">Prerequisites</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="getting-started.html#development-and-linux-packages">Development and Linux packages</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="getting-started.html#choose-your-edition">Choose your edition</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="getting-started.html#desktop-installation">Desktop installation</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="getting-started.html#windows-installation">Windows installation</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="getting-started.html#running-the-desktop-app">Running the desktop app</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="getting-started.html#opening-the-web-edition">Opening the web edition</a></li>
|
||||
@@ -113,6 +117,20 @@ application (the <code class="docutils literal notranslate"><span class="pre">?<
|
||||
<li class="toctree-l2"><a class="reference internal" href="getting-started.html#support">Support</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="install-windows.html">Windows installation</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="install-windows.html#before-you-start">Before you start</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="install-windows.html#install-step-by-step">Install step by step</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="install-windows.html#existing-installations">Existing installations</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="install-windows.html#troubleshooting">Troubleshooting</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="install-linux.html">Linux installation</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="install-linux.html#install-the-application">Install the application</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="install-linux.html#set-up-root-and-musrfit">Set up ROOT and musrfit</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="install-linux.html#choose-folders-and-test">Choose folders and test</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="install-linux.html#updating-and-troubleshooting">Updating and troubleshooting</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="runs-fitting.html">Runs and fitting</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="runs-fitting.html#run-selection">Run selection</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="runs-fitting.html#fit-range">Fit range</a></li>
|
||||
@@ -193,7 +211,7 @@ application (the <code class="docutils literal notranslate"><span class="pre">?<
|
||||
</div>
|
||||
<p>If anything in this manual does not match the behaviour you see, contact
|
||||
<a class="reference external" href="mailto:zaher.salman%40psi.ch">Zaher Salman</a>.</p>
|
||||
<p>Separate repository documents cover desk build and packaging
|
||||
<p>Separate repository documents cover desktop builds and packaging
|
||||
(<code class="docutils literal notranslate"><span class="pre">docs/DESKTOP_DEPLOYMENT.md</span></code>) and the web-server/CGI deployment
|
||||
(<code class="docutils literal notranslate"><span class="pre">cgi/README.md</span></code>); this manual concentrates on using the application.</p>
|
||||
</section>
|
||||
|
||||
Vendored
+256
@@ -0,0 +1,256 @@
|
||||
|
||||
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" data-content_root="./">
|
||||
<head>
|
||||
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>Linux installation — muSRFlow User Manual</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=d11f710b" />
|
||||
|
||||
|
||||
<script src="_static/jquery.js?v=5d32c60e"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
|
||||
<script src="_static/documentation_options.js?v=b77d6c2f"></script>
|
||||
<script src="_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script src="_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="Runs and fitting" href="runs-fitting.html" />
|
||||
<link rel="prev" title="Windows installation" href="install-windows.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
<div class="wy-grid-for-nav">
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="index.html" class="icon icon-home">
|
||||
muSRFlow
|
||||
</a>
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||
<p class="caption" role="heading"><span class="caption-text">Contents</span></p>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="overview.html">Overview</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="getting-started.html">Getting started</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="install-windows.html">Windows installation</a></li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">Linux installation</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#install-the-application">Install the application</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#rpm">RPM</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#appimage">AppImage</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#set-up-root-and-musrfit">Set up ROOT and musrfit</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#use-an-existing-installation">Use an existing installation</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#install-the-separate-runtime-from-a-local-bundle">Install the separate runtime from a local bundle</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#alternative-system-runtime-rpm">Alternative: system runtime RPM</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#alternative-runtime-appimage">Alternative: runtime AppImage</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#choose-folders-and-test">Choose folders and test</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#updating-and-troubleshooting">Updating and troubleshooting</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="runs-fitting.html">Runs and fitting</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="parameters-plots.html">Parameters and parameter plots</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="constraints.html">Constraints</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="t0-background.html">t0 / background</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="msr-editor.html">MSR editor</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="results-diagnostics.html">Results and diagnostics</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="configuration-sharing.html">Configuration sharing</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="preferences.html">Preferences</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="platforms.html">Web and desktop editions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="keyboard-shortcuts.html">Keyboard shortcuts</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="troubleshooting.html">Troubleshooting</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="glossary.html">Glossary</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="index.html">muSRFlow</a>
|
||||
</nav>
|
||||
|
||||
<div class="wy-nav-content">
|
||||
<div class="rst-content">
|
||||
<div role="navigation" aria-label="Page navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||||
<li class="breadcrumb-item active">Linux installation</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
<a href="_sources/install-linux.rst.txt" rel="nofollow"> View page source</a>
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<section id="linux-installation">
|
||||
<span id="id1"></span><h1>Linux installation<a class="headerlink" href="#linux-installation" title="Link to this heading"></a></h1>
|
||||
<p>Install the muSRFlow application, then select a working ROOT + musrfit
|
||||
installation. <strong>The Linux application package does not include the scientific
|
||||
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
|
||||
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>
|
||||
<p>Choose one application format.</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
|
||||
musrflow
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>On other RPM systems, use the distribution’s package manager. The application
|
||||
RPM filename starts with lowercase <code class="docutils literal notranslate"><span class="pre">musrflow</span></code>.</p>
|
||||
</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
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>The application AppImage filename starts with <code class="docutils literal notranslate"><span class="pre">muSRFlow</span></code>. It requires a
|
||||
compatible Linux desktop and AppImage/FUSE support. If it cannot start,
|
||||
check the terminal output or use the RPM on a supported RPM distribution.</p>
|
||||
</section>
|
||||
</section>
|
||||
<section id="set-up-root-and-musrfit">
|
||||
<h2>Set up ROOT and musrfit<a class="headerlink" href="#set-up-root-and-musrfit" title="Link to this heading"></a></h2>
|
||||
<section id="use-an-existing-installation">
|
||||
<h3>Use an existing installation<a class="headerlink" href="#use-an-existing-installation" title="Link to this heading"></a></h3>
|
||||
<p>Open <strong>File / Preferences</strong>. Leave <strong>musrfit binaries</strong> on automatic detection
|
||||
for a standard installation, or choose the directory containing <code class="docutils literal notranslate"><span class="pre">musrfit</span></code>,
|
||||
<code class="docutils literal notranslate"><span class="pre">musrview</span></code>, <code class="docutils literal notranslate"><span class="pre">msr2data</span></code>, <code class="docutils literal notranslate"><span class="pre">musrt0</span></code>, and <code class="docutils literal notranslate"><span class="pre">dump_header</span></code>. Save your settings,
|
||||
then use <strong>Check tools</strong> to verify the saved selection.</p>
|
||||
</section>
|
||||
<section id="install-the-separate-runtime-from-a-local-bundle">
|
||||
<h3>Install the separate runtime from a local bundle<a class="headerlink" href="#install-the-separate-runtime-from-a-local-bundle" title="Link to this heading"></a></h3>
|
||||
<ol class="arabic simple">
|
||||
<li><p>Obtain the runtime bundle for your architecture. Keep
|
||||
<code class="docutils literal notranslate"><span class="pre">runtime-download.json</span></code> and its matching <code class="docutils literal notranslate"><span class="pre">musrflow-runtime-*.tar.gz</span></code>
|
||||
archive in the same folder. You do not need to unpack it.</p></li>
|
||||
<li><p>Open <strong>File / Preferences / Install runtime…</strong> and select
|
||||
<code class="docutils literal notranslate"><span class="pre">runtime-download.json</span></code>.</p></li>
|
||||
<li><p>Review the versions and destination, then select <strong>Install and use</strong>.
|
||||
muSRFlow validates the archive, installs it in your personal application
|
||||
data directory, and selects its tools.</p></li>
|
||||
<li><p>Use <strong>Check tools</strong> to confirm the selected runtime starts.</p></li>
|
||||
</ol>
|
||||
<p>This installation does not require administrator access. Runtime downloads
|
||||
are not automatic: obtain the bundle separately before opening the installer.
|
||||
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
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>This installs the runtime into <code class="docutils literal notranslate"><span class="pre">/opt/musrflow/runtime</span></code>, which muSRFlow
|
||||
recognizes automatically when no explicit tool directory takes precedence.</p>
|
||||
</section>
|
||||
<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">"</span><span class="nv">$HOME</span><span class="s2">/.local/share/musrflow/runtime"</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Launch the application with the installed runtime selected:</p>
|
||||
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nv">MUSRFLOW_RUNTIME_ROOT</span><span class="o">=</span><span class="s2">"</span><span class="nv">$HOME</span><span class="s2">/.local/share/musrflow/runtime"</span><span class="w"> </span>musrflow
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>For the application AppImage, replace <code class="docutils literal notranslate"><span class="pre">musrflow</span></code> in that command with its
|
||||
path. Leave <strong>musrfit binaries</strong> on automatic detection so the selected
|
||||
runtime is used. Without a custom destination, the runtime AppImage installs
|
||||
to <code class="docutils literal notranslate"><span class="pre">/opt/musrflow/runtime</span></code> and needs permission to write there. Its filename
|
||||
is lowercase <code class="docutils literal notranslate"><span class="pre">musrflow-runtime</span></code>, unlike the application AppImage.</p>
|
||||
</section>
|
||||
</section>
|
||||
<section id="choose-folders-and-test">
|
||||
<h2>Choose folders and test<a class="headerlink" href="#choose-folders-and-test" title="Link to this heading"></a></h2>
|
||||
<ol class="arabic simple">
|
||||
<li><p>In <strong>File / Preferences</strong>, choose a writable <strong>Work directory</strong> outside
|
||||
the application installation folder, for example <code class="docutils literal notranslate"><span class="pre">~/muSRFlow/work</span></code>.
|
||||
Use <strong>Browse…</strong> to select it.</p></li>
|
||||
<li><p>Set <strong>Data directory</strong> to the root of your instrument data tree, or to a
|
||||
writable folder such as <code class="docutils literal notranslate"><span class="pre">~/muSRFlow/data</span></code> for downloaded runs.</p></li>
|
||||
<li><p>Leave <strong>musrfit startup XML</strong> on automatic detection unless you have a
|
||||
specific installation configuration, then save.</p></li>
|
||||
<li><p>Select a known instrument, year, and run. Click <strong>Plot</strong>, then <strong>Fit</strong>.
|
||||
Confirm the spectrum opens, fitted parameters update, and output files
|
||||
appear in your work directory. Missing runs can be downloaded from
|
||||
<code class="docutils literal notranslate"><span class="pre">musruser.psi.ch</span></code> after confirmation when the server is reachable.</p></li>
|
||||
</ol>
|
||||
</section>
|
||||
<section id="updating-and-troubleshooting">
|
||||
<h2>Updating and troubleshooting<a class="headerlink" href="#updating-and-troubleshooting" title="Link to this heading"></a></h2>
|
||||
<ul class="simple">
|
||||
<li><p>Upgrade the application RPM with your package manager, or replace the
|
||||
application AppImage. The separate runtime is not updated by an app upgrade.</p></li>
|
||||
<li><p>Preserve work files outside the application/runtime installation directories.</p></li>
|
||||
<li><p>For missing tools or shared libraries, run <strong>Check tools</strong> and inspect the
|
||||
reported executable paths. A configured binaries directory overrides
|
||||
automatic detection; clear an obsolete selection or choose the correct one.</p></li>
|
||||
<li><p>If fitting works but no spectrum window opens, inspect the run log and
|
||||
confirm your desktop session can display native musrview windows.</p></li>
|
||||
<li><p>If data are missing, check the instrument, year, run number, and data root.
|
||||
Downloaded files use the selected writable data root or the personal
|
||||
fallback folder reported in Preferences.</p></li>
|
||||
</ul>
|
||||
<p>Include the application version and run log when reporting a problem.</p>
|
||||
</section>
|
||||
</section>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||
<a href="install-windows.html" class="btn btn-neutral float-left" title="Windows installation" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
<a href="runs-fitting.html" class="btn btn-neutral float-right" title="Runs and fitting" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
</div>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>© Copyright 2026 Zaher Salman.</p>
|
||||
</div>
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
<script>
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
+297
@@ -0,0 +1,297 @@
|
||||
|
||||
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" data-content_root="./">
|
||||
<head>
|
||||
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>Windows installation — muSRFlow User Manual</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=d11f710b" />
|
||||
|
||||
|
||||
<script src="_static/jquery.js?v=5d32c60e"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
|
||||
<script src="_static/documentation_options.js?v=b77d6c2f"></script>
|
||||
<script src="_static/doctools.js?v=9bcbadda"></script>
|
||||
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script src="_static/js/theme.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="Linux installation" href="install-linux.html" />
|
||||
<link rel="prev" title="Getting started" href="getting-started.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
<div class="wy-grid-for-nav">
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="index.html" class="icon icon-home">
|
||||
muSRFlow
|
||||
</a>
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||||
<p class="caption" role="heading"><span class="caption-text">Contents</span></p>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="overview.html">Overview</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="getting-started.html">Getting started</a></li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">Windows installation</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#before-you-start">Before you start</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#install-step-by-step">Install step by step</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#existing-installations">Existing installations</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#troubleshooting">Troubleshooting</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#required-feature-is-not-installed">Required feature is not installed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#cannot-find-wsl-exe">Cannot find wsl.exe</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#cannot-load-libcore-so">Cannot load libCore.so</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#missing-boost-version-hpp-or-plotting-crash">Missing boost/version.hpp or plotting crash</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#no-spectrum-window-appears">No spectrum window appears</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#reporting-a-problem">Reporting a problem</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="install-linux.html">Linux installation</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="runs-fitting.html">Runs and fitting</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="parameters-plots.html">Parameters and parameter plots</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="constraints.html">Constraints</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="t0-background.html">t0 / background</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="msr-editor.html">MSR editor</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="results-diagnostics.html">Results and diagnostics</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="configuration-sharing.html">Configuration sharing</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="preferences.html">Preferences</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="platforms.html">Web and desktop editions</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="keyboard-shortcuts.html">Keyboard shortcuts</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="troubleshooting.html">Troubleshooting</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="glossary.html">Glossary</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="index.html">muSRFlow</a>
|
||||
</nav>
|
||||
|
||||
<div class="wy-nav-content">
|
||||
<div class="rst-content">
|
||||
<div role="navigation" aria-label="Page navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||||
<li class="breadcrumb-item active">Windows installation</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
<a href="_sources/install-windows.rst.txt" rel="nofollow"> View page source</a>
|
||||
</li>
|
||||
</ul>
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<section id="windows-installation">
|
||||
<span id="id1"></span><h1>Windows installation<a class="headerlink" href="#windows-installation" title="Link to this heading"></a></h1>
|
||||
<p>The Windows installer includes muSRFlow, ROOT, and musrfit. Install WSL2
|
||||
first; muSRFlow prepares its own Linux runtime on first launch. You do not
|
||||
need Node.js, npm, Ubuntu, or a separate ROOT/musrfit installation.</p>
|
||||
<p>Already installed muSRFlow? Read <a class="reference internal" href="#existing-installations">Existing installations</a> as well: updating
|
||||
the application does not update an already imported WSL runtime.</p>
|
||||
<section id="before-you-start">
|
||||
<h2>Before you start<a class="headerlink" href="#before-you-start" title="Link to this heading"></a></h2>
|
||||
<ul class="simple">
|
||||
<li><p>Use a <strong>64-bit Intel/AMD PC</strong>. The current package is x64.</p></li>
|
||||
<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-<version>-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>
|
||||
</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>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>
|
||||
<section id="install-step-by-step">
|
||||
<h2>Install step by step<a class="headerlink" href="#install-step-by-step" title="Link to this heading"></a></h2>
|
||||
<ol class="arabic">
|
||||
<li><p><strong>Install WSL.</strong> Open <strong>PowerShell as Administrator</strong> and run:</p>
|
||||
<div class="highlight-powershell notranslate"><div class="highlight"><pre><span></span><span class="n">wsl</span> <span class="p">-</span><span class="n">-install</span> <span class="p">-</span><span class="n">-no-distribution</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p><strong>Restart Windows afterwards.</strong> Skip this step if WSL is already installed.
|
||||
muSRFlow supplies its own distribution, so Ubuntu is not required.</p>
|
||||
</li>
|
||||
<li><p><strong>Update and check WSL.</strong> In administrator PowerShell, run:</p>
|
||||
<div class="highlight-powershell notranslate"><div class="highlight"><pre><span></span><span class="n">wsl</span> <span class="p">-</span><span class="n">-update</span>
|
||||
<span class="n">wsl</span> <span class="p">-</span><span class="n">-version</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Follow any restart instructions. The output should include WSL and WSLg.
|
||||
These commands are described in the <a class="reference external" href="https://learn.microsoft.com/en-us/windows/wsl/basic-commands">Microsoft WSL command reference</a>.</p>
|
||||
</li>
|
||||
<li><p><strong>Install muSRFlow.</strong> Double-click the Windows installer and complete setup.
|
||||
The runtime archive <code class="docutils literal notranslate"><span class="pre">muSRFlow-runtime-rootfs.tar.gz</span></code> is included; do not
|
||||
extract or import it manually for a normal installation.</p></li>
|
||||
<li><p><strong>Launch muSRFlow</strong> from the Start menu using your normal Windows account.
|
||||
First launch imports the runtime as <code class="docutils literal notranslate"><span class="pre">muSRFlow-runtime</span></code> and can take
|
||||
several minutes. Fit and Plot wait until preparation finishes. Afterwards,
|
||||
verify in PowerShell:</p>
|
||||
<div class="highlight-powershell notranslate"><div class="highlight"><pre><span></span><span class="n">wsl</span> <span class="p">-</span><span class="n">-list</span> <span class="p">-</span><span class="n">-verbose</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>The list should contain <code class="docutils literal notranslate"><span class="pre">muSRFlow-runtime</span></code> with <strong>VERSION 2</strong>.
|
||||
<code class="docutils literal notranslate"><span class="pre">Running</span></code> and <code class="docutils literal notranslate"><span class="pre">Stopped</span></code> are both normal when idle. The runtime is
|
||||
stored under <code class="docutils literal notranslate"><span class="pre">%LOCALAPPDATA%\muSRFlow\muSRFlow-runtime</span></code> for this account.</p>
|
||||
</li>
|
||||
<li><p><strong>Choose work and data folders before fitting.</strong> Create folders such as:</p>
|
||||
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>C:\Users\<your-name>\muSRFlow\work
|
||||
C:\Users\<your-name>\muSRFlow\data
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>In <strong>File / Preferences</strong>, select them as <strong>Work directory</strong> and
|
||||
<strong>Data directory</strong>. Leave <strong>musrfit binaries</strong> and <strong>musrfit startup XML</strong>
|
||||
on automatic detection, then save. Enter normal Windows paths; muSRFlow
|
||||
translates them for WSL.</p>
|
||||
<p>Use a work folder outside the application installation directory. The
|
||||
default <code class="docutils literal notranslate"><span class="pre">.</span></code> can resolve to the installation folder and place your
|
||||
results among files managed by the installer.</p>
|
||||
</li>
|
||||
<li><p><strong>Try Plot, then Fit.</strong> Select a known instrument, year, and run. Click
|
||||
<strong>Plot</strong> and confirm that the spectrum window opens. Missing run data
|
||||
can be downloaded from <code class="docutils literal notranslate"><span class="pre">musruser.psi.ch</span></code> after confirmation when the
|
||||
server is reachable. Then click <strong>Fit</strong>, check that the parameter table
|
||||
updates, and inspect the generated files in your work directory.</p></li>
|
||||
</ol>
|
||||
</section>
|
||||
<section id="existing-installations">
|
||||
<h2>Existing installations<a class="headerlink" href="#existing-installations" title="Link to this heading"></a></h2>
|
||||
<ol class="arabic">
|
||||
<li><p>Preserve any MSR/data/result files currently stored inside the muSRFlow
|
||||
installation folder: move them to a separate work folder before upgrading.</p></li>
|
||||
<li><p>Close muSRFlow and install the refreshed Windows application.</p></li>
|
||||
<li><p>If your runtime was imported from an older bundle, add the missing Boost
|
||||
headers from PowerShell:</p>
|
||||
<div class="highlight-powershell notranslate"><div class="highlight"><pre><span></span><span class="n">wsl</span> <span class="n">-d</span> <span class="n">muSRFlow-runtime</span> <span class="p">--</span> <span class="n">dnf</span> <span class="n">-y</span> <span class="n">install</span> <span class="n">boost-devel</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>This needs access to the distribution’s package repositories. ROOT uses
|
||||
these headers when loading musrview plotting classes. Fresh runtimes
|
||||
from the corrected installer already include them.</p>
|
||||
</li>
|
||||
<li><p>Reopen muSRFlow, select your work directory in Preferences, and retry Plot
|
||||
and Fit.</p></li>
|
||||
</ol>
|
||||
<p>Reinstalling the application preserves an existing <code class="docutils literal notranslate"><span class="pre">muSRFlow-runtime</span></code>
|
||||
distribution, so the application update alone does not add those headers.
|
||||
The command above repairs it in place; do not unregister the distribution
|
||||
as part of this update. The Linux <strong>Install runtime…</strong> preference is not
|
||||
used on Windows.</p>
|
||||
</section>
|
||||
<section id="troubleshooting">
|
||||
<h2>Troubleshooting<a class="headerlink" href="#troubleshooting" title="Link to this heading"></a></h2>
|
||||
<section id="required-feature-is-not-installed">
|
||||
<h3>Required feature is not installed<a class="headerlink" href="#required-feature-is-not-installed" title="Link to this heading"></a></h3>
|
||||
<p>For <code class="docutils literal notranslate"><span class="pre">HCS_E_SERVICE_NOT_AVAILABLE</span></code> during runtime preparation, Windows
|
||||
could not create the WSL virtual machine. In <strong>administrator PowerShell</strong>:</p>
|
||||
<div class="highlight-powershell notranslate"><div class="highlight"><pre><span></span><span class="n">dism</span><span class="p">.</span><span class="n">exe</span> <span class="p">/</span><span class="n">online</span> <span class="p">/</span><span class="nb">enable-feature</span> <span class="p">/</span><span class="n">featurename</span><span class="p">:</span><span class="n">VirtualMachinePlatform</span> <span class="p">/</span><span class="n">all</span> <span class="p">/</span><span class="n">norestart</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Restart Windows. Check <strong>Task Manager / Performance / CPU</strong> for
|
||||
<strong>Virtualization: Enabled</strong>; if disabled, enable hardware virtualization in
|
||||
BIOS/UEFI. If Windows itself is a virtual machine, its host must expose nested
|
||||
virtualization. If the error persists, check the boot setting:</p>
|
||||
<div class="highlight-powershell notranslate"><div class="highlight"><pre><span></span><span class="n">bcdedit</span> <span class="p">/</span><span class="n">enum</span> <span class="p">|</span> <span class="n">findstr</span> <span class="n">-i</span> <span class="n">hypervisorlaunchtype</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Only if it reports <code class="docutils literal notranslate"><span class="pre">Off</span></code>, enable it and restart:</p>
|
||||
<div class="highlight-powershell notranslate"><div class="highlight"><pre><span></span><span class="n">bcdedit</span> <span class="p">/</span><span class="nb">set </span><span class="n">hypervisorlaunchtype</span> <span class="n">Auto</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>See <a class="reference external" href="https://learn.microsoft.com/en-us/windows/wsl/troubleshooting">Microsoft’s WSL troubleshooting guide</a>.</p>
|
||||
</section>
|
||||
<section id="cannot-find-wsl-exe">
|
||||
<h3>Cannot find wsl.exe<a class="headerlink" href="#cannot-find-wsl-exe" title="Link to this heading"></a></h3>
|
||||
<p>For <code class="docutils literal notranslate"><span class="pre">spawn</span> <span class="pre">wsl.exe</span> <span class="pre">ENOENT</span></code>, first check that <code class="docutils literal notranslate"><span class="pre">wsl</span> <span class="pre">--version</span></code> works in
|
||||
PowerShell. If it does, install the refreshed muSRFlow build: early rc.5
|
||||
builds incorrectly replaced the Windows executable search path. Also check
|
||||
that the selected work directory exists and is writable.</p>
|
||||
</section>
|
||||
<section id="cannot-load-libcore-so">
|
||||
<h3>Cannot load libCore.so<a class="headerlink" href="#cannot-load-libcore-so" title="Link to this heading"></a></h3>
|
||||
<p>Install the refreshed muSRFlow build. It passes the ROOT library directory
|
||||
inside WSL for every bundled command. Setting a Windows <code class="docutils literal notranslate"><span class="pre">ROOTSYS</span></code> or
|
||||
<code class="docutils literal notranslate"><span class="pre">LD_LIBRARY_PATH</span></code> is not a substitute for this launcher fix.</p>
|
||||
</section>
|
||||
<section id="missing-boost-version-hpp-or-plotting-crash">
|
||||
<h3>Missing boost/version.hpp or plotting crash<a class="headerlink" href="#missing-boost-version-hpp-or-plotting-crash" title="Link to this heading"></a></h3>
|
||||
<p>Follow <a class="reference internal" href="#existing-installations">Existing installations</a> to install <code class="docutils literal notranslate"><span class="pre">boost-devel</span></code> in an older
|
||||
runtime. The corrected runtime includes it. If plotting still crashes,
|
||||
include the full command output when reporting the problem.</p>
|
||||
</section>
|
||||
<section id="no-spectrum-window-appears">
|
||||
<h3>No spectrum window appears<a class="headerlink" href="#no-spectrum-window-appears" title="Link to this heading"></a></h3>
|
||||
<p>Confirm that <code class="docutils literal notranslate"><span class="pre">wsl</span> <span class="pre">--version</span></code> lists WSLg, update WSL, and inspect the
|
||||
muSRFlow run log. Successful runtime import or a successful fit alone does
|
||||
not verify interactive graphics support.</p>
|
||||
</section>
|
||||
<section id="reporting-a-problem">
|
||||
<h3>Reporting a problem<a class="headerlink" href="#reporting-a-problem" title="Link to this heading"></a></h3>
|
||||
<p>Include the muSRFlow version, full run log, and the output of:</p>
|
||||
<div class="highlight-powershell notranslate"><div class="highlight"><pre><span></span><span class="n">wsl</span> <span class="p">-</span><span class="n">-version</span>
|
||||
<span class="n">wsl</span> <span class="p">-</span><span class="n">-status</span>
|
||||
<span class="n">wsl</span> <span class="p">-</span><span class="n">-list</span> <span class="p">-</span><span class="n">-verbose</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>The corrected runtime has completed a real fit and generated a PNG in a
|
||||
Linux container. Interactive Windows/WSLg plotting still needs validation
|
||||
on the target PC.</p>
|
||||
</section>
|
||||
</section>
|
||||
</section>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||
<a href="getting-started.html" class="btn btn-neutral float-left" title="Getting started" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
<a href="install-linux.html" class="btn btn-neutral float-right" title="Linux installation" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
</div>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>© Copyright 2026 Zaher Salman.</p>
|
||||
</div>
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
<script>
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
+2
@@ -46,6 +46,8 @@
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="overview.html">Overview</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="getting-started.html">Getting started</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="install-windows.html">Windows installation</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="install-linux.html">Linux installation</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="runs-fitting.html">Runs and fitting</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="parameters-plots.html">Parameters and parameter plots</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="constraints.html">Constraints</a></li>
|
||||
|
||||
Vendored
+2
@@ -46,6 +46,8 @@
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="overview.html">Overview</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="getting-started.html">Getting started</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="install-windows.html">Windows installation</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="install-linux.html">Linux installation</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="runs-fitting.html">Runs and fitting</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="parameters-plots.html">Parameters and parameter plots</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="constraints.html">Constraints</a></li>
|
||||
|
||||
Vendored
BIN
Binary file not shown.
Vendored
+2
@@ -52,6 +52,8 @@
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="getting-started.html">Getting started</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="install-windows.html">Windows installation</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="install-linux.html">Linux installation</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="runs-fitting.html">Runs and fitting</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="parameters-plots.html">Parameters and parameter plots</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="constraints.html">Constraints</a></li>
|
||||
|
||||
+2
@@ -46,6 +46,8 @@
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="overview.html">Overview</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="getting-started.html">Getting started</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="install-windows.html">Windows installation</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="install-linux.html">Linux installation</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="runs-fitting.html">Runs and fitting</a></li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">Parameters and parameter plots</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#the-parameter-table">The parameter table</a><ul>
|
||||
|
||||
Vendored
+12
-20
@@ -46,6 +46,8 @@
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="overview.html">Overview</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="getting-started.html">Getting started</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="install-windows.html">Windows installation</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="install-linux.html">Linux installation</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="runs-fitting.html">Runs and fitting</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="parameters-plots.html">Parameters and parameter plots</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="constraints.html">Constraints</a></li>
|
||||
@@ -139,26 +141,16 @@ JSROOT in the page.</p></td>
|
||||
</table>
|
||||
<section id="bundled-root-and-musrfit">
|
||||
<h2>Bundled ROOT and musrfit<a class="headerlink" href="#bundled-root-and-musrfit" title="Link to this heading"></a></h2>
|
||||
<p>Packaged desktop builds can use a self-contained ROOT + musrfit runtime, so a
|
||||
separate musrfit installation is not required on the machine. The runtime may
|
||||
be bundled inside the application or, on Linux, installed separately (the
|
||||
<code class="docutils literal notranslate"><span class="pre">musrflow-runtime</span></code> rpm or the portable <code class="docutils literal notranslate"><span class="pre">muSRFlow-runtime</span></code> AppImage, both
|
||||
defaulting to <code class="docutils literal notranslate"><span class="pre">/opt/musrflow/runtime</span></code>). When a runtime is found muSRFlow runs
|
||||
those tools with <code class="docutils literal notranslate"><span class="pre">ROOTSYS</span></code>, <code class="docutils literal notranslate"><span class="pre">MUSRFITPATH</span></code>, and <code class="docutils literal notranslate"><span class="pre">LD_LIBRARY_PATH</span></code> pointed
|
||||
at it; a directory set in <strong>Preferences / musrfit binaries</strong> still takes
|
||||
precedence, and on builds without a runtime the system installation is used
|
||||
exactly as before. The runtime is built with <code class="docutils literal notranslate"><span class="pre">packaging/runtime/build.sh</span></code> and
|
||||
packaged with <code class="docutils literal notranslate"><span class="pre">packaging/runtime/build-runtime-rpm.sh</span></code> /
|
||||
<code class="docutils literal notranslate"><span class="pre">build-runtime-appimage.sh</span></code> (see <code class="docutils literal notranslate"><span class="pre">packaging/runtime/README.md</span></code>).</p>
|
||||
<p>On Windows the bundled runtime runs inside a WSL2 distribution that muSRFlow
|
||||
ships: the tools are invoked through <code class="docutils literal notranslate"><span class="pre">wsl.exe</span></code> and file paths are translated
|
||||
between the Windows and WSL forms, so inputs and outputs stay on the Windows
|
||||
side. The rootfs is built with <code class="docutils literal notranslate"><span class="pre">packaging/wsl2/build-wsl2.sh</span></code> and imported
|
||||
once per user (see <code class="docutils literal notranslate"><span class="pre">packaging/wsl2/README.md</span></code>).</p>
|
||||
<p>Follow <a class="reference internal" href="getting-started.html#windows-installation"><span class="std std-ref">Windows installation</span></a> for the WSL setup, Windows installer,
|
||||
folder preferences, and first Plot/Fit check. The Windows installer includes
|
||||
<code class="docutils literal notranslate"><span class="pre">muSRFlow-runtime-rootfs.tar.gz</span></code> and imports it automatically; the separate
|
||||
Linux runtime archive and <strong>Install runtime…</strong> preference do not apply.</p>
|
||||
<p>On Linux, the application and scientific runtime are separate. Use an
|
||||
existing ROOT + musrfit installation, install an offline runtime bundle in
|
||||
Preferences, or install the system runtime RPM/AppImage. An explicitly
|
||||
selected binaries directory takes precedence over automatic detection.
|
||||
See <a class="reference internal" href="install-linux.html"><span class="doc">Linux installation</span></a> for installation and tool checks.</p>
|
||||
<p>On Windows, the application installer includes the runtime. It runs inside
|
||||
a WSL2 distribution named <code class="docutils literal notranslate"><span class="pre">muSRFlow-runtime</span></code>. Tools are invoked through
|
||||
<code class="docutils literal notranslate"><span class="pre">wsl.exe</span></code>, with paths translated so inputs and outputs stay on the Windows
|
||||
side. The separate Linux runtime installer does not apply to Windows.
|
||||
See <a class="reference internal" href="install-windows.html"><span class="doc">Windows installation</span></a> for WSL setup, installation, updates, and fixes.</p>
|
||||
<p>The workflow chapters of this manual apply to both editions. Where a step is
|
||||
specific to one edition (handling files, Preferences), the text says so
|
||||
explicitly.</p>
|
||||
|
||||
Vendored
+10
-1
@@ -46,6 +46,8 @@
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="overview.html">Overview</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="getting-started.html">Getting started</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="install-windows.html">Windows installation</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="install-linux.html">Linux installation</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="runs-fitting.html">Runs and fitting</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="parameters-plots.html">Parameters and parameter plots</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="constraints.html">Constraints</a></li>
|
||||
@@ -91,7 +93,9 @@
|
||||
configuration and never exposes this dialog.</p>
|
||||
<dl>
|
||||
<dt>Work directory</dt><dd><p>Where generated files, MSR documents, and result artifacts are written.
|
||||
Defaults to the current directory (<code class="docutils literal notranslate"><span class="pre">.</span></code>).</p>
|
||||
Defaults to the current directory (<code class="docutils literal notranslate"><span class="pre">.</span></code>), which can be the application
|
||||
installation folder. Choose a separate writable work folder before fitting
|
||||
so application upgrades do not affect your results.</p>
|
||||
</dd>
|
||||
<dt>Data directory</dt><dd><p>The root of the instrument data tree (for example
|
||||
<code class="docutils literal notranslate"><span class="pre">/psi.ch/group/lmu/public/data</span></code>). Run paths are resolved under it.</p>
|
||||
@@ -123,6 +127,11 @@ given to them. The setting is a desktop feature: it is remembered across
|
||||
sessions, while the web edition takes its tools from the server and never
|
||||
exposes this field.</p>
|
||||
</dd>
|
||||
<dt>Runtime installation and checks (Linux)</dt><dd><p><strong>Check tools</strong> checks the saved tool selection. <strong>Install runtime…</strong>
|
||||
installs a local runtime bundle after confirmation and selects its tools.
|
||||
See <a class="reference internal" href="install-linux.html"><span class="doc">Linux installation</span></a> for the required files and installation steps.
|
||||
Windows uses its bundled WSL runtime instead; see <a class="reference internal" href="install-windows.html"><span class="doc">Windows installation</span></a>.</p>
|
||||
</dd>
|
||||
<dt>musrfit threads</dt><dd><p>The number of OpenMP threads passed to a local <code class="docutils literal notranslate"><span class="pre">musrfit</span></code> run (<code class="docutils literal notranslate"><span class="pre">-u</span></code>).
|
||||
Leave it blank to let musrfit use every available core. Set a lower
|
||||
number to keep a fit from saturating a shared workstation or login node.
|
||||
|
||||
+2
@@ -46,6 +46,8 @@
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="overview.html">Overview</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="getting-started.html">Getting started</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="install-windows.html">Windows installation</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="install-linux.html">Linux installation</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="runs-fitting.html">Runs and fitting</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="parameters-plots.html">Parameters and parameter plots</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="constraints.html">Constraints</a></li>
|
||||
|
||||
Vendored
+4
-2
@@ -20,7 +20,7 @@
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="Parameters and parameter plots" href="parameters-plots.html" />
|
||||
<link rel="prev" title="Getting started" href="getting-started.html" />
|
||||
<link rel="prev" title="Linux installation" href="install-linux.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
@@ -46,6 +46,8 @@
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="overview.html">Overview</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="getting-started.html">Getting started</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="install-windows.html">Windows installation</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="install-linux.html">Linux installation</a></li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">Runs and fitting</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#run-selection">Run selection</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#fit-range">Fit range</a></li>
|
||||
@@ -317,7 +319,7 @@ replace it – see <a class="reference internal" href="msr-editor.html"><span cl
|
||||
</div>
|
||||
</div>
|
||||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||
<a href="getting-started.html" class="btn btn-neutral float-left" title="Getting started" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
<a href="install-linux.html" class="btn btn-neutral float-left" title="Linux installation" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
<a href="parameters-plots.html" class="btn btn-neutral float-right" title="Parameters and parameter plots" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
</div>
|
||||
|
||||
|
||||
Vendored
+2
@@ -46,6 +46,8 @@
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="overview.html">Overview</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="getting-started.html">Getting started</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="install-windows.html">Windows installation</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="install-linux.html">Linux installation</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="runs-fitting.html">Runs and fitting</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="parameters-plots.html">Parameters and parameter plots</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="constraints.html">Constraints</a></li>
|
||||
|
||||
Vendored
+1
-1
@@ -1 +1 @@
|
||||
Search.setIndex({"alltitles":{"A first fit":[[7,"a-first-fit"]],"Bundled ROOT and musrfit":[[9,"bundled-root-and-musrfit"]],"Command log":[[11,"command-log"]],"Configuration sharing":[[0,null]],"Constraints":[[1,null],[1,"id1"]],"Contents":[[4,null]],"Custom parameters":[[1,"custom-parameters"]],"Development and Linux packages":[[2,"development-and-linux-packages"]],"Downloading missing runs":[[9,"downloading-missing-runs"]],"Editing trace styles":[[8,"editing-trace-styles"]],"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]],"Multi-group asymmetry fits":[[13,"multi-group-asymmetry-fits"]],"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"]],"Overlay data sets (multiple files in one panel)":[[8,"overlay-data-sets-multiple-files-in-one-panel"]],"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"]],"Remembered plot configurations":[[8,"remembered-plot-configurations"]],"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"]],"Windows installation":[[2,"windows-installation"]],"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]],"msrLine 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
|
||||
Vendored
+2
@@ -46,6 +46,8 @@
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="overview.html">Overview</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="getting-started.html">Getting started</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="install-windows.html">Windows installation</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="install-linux.html">Linux installation</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="runs-fitting.html">Runs and fitting</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="parameters-plots.html">Parameters and parameter plots</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="constraints.html">Constraints</a></li>
|
||||
|
||||
+5
@@ -46,6 +46,8 @@
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="overview.html">Overview</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="getting-started.html">Getting started</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="install-windows.html">Windows installation</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="install-linux.html">Linux installation</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="runs-fitting.html">Runs and fitting</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="parameters-plots.html">Parameters and parameter plots</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="constraints.html">Constraints</a></li>
|
||||
@@ -97,6 +99,9 @@
|
||||
|
||||
<section id="troubleshooting">
|
||||
<h1>Troubleshooting<a class="headerlink" href="#troubleshooting" title="Link to this heading"></a></h1>
|
||||
<p>For Windows setup, WSL startup errors, missing ROOT libraries, and older
|
||||
runtime updates, see <a class="reference internal" href="install-windows.html"><span class="doc">Windows installation</span></a>. For Linux package/runtime setup,
|
||||
see <a class="reference internal" href="install-linux.html"><span class="doc">Linux installation</span></a>. The sections below cover analysis workflows.</p>
|
||||
<section id="fit-or-plot-will-not-start">
|
||||
<h2>Fit or plot will not start<a class="headerlink" href="#fit-or-plot-will-not-start" title="Link to this heading"></a></h2>
|
||||
<p>Check the resolution warning under the run row: it reports runs that cannot
|
||||
|
||||
Vendored
+226
-174
@@ -25,201 +25,253 @@
|
||||
\@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}Prerequisites}{5}{section.2.1}\protected@file@percent }
|
||||
\newlabel{getting-started:prerequisites}{{2.1}{5}{Prerequisites}{section.2.1}{}}
|
||||
\@writefile{toc}{\contentsline {section}{\numberline {2.2}Development and Linux packages}{5}{section.2.2}\protected@file@percent }
|
||||
\newlabel{getting-started:development-and-linux-packages}{{2.2}{5}{Development and Linux packages}{section.2.2}{}}
|
||||
\newlabel{getting-started:desktop-installation}{{2.2}{5}{Development and Linux packages}{section.2.2}{}}
|
||||
\@writefile{toc}{\contentsline {section}{\numberline {2.3}Windows installation}{6}{section.2.3}\protected@file@percent }
|
||||
\newlabel{getting-started:windows-installation}{{2.3}{6}{Windows installation}{section.2.3}{}}
|
||||
\newlabel{getting-started:id1}{{2.3}{6}{Windows installation}{section.2.3}{}}
|
||||
\@writefile{toc}{\contentsline {section}{\numberline {2.4}Running the desktop app}{7}{section.2.4}\protected@file@percent }
|
||||
\newlabel{getting-started:running-the-desktop-app}{{2.4}{7}{Running the desktop app}{section.2.4}{}}
|
||||
\@writefile{toc}{\contentsline {section}{\numberline {2.5}Opening the web edition}{7}{section.2.5}\protected@file@percent }
|
||||
\newlabel{getting-started:opening-the-web-edition}{{2.5}{7}{Opening the web edition}{section.2.5}{}}
|
||||
\@writefile{toc}{\contentsline {section}{\numberline {2.6}The Quick Start guide}{7}{section.2.6}\protected@file@percent }
|
||||
\newlabel{getting-started:the-quick-start-guide}{{2.6}{7}{The Quick Start guide}{section.2.6}{}}
|
||||
\@writefile{toc}{\contentsline {section}{\numberline {2.7}Support}{7}{section.2.7}\protected@file@percent }
|
||||
\newlabel{getting-started:support}{{2.7}{7}{Support}{section.2.7}{}}
|
||||
\@writefile{toc}{\contentsline {chapter}{\numberline {3}Runs and fitting}{9}{chapter.3}\protected@file@percent }
|
||||
\@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 }
|
||||
\@writefile{lof}{\addvspace {10\p@ }}
|
||||
\@writefile{lot}{\addvspace {10\p@ }}
|
||||
\newlabel{runs-fitting:runs-and-fitting}{{3}{9}{Runs and fitting}{chapter.3}{}}
|
||||
\newlabel{runs-fitting::doc}{{3}{9}{Runs and fitting}{chapter.3}{}}
|
||||
\@writefile{toc}{\contentsline {section}{\numberline {3.1}Run selection}{9}{section.3.1}\protected@file@percent }
|
||||
\newlabel{runs-fitting:run-selection}{{3.1}{9}{Run selection}{section.3.1}{}}
|
||||
\@writefile{toc}{\contentsline {section}{\numberline {3.2}Fit range}{10}{section.3.2}\protected@file@percent }
|
||||
\newlabel{runs-fitting:fit-range}{{3.2}{10}{Fit range}{section.3.2}{}}
|
||||
\@writefile{toc}{\contentsline {section}{\numberline {3.3}Fit model}{10}{section.3.3}\protected@file@percent }
|
||||
\newlabel{runs-fitting:fit-model}{{3.3}{10}{Fit model}{section.3.3}{}}
|
||||
\@writefile{toc}{\contentsline {section}{\numberline {3.4}Fit options}{11}{section.3.4}\protected@file@percent }
|
||||
\newlabel{runs-fitting:fit-options}{{3.4}{11}{Fit options}{section.3.4}{}}
|
||||
\@writefile{toc}{\contentsline {section}{\numberline {3.5}Series fit actions}{11}{section.3.5}\protected@file@percent }
|
||||
\newlabel{runs-fitting:series-fit-actions}{{3.5}{11}{Series fit actions}{section.3.5}{}}
|
||||
\@writefile{toc}{\contentsline {subsection}{\numberline {3.5.1}Per\sphinxhyphen {}run statistics}{11}{subsection.3.5.1}\protected@file@percent }
|
||||
\newlabel{runs-fitting:per-run-statistics}{{3.5.1}{11}{Per\sphinxhyphen {}run statistics}{subsection.3.5.1}{}}
|
||||
\@writefile{toc}{\contentsline {section}{\numberline {3.6}View settings}{12}{section.3.6}\protected@file@percent }
|
||||
\newlabel{runs-fitting:view-settings}{{3.6}{12}{View settings}{section.3.6}{}}
|
||||
\@writefile{toc}{\contentsline {section}{\numberline {3.7}Fit and Plot}{12}{section.3.7}\protected@file@percent }
|
||||
\newlabel{runs-fitting:fit-and-plot}{{3.7}{12}{Fit and Plot}{section.3.7}{}}
|
||||
\@writefile{toc}{\contentsline {chapter}{\numberline {4}Parameters and parameter plots}{15}{chapter.4}\protected@file@percent }
|
||||
\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 }
|
||||
\@writefile{lof}{\addvspace {10\p@ }}
|
||||
\@writefile{lot}{\addvspace {10\p@ }}
|
||||
\newlabel{parameters-plots:parameters-and-parameter-plots}{{4}{15}{Parameters and parameter plots}{chapter.4}{}}
|
||||
\newlabel{parameters-plots::doc}{{4}{15}{Parameters and parameter plots}{chapter.4}{}}
|
||||
\@writefile{toc}{\contentsline {section}{\numberline {4.1}The parameter table}{15}{section.4.1}\protected@file@percent }
|
||||
\newlabel{parameters-plots:the-parameter-table}{{4.1}{15}{The parameter table}{section.4.1}{}}
|
||||
\@writefile{toc}{\contentsline {subsection}{\numberline {4.1.1}The \sphinxstylestrong {Shared} column}{16}{subsection.4.1.1}\protected@file@percent }
|
||||
\newlabel{parameters-plots:the-shared-column}{{4.1.1}{16}{The \sphinxstylestrong {Shared} column}{subsection.4.1.1}{}}
|
||||
\@writefile{toc}{\contentsline {section}{\numberline {4.2}Selecting parameters for plotting}{16}{section.4.2}\protected@file@percent }
|
||||
\newlabel{parameters-plots:selecting-parameters-for-plotting}{{4.2}{16}{Selecting parameters for plotting}{section.4.2}{}}
|
||||
\@writefile{toc}{\contentsline {section}{\numberline {4.3}The Choose X axis dialog}{16}{section.4.3}\protected@file@percent }
|
||||
\newlabel{parameters-plots:the-choose-x-axis-dialog}{{4.3}{16}{The Choose X axis dialog}{section.4.3}{}}
|
||||
\@writefile{toc}{\contentsline {section}{\numberline {4.4}The parameter\sphinxhyphen {}plot window}{16}{section.4.4}\protected@file@percent }
|
||||
\newlabel{parameters-plots:the-parameter-plot-window}{{4.4}{16}{The parameter\sphinxhyphen {}plot window}{section.4.4}{}}
|
||||
\@writefile{toc}{\contentsline {subsection}{\numberline {4.4.1}Plot options}{17}{subsection.4.4.1}\protected@file@percent }
|
||||
\newlabel{parameters-plots:plot-options}{{4.4.1}{17}{Plot options}{subsection.4.4.1}{}}
|
||||
\@writefile{toc}{\contentsline {subsection}{\numberline {4.4.2}Remembered plot configurations}{17}{subsection.4.4.2}\protected@file@percent }
|
||||
\newlabel{parameters-plots:remembered-plot-configurations}{{4.4.2}{17}{Remembered plot configurations}{subsection.4.4.2}{}}
|
||||
\newlabel{parameters-plots:id1}{{4.4.2}{17}{Remembered plot configurations}{subsection.4.4.2}{}}
|
||||
\@writefile{toc}{\contentsline {subsection}{\numberline {4.4.3}Overlay data sets (multiple files in one panel)}{18}{subsection.4.4.3}\protected@file@percent }
|
||||
\newlabel{parameters-plots:overlay-data-sets-multiple-files-in-one-panel}{{4.4.3}{18}{Overlay data sets (multiple files in one panel)}{subsection.4.4.3}{}}
|
||||
\@writefile{toc}{\contentsline {subsection}{\numberline {4.4.4}Editing trace styles}{19}{subsection.4.4.4}\protected@file@percent }
|
||||
\newlabel{parameters-plots:editing-trace-styles}{{4.4.4}{19}{Editing trace styles}{subsection.4.4.4}{}}
|
||||
\@writefile{toc}{\contentsline {subsection}{\numberline {4.4.5}Template and series presets}{19}{subsection.4.4.5}\protected@file@percent }
|
||||
\newlabel{parameters-plots:template-and-series-presets}{{4.4.5}{19}{Template and series presets}{subsection.4.4.5}{}}
|
||||
\@writefile{toc}{\contentsline {subsection}{\numberline {4.4.6}Keyboard shortcuts}{19}{subsection.4.4.6}\protected@file@percent }
|
||||
\newlabel{parameters-plots:keyboard-shortcuts}{{4.4.6}{19}{Keyboard shortcuts}{subsection.4.4.6}{}}
|
||||
\@writefile{toc}{\contentsline {chapter}{\numberline {5}Constraints}{21}{chapter.5}\protected@file@percent }
|
||||
\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 }
|
||||
\@writefile{lof}{\addvspace {10\p@ }}
|
||||
\@writefile{lot}{\addvspace {10\p@ }}
|
||||
\newlabel{constraints:constraints}{{5}{21}{Constraints}{chapter.5}{}}
|
||||
\newlabel{constraints::doc}{{5}{21}{Constraints}{chapter.5}{}}
|
||||
\@writefile{toc}{\contentsline {section}{\numberline {5.1}Custom parameters}{21}{section.5.1}\protected@file@percent }
|
||||
\newlabel{constraints:custom-parameters}{{5.1}{21}{Custom parameters}{section.5.1}{}}
|
||||
\@writefile{toc}{\contentsline {section}{\numberline {5.2}Constraints}{21}{section.5.2}\protected@file@percent }
|
||||
\newlabel{constraints:id1}{{5.2}{21}{Constraints}{section.5.2}{}}
|
||||
\@writefile{toc}{\contentsline {section}{\numberline {5.3}Example: couple the magnetic field to the Larmor frequency}{22}{section.5.3}\protected@file@percent }
|
||||
\newlabel{constraints:example-couple-the-magnetic-field-to-the-larmor-frequency}{{5.3}{22}{Example: couple the magnetic field to the Larmor frequency}{section.5.3}{}}
|
||||
\@writefile{toc}{\contentsline {section}{\numberline {5.4}Preview}{22}{section.5.4}\protected@file@percent }
|
||||
\newlabel{constraints:preview}{{5.4}{22}{Preview}{section.5.4}{}}
|
||||
\@writefile{toc}{\contentsline {chapter}{\numberline {6}t0 / background}{23}{chapter.6}\protected@file@percent }
|
||||
\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 }
|
||||
\@writefile{lof}{\addvspace {10\p@ }}
|
||||
\@writefile{lot}{\addvspace {10\p@ }}
|
||||
\newlabel{t0-background:t0-background}{{6}{23}{t0 / background}{chapter.6}{}}
|
||||
\newlabel{t0-background::doc}{{6}{23}{t0 / background}{chapter.6}{}}
|
||||
\@writefile{toc}{\contentsline {section}{\numberline {6.1}Multi\sphinxhyphen {}group asymmetry fits}{23}{section.6.1}\protected@file@percent }
|
||||
\newlabel{t0-background:multi-group-asymmetry-fits}{{6.1}{23}{Multi\sphinxhyphen {}group asymmetry fits}{section.6.1}{}}
|
||||
\@writefile{toc}{\contentsline {chapter}{\numberline {7}MSR editor}{25}{chapter.7}\protected@file@percent }
|
||||
\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 }
|
||||
\@writefile{lof}{\addvspace {10\p@ }}
|
||||
\@writefile{lot}{\addvspace {10\p@ }}
|
||||
\newlabel{msr-editor:msr-editor}{{7}{25}{MSR editor}{chapter.7}{}}
|
||||
\newlabel{msr-editor::doc}{{7}{25}{MSR editor}{chapter.7}{}}
|
||||
\@writefile{toc}{\contentsline {section}{\numberline {7.1}Ownership: GUI or editor}{25}{section.7.1}\protected@file@percent }
|
||||
\newlabel{msr-editor:ownership-gui-or-editor}{{7.1}{25}{Ownership: GUI or editor}{section.7.1}{}}
|
||||
\@writefile{toc}{\contentsline {section}{\numberline {7.2}Workflow}{25}{section.7.2}\protected@file@percent }
|
||||
\newlabel{msr-editor:workflow}{{7.2}{25}{Workflow}{section.7.2}{}}
|
||||
\@writefile{toc}{\contentsline {section}{\numberline {7.3}File handling}{26}{section.7.3}\protected@file@percent }
|
||||
\newlabel{msr-editor:file-handling}{{7.3}{26}{File handling}{section.7.3}{}}
|
||||
\@writefile{toc}{\contentsline {chapter}{\numberline {8}Results and diagnostics}{27}{chapter.8}\protected@file@percent }
|
||||
\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 }
|
||||
\@writefile{lof}{\addvspace {10\p@ }}
|
||||
\@writefile{lot}{\addvspace {10\p@ }}
|
||||
\newlabel{results-diagnostics:results-and-diagnostics}{{8}{27}{Results and diagnostics}{chapter.8}{}}
|
||||
\newlabel{results-diagnostics::doc}{{8}{27}{Results and diagnostics}{chapter.8}{}}
|
||||
\@writefile{toc}{\contentsline {section}{\numberline {8.1}Result files}{27}{section.8.1}\protected@file@percent }
|
||||
\newlabel{results-diagnostics:result-files}{{8.1}{27}{Result files}{section.8.1}{}}
|
||||
\@writefile{toc}{\contentsline {section}{\numberline {8.2}Execution details}{27}{section.8.2}\protected@file@percent }
|
||||
\newlabel{results-diagnostics:execution-details}{{8.2}{27}{Execution details}{section.8.2}{}}
|
||||
\@writefile{toc}{\contentsline {section}{\numberline {8.3}Command log}{28}{section.8.3}\protected@file@percent }
|
||||
\newlabel{results-diagnostics:command-log}{{8.3}{28}{Command log}{section.8.3}{}}
|
||||
\@writefile{toc}{\contentsline {section}{\numberline {8.4}The status bar}{28}{section.8.4}\protected@file@percent }
|
||||
\newlabel{results-diagnostics:the-status-bar}{{8.4}{28}{The status bar}{section.8.4}{}}
|
||||
\@writefile{toc}{\contentsline {section}{\numberline {8.5}Run log window}{28}{section.8.5}\protected@file@percent }
|
||||
\newlabel{results-diagnostics:run-log-window}{{8.5}{28}{Run log window}{section.8.5}{}}
|
||||
\@writefile{toc}{\contentsline {section}{\numberline {8.6}Outcome dialog}{28}{section.8.6}\protected@file@percent }
|
||||
\newlabel{results-diagnostics:outcome-dialog}{{8.6}{28}{Outcome dialog}{section.8.6}{}}
|
||||
\@writefile{toc}{\contentsline {chapter}{\numberline {9}Configuration sharing}{29}{chapter.9}\protected@file@percent }
|
||||
\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 }
|
||||
\@writefile{lof}{\addvspace {10\p@ }}
|
||||
\@writefile{lot}{\addvspace {10\p@ }}
|
||||
\newlabel{configuration-sharing:configuration-sharing}{{9}{29}{Configuration sharing}{chapter.9}{}}
|
||||
\newlabel{configuration-sharing::doc}{{9}{29}{Configuration sharing}{chapter.9}{}}
|
||||
\@writefile{toc}{\contentsline {section}{\numberline {9.1}What is shared}{29}{section.9.1}\protected@file@percent }
|
||||
\newlabel{configuration-sharing:what-is-shared}{{9.1}{29}{What is shared}{section.9.1}{}}
|
||||
\@writefile{toc}{\contentsline {section}{\numberline {9.2}On the web}{29}{section.9.2}\protected@file@percent }
|
||||
\newlabel{configuration-sharing:on-the-web}{{9.2}{29}{On the web}{section.9.2}{}}
|
||||
\@writefile{toc}{\contentsline {section}{\numberline {9.3}On the desktop}{30}{section.9.3}\protected@file@percent }
|
||||
\newlabel{configuration-sharing:on-the-desktop}{{9.3}{30}{On the desktop}{section.9.3}{}}
|
||||
\@writefile{toc}{\contentsline {section}{\numberline {9.4}Notes}{30}{section.9.4}\protected@file@percent }
|
||||
\newlabel{configuration-sharing:notes}{{9.4}{30}{Notes}{section.9.4}{}}
|
||||
\@writefile{toc}{\contentsline {chapter}{\numberline {10}Preferences}{31}{chapter.10}\protected@file@percent }
|
||||
\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 }
|
||||
\@writefile{lof}{\addvspace {10\p@ }}
|
||||
\@writefile{lot}{\addvspace {10\p@ }}
|
||||
\newlabel{preferences:preferences}{{10}{31}{Preferences}{chapter.10}{}}
|
||||
\newlabel{preferences::doc}{{10}{31}{Preferences}{chapter.10}{}}
|
||||
\@writefile{toc}{\contentsline {chapter}{\numberline {11}Web and desktop editions}{33}{chapter.11}\protected@file@percent }
|
||||
\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 }
|
||||
\@writefile{lof}{\addvspace {10\p@ }}
|
||||
\@writefile{lot}{\addvspace {10\p@ }}
|
||||
\newlabel{platforms:web-and-desktop-editions}{{11}{33}{Web and desktop editions}{chapter.11}{}}
|
||||
\newlabel{platforms::doc}{{11}{33}{Web and desktop editions}{chapter.11}{}}
|
||||
\@writefile{toc}{\contentsline {section}{\numberline {11.1}Bundled ROOT and musrfit}{33}{section.11.1}\protected@file@percent }
|
||||
\newlabel{platforms:bundled-root-and-musrfit}{{11.1}{33}{Bundled ROOT and musrfit}{section.11.1}{}}
|
||||
\@writefile{toc}{\contentsline {section}{\numberline {11.2}Downloading missing runs}{34}{section.11.2}\protected@file@percent }
|
||||
\newlabel{platforms:downloading-missing-runs}{{11.2}{34}{Downloading missing runs}{section.11.2}{}}
|
||||
\@writefile{toc}{\contentsline {chapter}{\numberline {12}Keyboard shortcuts}{35}{chapter.12}\protected@file@percent }
|
||||
\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 }
|
||||
\@writefile{lof}{\addvspace {10\p@ }}
|
||||
\@writefile{lot}{\addvspace {10\p@ }}
|
||||
\newlabel{keyboard-shortcuts:keyboard-shortcuts}{{12}{35}{Keyboard shortcuts}{chapter.12}{}}
|
||||
\newlabel{keyboard-shortcuts::doc}{{12}{35}{Keyboard shortcuts}{chapter.12}{}}
|
||||
\@writefile{toc}{\contentsline {section}{\numberline {12.1}Parameter selection (Parameters tab)}{35}{section.12.1}\protected@file@percent }
|
||||
\newlabel{keyboard-shortcuts:parameter-selection-parameters-tab}{{12.1}{35}{Parameter selection (Parameters tab)}{section.12.1}{}}
|
||||
\@writefile{toc}{\contentsline {section}{\numberline {12.2}Parameter\sphinxhyphen {}plot window}{35}{section.12.2}\protected@file@percent }
|
||||
\newlabel{keyboard-shortcuts:parameter-plot-window}{{12.2}{35}{Parameter\sphinxhyphen {}plot window}{section.12.2}{}}
|
||||
\@writefile{toc}{\contentsline {section}{\numberline {12.3}MSR editor}{35}{section.12.3}\protected@file@percent }
|
||||
\newlabel{keyboard-shortcuts:msr-editor}{{12.3}{35}{MSR editor}{section.12.3}{}}
|
||||
\@writefile{toc}{\contentsline {section}{\numberline {12.4}General notes}{36}{section.12.4}\protected@file@percent }
|
||||
\newlabel{keyboard-shortcuts:general-notes}{{12.4}{36}{General notes}{section.12.4}{}}
|
||||
\@writefile{toc}{\contentsline {chapter}{\numberline {13}Troubleshooting}{37}{chapter.13}\protected@file@percent }
|
||||
\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 }
|
||||
\@writefile{lof}{\addvspace {10\p@ }}
|
||||
\@writefile{lot}{\addvspace {10\p@ }}
|
||||
\newlabel{troubleshooting:troubleshooting}{{13}{37}{Troubleshooting}{chapter.13}{}}
|
||||
\newlabel{troubleshooting::doc}{{13}{37}{Troubleshooting}{chapter.13}{}}
|
||||
\@writefile{toc}{\contentsline {section}{\numberline {13.1}Fit or plot will not start}{37}{section.13.1}\protected@file@percent }
|
||||
\newlabel{troubleshooting:fit-or-plot-will-not-start}{{13.1}{37}{Fit or plot will not start}{section.13.1}{}}
|
||||
\@writefile{toc}{\contentsline {section}{\numberline {13.2}“Nothing to fit”}{37}{section.13.2}\protected@file@percent }
|
||||
\newlabel{troubleshooting:nothing-to-fit}{{13.2}{37}{“Nothing to fit”}{section.13.2}{}}
|
||||
\@writefile{toc}{\contentsline {section}{\numberline {13.3}Fitted parameters look wrong or unchanged}{37}{section.13.3}\protected@file@percent }
|
||||
\newlabel{troubleshooting:fitted-parameters-look-wrong-or-unchanged}{{13.3}{37}{Fitted parameters look wrong or unchanged}{section.13.3}{}}
|
||||
\@writefile{toc}{\contentsline {section}{\numberline {13.4}Parameter plot is empty or missing data}{38}{section.13.4}\protected@file@percent }
|
||||
\newlabel{troubleshooting:parameter-plot-is-empty-or-missing-data}{{13.4}{38}{Parameter plot is empty or missing data}{section.13.4}{}}
|
||||
\@writefile{toc}{\contentsline {section}{\numberline {13.5}Parameter plot hangs on “Preparing plot files”}{38}{section.13.5}\protected@file@percent }
|
||||
\newlabel{troubleshooting:parameter-plot-hangs-on-preparing-plot-files}{{13.5}{38}{Parameter plot hangs on “Preparing plot files”}{section.13.5}{}}
|
||||
\@writefile{toc}{\contentsline {section}{\numberline {13.6}Web page cannot load data}{38}{section.13.6}\protected@file@percent }
|
||||
\newlabel{troubleshooting:web-page-cannot-load-data}{{13.6}{38}{Web page cannot load data}{section.13.6}{}}
|
||||
\@writefile{toc}{\contentsline {section}{\numberline {13.7}Restored configuration differs from the original machine}{38}{section.13.7}\protected@file@percent }
|
||||
\newlabel{troubleshooting:restored-configuration-differs-from-the-original-machine}{{13.7}{38}{Restored configuration differs from the original machine}{section.13.7}{}}
|
||||
\@writefile{toc}{\contentsline {section}{\numberline {13.8}Some links start with a different prefix}{38}{section.13.8}\protected@file@percent }
|
||||
\newlabel{troubleshooting:some-links-start-with-a-different-prefix}{{13.8}{38}{Some links start with a different prefix}{section.13.8}{}}
|
||||
\@writefile{toc}{\contentsline {section}{\numberline {13.9}Reporting problems}{39}{section.13.9}\protected@file@percent }
|
||||
\newlabel{troubleshooting:reporting-problems}{{13.9}{39}{Reporting problems}{section.13.9}{}}
|
||||
\@writefile{toc}{\contentsline {chapter}{\numberline {14}Glossary}{41}{chapter.14}\protected@file@percent }
|
||||
\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 }
|
||||
\@writefile{lof}{\addvspace {10\p@ }}
|
||||
\@writefile{lot}{\addvspace {10\p@ }}
|
||||
\newlabel{glossary:glossary}{{14}{41}{Glossary}{chapter.14}{}}
|
||||
\newlabel{glossary::doc}{{14}{41}{Glossary}{chapter.14}{}}
|
||||
\newlabel{glossary:term-MSR}{{14}{41}{\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}{{14}{41}{\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}{{14}{41}{\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}{{14}{41}{\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}{{14}{41}{\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}{{14}{41}{\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}{{14}{41}{\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}{{14}{41}{\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}{{14}{42}{\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}{{14}{42}{\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}{{14}{42}{\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}{{14}{42}{\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}{{14}{42}{\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}{{14}{42}{\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}{{14}{42}{\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}{43}{section*.18}\protected@file@percent }
|
||||
\gdef \@abspage@last{49}
|
||||
\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 }
|
||||
\@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 }
|
||||
\@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}
|
||||
+10
-10
@@ -1,11 +1,11 @@
|
||||
# Fdb version 4
|
||||
["makeindex muSRFlow.idx"] 1793028186.11994 "muSRFlow.idx" "muSRFlow.ind" "muSRFlow" 1793028190.94115 0
|
||||
"muSRFlow.idx" 1793028190.82974 1189 5790029dbaf869d30977269e57c06377 "pdflatex"
|
||||
["makeindex muSRFlow.idx"] 1793204525.53118 "muSRFlow.idx" "muSRFlow.ind" "muSRFlow" 1793204528.17168 0
|
||||
"muSRFlow.idx" 1793204528.0544 1189 836524d7a2d297107884b9a35219f43e "pdflatex"
|
||||
(generated)
|
||||
"muSRFlow.ilg"
|
||||
"muSRFlow.ind"
|
||||
(rewritten before read)
|
||||
["pdflatex"] 1793028188.63225 "muSRFlow.tex" "muSRFlow.pdf" "muSRFlow" 1793028190.94128 0
|
||||
["pdflatex"] 1793204525.61009 "muSRFlow.tex" "muSRFlow.pdf" "muSRFlow" 1793204528.17182 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,13 @@
|
||||
"/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" 1793028190.82721 24989 a0d267ce07f7d575f951b896f7aeb0f6 "pdflatex"
|
||||
"muSRFlow.ind" 1793028186.20124 1435 0da71b06df8320c7589ce0de1b04c202 "makeindex muSRFlow.idx"
|
||||
"muSRFlow.out" 1793028190.82721 12276 971bd205bbdbdd0841e89ab3fae4d880 "pdflatex"
|
||||
"muSRFlow.tex" 1793028183.49439 91121 481384c78f21eea4308ab872027e75c1 ""
|
||||
"muSRFlow.toc" 1793028190.82974 6415 cd38e6c623192d801317235ca105f909 "pdflatex"
|
||||
"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"
|
||||
"sphinx.sty" 1789374174.58095 54203 ee7fe875437470f5328ee20661bb9f1d ""
|
||||
"sphinxhighlight.sty" 1793028183.38597 7553 83fb52292c17957d9f4aadcb28c57a87 ""
|
||||
"sphinxhighlight.sty" 1793204522.50945 7553 83fb52292c17957d9f4aadcb28c57a87 ""
|
||||
"sphinxlatexadmonitions.sty" 1789374174.58095 19111 5e67a0f91439018bceb7cadf319345e6 ""
|
||||
"sphinxlatexcontainers.sty" 1789374174.58295 900 d61f923db071a7b54d3cee8a1e6935d3 ""
|
||||
"sphinxlatexgraphics.sty" 1789374174.58295 4918 c9266041d02bc615d54b890e96e3acd3 ""
|
||||
@@ -140,7 +140,7 @@
|
||||
"sphinxlatexstyletext.sty" 1789374174.58495 6759 9e932c65374cfb62686485d331bc975c ""
|
||||
"sphinxlatextables.sty" 1789374174.58495 57643 7f1013c2fa11942370d867527bdda568 ""
|
||||
"sphinxmanual.cls" 1789374174.58495 4241 7b0d7a37df7b5715fb0dbd585c52ecdb ""
|
||||
"sphinxmessages.sty" 1793028183.49813 745 3f5fcd6cdd7964ed608767954a8ced6f ""
|
||||
"sphinxmessages.sty" 1793204522.72886 745 3f5fcd6cdd7964ed608767954a8ced6f ""
|
||||
"sphinxoptionsgeometry.sty" 1789374174.58695 2060 6c27b3eba37bde592ae8908ab2c1ac0f ""
|
||||
"sphinxoptionshyperref.sty" 1789374174.58695 1093 e468489bae7631a7f387b4b0f7bc15d4 ""
|
||||
"sphinxpackageboxes.sty" 1789374174.58695 36106 1be2053eb1cb9b083b3a75e3657bcb24 ""
|
||||
|
||||
Vendored
+15
-15
@@ -1,15 +1,15 @@
|
||||
\indexentry{MSR@\spxentry{MSR}|hyperxindexformat{\spxpagem}}{41}
|
||||
\indexentry{fit document@\spxentry{fit document}|hyperxindexformat{\spxpagem}}{41}
|
||||
\indexentry{RUN@\spxentry{RUN}|hyperxindexformat{\spxpagem}}{41}
|
||||
\indexentry{ADDRUN@\spxentry{ADDRUN}|hyperxindexformat{\spxpagem}}{41}
|
||||
\indexentry{independent\sphinxhyphen {}series fit@\spxentry{independent\sphinxhyphen {}series fit}|hyperxindexformat{\spxpagem}}{41}
|
||||
\indexentry{global parameter@\spxentry{global parameter}|hyperxindexformat{\spxpagem}}{41}
|
||||
\indexentry{par.dat@\spxentry{par.dat}|hyperxindexformat{\spxpagem}}{41}
|
||||
\indexentry{musrfit@\spxentry{musrfit}|hyperxindexformat{\spxpagem}}{41}
|
||||
\indexentry{musrview@\spxentry{musrview}|hyperxindexformat{\spxpagem}}{42}
|
||||
\indexentry{msr2data@\spxentry{msr2data}|hyperxindexformat{\spxpagem}}{42}
|
||||
\indexentry{dump\_header@\spxentry{dump\_header}|hyperxindexformat{\spxpagem}}{42}
|
||||
\indexentry{ROOT plot@\spxentry{ROOT plot}|hyperxindexformat{\spxpagem}}{42}
|
||||
\indexentry{RRF@\spxentry{RRF}|hyperxindexformat{\spxpagem}}{42}
|
||||
\indexentry{FFT@\spxentry{FFT}|hyperxindexformat{\spxpagem}}{42}
|
||||
\indexentry{configuration link@\spxentry{configuration link}|hyperxindexformat{\spxpagem}}{42}
|
||||
\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}
|
||||
Vendored
+15
-15
@@ -5,44 +5,44 @@
|
||||
\let\spxextra \sphinxstyleindexextra
|
||||
|
||||
\bigletter A
|
||||
\item \spxentry{ADDRUN}, \hyperxindexformat{\spxpagem}{41}
|
||||
\item \spxentry{ADDRUN}, \hyperxindexformat{\spxpagem}{47}
|
||||
|
||||
\indexspace
|
||||
\bigletter C
|
||||
\item \spxentry{configuration link}, \hyperxindexformat{\spxpagem}{42}
|
||||
\item \spxentry{configuration link}, \hyperxindexformat{\spxpagem}{48}
|
||||
|
||||
\indexspace
|
||||
\bigletter D
|
||||
\item \spxentry{dump\_header}, \hyperxindexformat{\spxpagem}{42}
|
||||
\item \spxentry{dump\_header}, \hyperxindexformat{\spxpagem}{48}
|
||||
|
||||
\indexspace
|
||||
\bigletter F
|
||||
\item \spxentry{FFT}, \hyperxindexformat{\spxpagem}{42}
|
||||
\item \spxentry{fit document}, \hyperxindexformat{\spxpagem}{41}
|
||||
\item \spxentry{FFT}, \hyperxindexformat{\spxpagem}{48}
|
||||
\item \spxentry{fit document}, \hyperxindexformat{\spxpagem}{47}
|
||||
|
||||
\indexspace
|
||||
\bigletter G
|
||||
\item \spxentry{global parameter}, \hyperxindexformat{\spxpagem}{41}
|
||||
\item \spxentry{global parameter}, \hyperxindexformat{\spxpagem}{47}
|
||||
|
||||
\indexspace
|
||||
\bigletter I
|
||||
\item \spxentry{independent\sphinxhyphen {}series fit}, \hyperxindexformat{\spxpagem}{41}
|
||||
\item \spxentry{independent\sphinxhyphen {}series fit}, \hyperxindexformat{\spxpagem}{47}
|
||||
|
||||
\indexspace
|
||||
\bigletter M
|
||||
\item \spxentry{MSR}, \hyperxindexformat{\spxpagem}{41}
|
||||
\item \spxentry{msr2data}, \hyperxindexformat{\spxpagem}{42}
|
||||
\item \spxentry{musrfit}, \hyperxindexformat{\spxpagem}{41}
|
||||
\item \spxentry{musrview}, \hyperxindexformat{\spxpagem}{42}
|
||||
\item \spxentry{MSR}, \hyperxindexformat{\spxpagem}{47}
|
||||
\item \spxentry{msr2data}, \hyperxindexformat{\spxpagem}{48}
|
||||
\item \spxentry{musrfit}, \hyperxindexformat{\spxpagem}{47}
|
||||
\item \spxentry{musrview}, \hyperxindexformat{\spxpagem}{48}
|
||||
|
||||
\indexspace
|
||||
\bigletter P
|
||||
\item \spxentry{par.dat}, \hyperxindexformat{\spxpagem}{41}
|
||||
\item \spxentry{par.dat}, \hyperxindexformat{\spxpagem}{47}
|
||||
|
||||
\indexspace
|
||||
\bigletter R
|
||||
\item \spxentry{ROOT plot}, \hyperxindexformat{\spxpagem}{42}
|
||||
\item \spxentry{RRF}, \hyperxindexformat{\spxpagem}{42}
|
||||
\item \spxentry{RUN}, \hyperxindexformat{\spxpagem}{41}
|
||||
\item \spxentry{ROOT plot}, \hyperxindexformat{\spxpagem}{48}
|
||||
\item \spxentry{RRF}, \hyperxindexformat{\spxpagem}{48}
|
||||
\item \spxentry{RUN}, \hyperxindexformat{\spxpagem}{47}
|
||||
|
||||
\end{sphinxtheindex}
|
||||
Vendored
+89
-67
@@ -4,75 +4,97 @@
|
||||
\BOOKMARK [1][-]{section.1.3}{\376\377\000T\000w\000o\000\040\000e\000d\000i\000t\000i\000o\000n\000s}{chapter.1}% 4
|
||||
\BOOKMARK [1][-]{section.1.4}{\376\377\000A\000\040\000f\000i\000r\000s\000t\000\040\000f\000i\000t}{chapter.1}% 5
|
||||
\BOOKMARK [0][-]{chapter.2}{\376\377\000G\000e\000t\000t\000i\000n\000g\000\040\000s\000t\000a\000r\000t\000e\000d}{}% 6
|
||||
\BOOKMARK [1][-]{section.2.1}{\376\377\000P\000r\000e\000r\000e\000q\000u\000i\000s\000i\000t\000e\000s}{chapter.2}% 7
|
||||
\BOOKMARK [1][-]{section.2.2}{\376\377\000D\000e\000v\000e\000l\000o\000p\000m\000e\000n\000t\000\040\000a\000n\000d\000\040\000L\000i\000n\000u\000x\000\040\000p\000a\000c\000k\000a\000g\000e\000s}{chapter.2}% 8
|
||||
\BOOKMARK [1][-]{section.2.1}{\376\377\000C\000h\000o\000o\000s\000e\000\040\000y\000o\000u\000r\000\040\000e\000d\000i\000t\000i\000o\000n}{chapter.2}% 7
|
||||
\BOOKMARK [1][-]{section.2.2}{\376\377\000D\000e\000s\000k\000t\000o\000p\000\040\000i\000n\000s\000t\000a\000l\000l\000a\000t\000i\000o\000n}{chapter.2}% 8
|
||||
\BOOKMARK [1][-]{section.2.3}{\376\377\000W\000i\000n\000d\000o\000w\000s\000\040\000i\000n\000s\000t\000a\000l\000l\000a\000t\000i\000o\000n}{chapter.2}% 9
|
||||
\BOOKMARK [1][-]{section.2.4}{\376\377\000R\000u\000n\000n\000i\000n\000g\000\040\000t\000h\000e\000\040\000d\000e\000s\000k\000t\000o\000p\000\040\000a\000p\000p}{chapter.2}% 10
|
||||
\BOOKMARK [1][-]{section.2.5}{\376\377\000O\000p\000e\000n\000i\000n\000g\000\040\000t\000h\000e\000\040\000w\000e\000b\000\040\000e\000d\000i\000t\000i\000o\000n}{chapter.2}% 11
|
||||
\BOOKMARK [1][-]{section.2.6}{\376\377\000T\000h\000e\000\040\000Q\000u\000i\000c\000k\000\040\000S\000t\000a\000r\000t\000\040\000g\000u\000i\000d\000e}{chapter.2}% 12
|
||||
\BOOKMARK [1][-]{section.2.7}{\376\377\000S\000u\000p\000p\000o\000r\000t}{chapter.2}% 13
|
||||
\BOOKMARK [0][-]{chapter.3}{\376\377\000R\000u\000n\000s\000\040\000a\000n\000d\000\040\000f\000i\000t\000t\000i\000n\000g}{}% 14
|
||||
\BOOKMARK [1][-]{section.3.1}{\376\377\000R\000u\000n\000\040\000s\000e\000l\000e\000c\000t\000i\000o\000n}{chapter.3}% 15
|
||||
\BOOKMARK [1][-]{section.3.2}{\376\377\000F\000i\000t\000\040\000r\000a\000n\000g\000e}{chapter.3}% 16
|
||||
\BOOKMARK [1][-]{section.3.3}{\376\377\000F\000i\000t\000\040\000m\000o\000d\000e\000l}{chapter.3}% 17
|
||||
\BOOKMARK [1][-]{section.3.4}{\376\377\000F\000i\000t\000\040\000o\000p\000t\000i\000o\000n\000s}{chapter.3}% 18
|
||||
\BOOKMARK [1][-]{section.3.5}{\376\377\000S\000e\000r\000i\000e\000s\000\040\000f\000i\000t\000\040\000a\000c\000t\000i\000o\000n\000s}{chapter.3}% 19
|
||||
\BOOKMARK [2][-]{subsection.3.5.1}{\376\377\000P\000e\000r\000-\000r\000u\000n\000\040\000s\000t\000a\000t\000i\000s\000t\000i\000c\000s}{section.3.5}% 20
|
||||
\BOOKMARK [1][-]{section.3.6}{\376\377\000V\000i\000e\000w\000\040\000s\000e\000t\000t\000i\000n\000g\000s}{chapter.3}% 21
|
||||
\BOOKMARK [1][-]{section.3.7}{\376\377\000F\000i\000t\000\040\000a\000n\000d\000\040\000P\000l\000o\000t}{chapter.3}% 22
|
||||
\BOOKMARK [0][-]{chapter.4}{\376\377\000P\000a\000r\000a\000m\000e\000t\000e\000r\000s\000\040\000a\000n\000d\000\040\000p\000a\000r\000a\000m\000e\000t\000e\000r\000\040\000p\000l\000o\000t\000s}{}% 23
|
||||
\BOOKMARK [1][-]{section.4.1}{\376\377\000T\000h\000e\000\040\000p\000a\000r\000a\000m\000e\000t\000e\000r\000\040\000t\000a\000b\000l\000e}{chapter.4}% 24
|
||||
\BOOKMARK [2][-]{subsection.4.1.1}{\376\377\000T\000h\000e\000\040\000S\000h\000a\000r\000e\000d\000\040\000c\000o\000l\000u\000m\000n}{section.4.1}% 25
|
||||
\BOOKMARK [1][-]{section.4.2}{\376\377\000S\000e\000l\000e\000c\000t\000i\000n\000g\000\040\000p\000a\000r\000a\000m\000e\000t\000e\000r\000s\000\040\000f\000o\000r\000\040\000p\000l\000o\000t\000t\000i\000n\000g}{chapter.4}% 26
|
||||
\BOOKMARK [1][-]{section.4.3}{\376\377\000T\000h\000e\000\040\000C\000h\000o\000o\000s\000e\000\040\000X\000\040\000a\000x\000i\000s\000\040\000d\000i\000a\000l\000o\000g}{chapter.4}% 27
|
||||
\BOOKMARK [1][-]{section.4.4}{\376\377\000T\000h\000e\000\040\000p\000a\000r\000a\000m\000e\000t\000e\000r\000-\000p\000l\000o\000t\000\040\000w\000i\000n\000d\000o\000w}{chapter.4}% 28
|
||||
\BOOKMARK [2][-]{subsection.4.4.1}{\376\377\000P\000l\000o\000t\000\040\000o\000p\000t\000i\000o\000n\000s}{section.4.4}% 29
|
||||
\BOOKMARK [2][-]{subsection.4.4.2}{\376\377\000R\000e\000m\000e\000m\000b\000e\000r\000e\000d\000\040\000p\000l\000o\000t\000\040\000c\000o\000n\000f\000i\000g\000u\000r\000a\000t\000i\000o\000n\000s}{section.4.4}% 30
|
||||
\BOOKMARK [2][-]{subsection.4.4.3}{\376\377\000O\000v\000e\000r\000l\000a\000y\000\040\000d\000a\000t\000a\000\040\000s\000e\000t\000s\000\040\000\050\000m\000u\000l\000t\000i\000p\000l\000e\000\040\000f\000i\000l\000e\000s\000\040\000i\000n\000\040\000o\000n\000e\000\040\000p\000a\000n\000e\000l\000\051}{section.4.4}% 31
|
||||
\BOOKMARK [2][-]{subsection.4.4.4}{\376\377\000E\000d\000i\000t\000i\000n\000g\000\040\000t\000r\000a\000c\000e\000\040\000s\000t\000y\000l\000e\000s}{section.4.4}% 32
|
||||
\BOOKMARK [2][-]{subsection.4.4.5}{\376\377\000T\000e\000m\000p\000l\000a\000t\000e\000\040\000a\000n\000d\000\040\000s\000e\000r\000i\000e\000s\000\040\000p\000r\000e\000s\000e\000t\000s}{section.4.4}% 33
|
||||
\BOOKMARK [2][-]{subsection.4.4.6}{\376\377\000K\000e\000y\000b\000o\000a\000r\000d\000\040\000s\000h\000o\000r\000t\000c\000u\000t\000s}{section.4.4}% 34
|
||||
\BOOKMARK [0][-]{chapter.5}{\376\377\000C\000o\000n\000s\000t\000r\000a\000i\000n\000t\000s}{}% 35
|
||||
\BOOKMARK [1][-]{section.5.1}{\376\377\000C\000u\000s\000t\000o\000m\000\040\000p\000a\000r\000a\000m\000e\000t\000e\000r\000s}{chapter.5}% 36
|
||||
\BOOKMARK [1][-]{section.5.2}{\376\377\000C\000o\000n\000s\000t\000r\000a\000i\000n\000t\000s}{chapter.5}% 37
|
||||
\BOOKMARK [1][-]{section.5.3}{\376\377\000E\000x\000a\000m\000p\000l\000e\000:\000\040\000c\000o\000u\000p\000l\000e\000\040\000t\000h\000e\000\040\000m\000a\000g\000n\000e\000t\000i\000c\000\040\000f\000i\000e\000l\000d\000\040\000t\000o\000\040\000t\000h\000e\000\040\000L\000a\000r\000m\000o\000r\000\040\000f\000r\000e\000q\000u\000e\000n\000c\000y}{chapter.5}% 38
|
||||
\BOOKMARK [1][-]{section.5.4}{\376\377\000P\000r\000e\000v\000i\000e\000w}{chapter.5}% 39
|
||||
\BOOKMARK [0][-]{chapter.6}{\376\377\000t\0000\000\040\000/\000\040\000b\000a\000c\000k\000g\000r\000o\000u\000n\000d}{}% 40
|
||||
\BOOKMARK [1][-]{section.6.1}{\376\377\000M\000u\000l\000t\000i\000-\000g\000r\000o\000u\000p\000\040\000a\000s\000y\000m\000m\000e\000t\000r\000y\000\040\000f\000i\000t\000s}{chapter.6}% 41
|
||||
\BOOKMARK [0][-]{chapter.7}{\376\377\000M\000S\000R\000\040\000e\000d\000i\000t\000o\000r}{}% 42
|
||||
\BOOKMARK [1][-]{section.7.1}{\376\377\000O\000w\000n\000e\000r\000s\000h\000i\000p\000:\000\040\000G\000U\000I\000\040\000o\000r\000\040\000e\000d\000i\000t\000o\000r}{chapter.7}% 43
|
||||
\BOOKMARK [1][-]{section.7.2}{\376\377\000W\000o\000r\000k\000f\000l\000o\000w}{chapter.7}% 44
|
||||
\BOOKMARK [1][-]{section.7.3}{\376\377\000F\000i\000l\000e\000\040\000h\000a\000n\000d\000l\000i\000n\000g}{chapter.7}% 45
|
||||
\BOOKMARK [0][-]{chapter.8}{\376\377\000R\000e\000s\000u\000l\000t\000s\000\040\000a\000n\000d\000\040\000d\000i\000a\000g\000n\000o\000s\000t\000i\000c\000s}{}% 46
|
||||
\BOOKMARK [1][-]{section.8.1}{\376\377\000R\000e\000s\000u\000l\000t\000\040\000f\000i\000l\000e\000s}{chapter.8}% 47
|
||||
\BOOKMARK [1][-]{section.8.2}{\376\377\000E\000x\000e\000c\000u\000t\000i\000o\000n\000\040\000d\000e\000t\000a\000i\000l\000s}{chapter.8}% 48
|
||||
\BOOKMARK [1][-]{section.8.3}{\376\377\000C\000o\000m\000m\000a\000n\000d\000\040\000l\000o\000g}{chapter.8}% 49
|
||||
\BOOKMARK [1][-]{section.8.4}{\376\377\000T\000h\000e\000\040\000s\000t\000a\000t\000u\000s\000\040\000b\000a\000r}{chapter.8}% 50
|
||||
\BOOKMARK [1][-]{section.8.5}{\376\377\000R\000u\000n\000\040\000l\000o\000g\000\040\000w\000i\000n\000d\000o\000w}{chapter.8}% 51
|
||||
\BOOKMARK [1][-]{section.8.6}{\376\377\000O\000u\000t\000c\000o\000m\000e\000\040\000d\000i\000a\000l\000o\000g}{chapter.8}% 52
|
||||
\BOOKMARK [0][-]{chapter.9}{\376\377\000C\000o\000n\000f\000i\000g\000u\000r\000a\000t\000i\000o\000n\000\040\000s\000h\000a\000r\000i\000n\000g}{}% 53
|
||||
\BOOKMARK [1][-]{section.9.1}{\376\377\000W\000h\000a\000t\000\040\000i\000s\000\040\000s\000h\000a\000r\000e\000d}{chapter.9}% 54
|
||||
\BOOKMARK [1][-]{section.9.2}{\376\377\000O\000n\000\040\000t\000h\000e\000\040\000w\000e\000b}{chapter.9}% 55
|
||||
\BOOKMARK [1][-]{section.9.3}{\376\377\000O\000n\000\040\000t\000h\000e\000\040\000d\000e\000s\000k\000t\000o\000p}{chapter.9}% 56
|
||||
\BOOKMARK [1][-]{section.9.4}{\376\377\000N\000o\000t\000e\000s}{chapter.9}% 57
|
||||
\BOOKMARK [0][-]{chapter.10}{\376\377\000P\000r\000e\000f\000e\000r\000e\000n\000c\000e\000s}{}% 58
|
||||
\BOOKMARK [0][-]{chapter.11}{\376\377\000W\000e\000b\000\040\000a\000n\000d\000\040\000d\000e\000s\000k\000t\000o\000p\000\040\000e\000d\000i\000t\000i\000o\000n\000s}{}% 59
|
||||
\BOOKMARK [1][-]{section.11.1}{\376\377\000B\000u\000n\000d\000l\000e\000d\000\040\000R\000O\000O\000T\000\040\000a\000n\000d\000\040\000m\000u\000s\000r\000f\000i\000t}{chapter.11}% 60
|
||||
\BOOKMARK [1][-]{section.11.2}{\376\377\000D\000o\000w\000n\000l\000o\000a\000d\000i\000n\000g\000\040\000m\000i\000s\000s\000i\000n\000g\000\040\000r\000u\000n\000s}{chapter.11}% 61
|
||||
\BOOKMARK [0][-]{chapter.12}{\376\377\000K\000e\000y\000b\000o\000a\000r\000d\000\040\000s\000h\000o\000r\000t\000c\000u\000t\000s}{}% 62
|
||||
\BOOKMARK [1][-]{section.12.1}{\376\377\000P\000a\000r\000a\000m\000e\000t\000e\000r\000\040\000s\000e\000l\000e\000c\000t\000i\000o\000n\000\040\000\050\000P\000a\000r\000a\000m\000e\000t\000e\000r\000s\000\040\000t\000a\000b\000\051}{chapter.12}% 63
|
||||
\BOOKMARK [1][-]{section.12.2}{\376\377\000P\000a\000r\000a\000m\000e\000t\000e\000r\000-\000p\000l\000o\000t\000\040\000w\000i\000n\000d\000o\000w}{chapter.12}% 64
|
||||
\BOOKMARK [1][-]{section.12.3}{\376\377\000M\000S\000R\000\040\000e\000d\000i\000t\000o\000r}{chapter.12}% 65
|
||||
\BOOKMARK [1][-]{section.12.4}{\376\377\000G\000e\000n\000e\000r\000a\000l\000\040\000n\000o\000t\000e\000s}{chapter.12}% 66
|
||||
\BOOKMARK [0][-]{chapter.13}{\376\377\000T\000r\000o\000u\000b\000l\000e\000s\000h\000o\000o\000t\000i\000n\000g}{}% 67
|
||||
\BOOKMARK [1][-]{section.13.1}{\376\377\000F\000i\000t\000\040\000o\000r\000\040\000p\000l\000o\000t\000\040\000w\000i\000l\000l\000\040\000n\000o\000t\000\040\000s\000t\000a\000r\000t}{chapter.13}% 68
|
||||
\BOOKMARK [1][-]{section.13.2}{\376\377\040\034\000N\000o\000t\000h\000i\000n\000g\000\040\000t\000o\000\040\000f\000i\000t\040\035}{chapter.13}% 69
|
||||
\BOOKMARK [1][-]{section.13.3}{\376\377\000F\000i\000t\000t\000e\000d\000\040\000p\000a\000r\000a\000m\000e\000t\000e\000r\000s\000\040\000l\000o\000o\000k\000\040\000w\000r\000o\000n\000g\000\040\000o\000r\000\040\000u\000n\000c\000h\000a\000n\000g\000e\000d}{chapter.13}% 70
|
||||
\BOOKMARK [1][-]{section.13.4}{\376\377\000P\000a\000r\000a\000m\000e\000t\000e\000r\000\040\000p\000l\000o\000t\000\040\000i\000s\000\040\000e\000m\000p\000t\000y\000\040\000o\000r\000\040\000m\000i\000s\000s\000i\000n\000g\000\040\000d\000a\000t\000a}{chapter.13}% 71
|
||||
\BOOKMARK [1][-]{section.13.5}{\376\377\000P\000a\000r\000a\000m\000e\000t\000e\000r\000\040\000p\000l\000o\000t\000\040\000h\000a\000n\000g\000s\000\040\000o\000n\000\040\040\034\000P\000r\000e\000p\000a\000r\000i\000n\000g\000\040\000p\000l\000o\000t\000\040\000f\000i\000l\000e\000s\040\035}{chapter.13}% 72
|
||||
\BOOKMARK [1][-]{section.13.6}{\376\377\000W\000e\000b\000\040\000p\000a\000g\000e\000\040\000c\000a\000n\000n\000o\000t\000\040\000l\000o\000a\000d\000\040\000d\000a\000t\000a}{chapter.13}% 73
|
||||
\BOOKMARK [1][-]{section.13.7}{\376\377\000R\000e\000s\000t\000o\000r\000e\000d\000\040\000c\000o\000n\000f\000i\000g\000u\000r\000a\000t\000i\000o\000n\000\040\000d\000i\000f\000f\000e\000r\000s\000\040\000f\000r\000o\000m\000\040\000t\000h\000e\000\040\000o\000r\000i\000g\000i\000n\000a\000l\000\040\000m\000a\000c\000h\000i\000n\000e}{chapter.13}% 74
|
||||
\BOOKMARK [1][-]{section.13.8}{\376\377\000S\000o\000m\000e\000\040\000l\000i\000n\000k\000s\000\040\000s\000t\000a\000r\000t\000\040\000w\000i\000t\000h\000\040\000a\000\040\000d\000i\000f\000f\000e\000r\000e\000n\000t\000\040\000p\000r\000e\000f\000i\000x}{chapter.13}% 75
|
||||
\BOOKMARK [1][-]{section.13.9}{\376\377\000R\000e\000p\000o\000r\000t\000i\000n\000g\000\040\000p\000r\000o\000b\000l\000e\000m\000s}{chapter.13}% 76
|
||||
\BOOKMARK [0][-]{chapter.14}{\376\377\000G\000l\000o\000s\000s\000a\000r\000y}{}% 77
|
||||
\BOOKMARK [0][-]{section*.18}{\376\377\000I\000n\000d\000e\000x}{}% 78
|
||||
\BOOKMARK [0][-]{chapter.3}{\376\377\000W\000i\000n\000d\000o\000w\000s\000\040\000i\000n\000s\000t\000a\000l\000l\000a\000t\000i\000o\000n}{}% 14
|
||||
\BOOKMARK [1][-]{section.3.1}{\376\377\000B\000e\000f\000o\000r\000e\000\040\000y\000o\000u\000\040\000s\000t\000a\000r\000t}{chapter.3}% 15
|
||||
\BOOKMARK [1][-]{section.3.2}{\376\377\000I\000n\000s\000t\000a\000l\000l\000\040\000s\000t\000e\000p\000\040\000b\000y\000\040\000s\000t\000e\000p}{chapter.3}% 16
|
||||
\BOOKMARK [1][-]{section.3.3}{\376\377\000E\000x\000i\000s\000t\000i\000n\000g\000\040\000i\000n\000s\000t\000a\000l\000l\000a\000t\000i\000o\000n\000s}{chapter.3}% 17
|
||||
\BOOKMARK [1][-]{section.3.4}{\376\377\000T\000r\000o\000u\000b\000l\000e\000s\000h\000o\000o\000t\000i\000n\000g}{chapter.3}% 18
|
||||
\BOOKMARK [2][-]{subsection.3.4.1}{\376\377\000R\000e\000q\000u\000i\000r\000e\000d\000\040\000f\000e\000a\000t\000u\000r\000e\000\040\000i\000s\000\040\000n\000o\000t\000\040\000i\000n\000s\000t\000a\000l\000l\000e\000d}{section.3.4}% 19
|
||||
\BOOKMARK [2][-]{subsection.3.4.2}{\376\377\000C\000a\000n\000n\000o\000t\000\040\000f\000i\000n\000d\000\040\000w\000s\000l\000.\000e\000x\000e}{section.3.4}% 20
|
||||
\BOOKMARK [2][-]{subsection.3.4.3}{\376\377\000C\000a\000n\000n\000o\000t\000\040\000l\000o\000a\000d\000\040\000l\000i\000b\000C\000o\000r\000e\000.\000s\000o}{section.3.4}% 21
|
||||
\BOOKMARK [2][-]{subsection.3.4.4}{\376\377\000M\000i\000s\000s\000i\000n\000g\000\040\000b\000o\000o\000s\000t\000/\000v\000e\000r\000s\000i\000o\000n\000.\000h\000p\000p\000\040\000o\000r\000\040\000p\000l\000o\000t\000t\000i\000n\000g\000\040\000c\000r\000a\000s\000h}{section.3.4}% 22
|
||||
\BOOKMARK [2][-]{subsection.3.4.5}{\376\377\000N\000o\000\040\000s\000p\000e\000c\000t\000r\000u\000m\000\040\000w\000i\000n\000d\000o\000w\000\040\000a\000p\000p\000e\000a\000r\000s}{section.3.4}% 23
|
||||
\BOOKMARK [2][-]{subsection.3.4.6}{\376\377\000R\000e\000p\000o\000r\000t\000i\000n\000g\000\040\000a\000\040\000p\000r\000o\000b\000l\000e\000m}{section.3.4}% 24
|
||||
\BOOKMARK [0][-]{chapter.4}{\376\377\000L\000i\000n\000u\000x\000\040\000i\000n\000s\000t\000a\000l\000l\000a\000t\000i\000o\000n}{}% 25
|
||||
\BOOKMARK [1][-]{section.4.1}{\376\377\000I\000n\000s\000t\000a\000l\000l\000\040\000t\000h\000e\000\040\000a\000p\000p\000l\000i\000c\000a\000t\000i\000o\000n}{chapter.4}% 26
|
||||
\BOOKMARK [2][-]{subsection.4.1.1}{\376\377\000R\000P\000M}{section.4.1}% 27
|
||||
\BOOKMARK [2][-]{subsection.4.1.2}{\376\377\000A\000p\000p\000I\000m\000a\000g\000e}{section.4.1}% 28
|
||||
\BOOKMARK [1][-]{section.4.2}{\376\377\000S\000e\000t\000\040\000u\000p\000\040\000R\000O\000O\000T\000\040\000a\000n\000d\000\040\000m\000u\000s\000r\000f\000i\000t}{chapter.4}% 29
|
||||
\BOOKMARK [2][-]{subsection.4.2.1}{\376\377\000U\000s\000e\000\040\000a\000n\000\040\000e\000x\000i\000s\000t\000i\000n\000g\000\040\000i\000n\000s\000t\000a\000l\000l\000a\000t\000i\000o\000n}{section.4.2}% 30
|
||||
\BOOKMARK [2][-]{subsection.4.2.2}{\376\377\000I\000n\000s\000t\000a\000l\000l\000\040\000t\000h\000e\000\040\000s\000e\000p\000a\000r\000a\000t\000e\000\040\000r\000u\000n\000t\000i\000m\000e\000\040\000f\000r\000o\000m\000\040\000a\000\040\000l\000o\000c\000a\000l\000\040\000b\000u\000n\000d\000l\000e}{section.4.2}% 31
|
||||
\BOOKMARK [2][-]{subsection.4.2.3}{\376\377\000A\000l\000t\000e\000r\000n\000a\000t\000i\000v\000e\000:\000\040\000s\000y\000s\000t\000e\000m\000\040\000r\000u\000n\000t\000i\000m\000e\000\040\000R\000P\000M}{section.4.2}% 32
|
||||
\BOOKMARK [2][-]{subsection.4.2.4}{\376\377\000A\000l\000t\000e\000r\000n\000a\000t\000i\000v\000e\000:\000\040\000r\000u\000n\000t\000i\000m\000e\000\040\000A\000p\000p\000I\000m\000a\000g\000e}{section.4.2}% 33
|
||||
\BOOKMARK [1][-]{section.4.3}{\376\377\000C\000h\000o\000o\000s\000e\000\040\000f\000o\000l\000d\000e\000r\000s\000\040\000a\000n\000d\000\040\000t\000e\000s\000t}{chapter.4}% 34
|
||||
\BOOKMARK [1][-]{section.4.4}{\376\377\000U\000p\000d\000a\000t\000i\000n\000g\000\040\000a\000n\000d\000\040\000t\000r\000o\000u\000b\000l\000e\000s\000h\000o\000o\000t\000i\000n\000g}{chapter.4}% 35
|
||||
\BOOKMARK [0][-]{chapter.5}{\376\377\000R\000u\000n\000s\000\040\000a\000n\000d\000\040\000f\000i\000t\000t\000i\000n\000g}{}% 36
|
||||
\BOOKMARK [1][-]{section.5.1}{\376\377\000R\000u\000n\000\040\000s\000e\000l\000e\000c\000t\000i\000o\000n}{chapter.5}% 37
|
||||
\BOOKMARK [1][-]{section.5.2}{\376\377\000F\000i\000t\000\040\000r\000a\000n\000g\000e}{chapter.5}% 38
|
||||
\BOOKMARK [1][-]{section.5.3}{\376\377\000F\000i\000t\000\040\000m\000o\000d\000e\000l}{chapter.5}% 39
|
||||
\BOOKMARK [1][-]{section.5.4}{\376\377\000F\000i\000t\000\040\000o\000p\000t\000i\000o\000n\000s}{chapter.5}% 40
|
||||
\BOOKMARK [1][-]{section.5.5}{\376\377\000S\000e\000r\000i\000e\000s\000\040\000f\000i\000t\000\040\000a\000c\000t\000i\000o\000n\000s}{chapter.5}% 41
|
||||
\BOOKMARK [2][-]{subsection.5.5.1}{\376\377\000P\000e\000r\000-\000r\000u\000n\000\040\000s\000t\000a\000t\000i\000s\000t\000i\000c\000s}{section.5.5}% 42
|
||||
\BOOKMARK [1][-]{section.5.6}{\376\377\000V\000i\000e\000w\000\040\000s\000e\000t\000t\000i\000n\000g\000s}{chapter.5}% 43
|
||||
\BOOKMARK [1][-]{section.5.7}{\376\377\000F\000i\000t\000\040\000a\000n\000d\000\040\000P\000l\000o\000t}{chapter.5}% 44
|
||||
\BOOKMARK [0][-]{chapter.6}{\376\377\000P\000a\000r\000a\000m\000e\000t\000e\000r\000s\000\040\000a\000n\000d\000\040\000p\000a\000r\000a\000m\000e\000t\000e\000r\000\040\000p\000l\000o\000t\000s}{}% 45
|
||||
\BOOKMARK [1][-]{section.6.1}{\376\377\000T\000h\000e\000\040\000p\000a\000r\000a\000m\000e\000t\000e\000r\000\040\000t\000a\000b\000l\000e}{chapter.6}% 46
|
||||
\BOOKMARK [2][-]{subsection.6.1.1}{\376\377\000T\000h\000e\000\040\000S\000h\000a\000r\000e\000d\000\040\000c\000o\000l\000u\000m\000n}{section.6.1}% 47
|
||||
\BOOKMARK [1][-]{section.6.2}{\376\377\000S\000e\000l\000e\000c\000t\000i\000n\000g\000\040\000p\000a\000r\000a\000m\000e\000t\000e\000r\000s\000\040\000f\000o\000r\000\040\000p\000l\000o\000t\000t\000i\000n\000g}{chapter.6}% 48
|
||||
\BOOKMARK [1][-]{section.6.3}{\376\377\000T\000h\000e\000\040\000C\000h\000o\000o\000s\000e\000\040\000X\000\040\000a\000x\000i\000s\000\040\000d\000i\000a\000l\000o\000g}{chapter.6}% 49
|
||||
\BOOKMARK [1][-]{section.6.4}{\376\377\000T\000h\000e\000\040\000p\000a\000r\000a\000m\000e\000t\000e\000r\000-\000p\000l\000o\000t\000\040\000w\000i\000n\000d\000o\000w}{chapter.6}% 50
|
||||
\BOOKMARK [2][-]{subsection.6.4.1}{\376\377\000P\000l\000o\000t\000\040\000o\000p\000t\000i\000o\000n\000s}{section.6.4}% 51
|
||||
\BOOKMARK [2][-]{subsection.6.4.2}{\376\377\000R\000e\000m\000e\000m\000b\000e\000r\000e\000d\000\040\000p\000l\000o\000t\000\040\000c\000o\000n\000f\000i\000g\000u\000r\000a\000t\000i\000o\000n\000s}{section.6.4}% 52
|
||||
\BOOKMARK [2][-]{subsection.6.4.3}{\376\377\000O\000v\000e\000r\000l\000a\000y\000\040\000d\000a\000t\000a\000\040\000s\000e\000t\000s\000\040\000\050\000m\000u\000l\000t\000i\000p\000l\000e\000\040\000f\000i\000l\000e\000s\000\040\000i\000n\000\040\000o\000n\000e\000\040\000p\000a\000n\000e\000l\000\051}{section.6.4}% 53
|
||||
\BOOKMARK [2][-]{subsection.6.4.4}{\376\377\000E\000d\000i\000t\000i\000n\000g\000\040\000t\000r\000a\000c\000e\000\040\000s\000t\000y\000l\000e\000s}{section.6.4}% 54
|
||||
\BOOKMARK [2][-]{subsection.6.4.5}{\376\377\000T\000e\000m\000p\000l\000a\000t\000e\000\040\000a\000n\000d\000\040\000s\000e\000r\000i\000e\000s\000\040\000p\000r\000e\000s\000e\000t\000s}{section.6.4}% 55
|
||||
\BOOKMARK [2][-]{subsection.6.4.6}{\376\377\000K\000e\000y\000b\000o\000a\000r\000d\000\040\000s\000h\000o\000r\000t\000c\000u\000t\000s}{section.6.4}% 56
|
||||
\BOOKMARK [0][-]{chapter.7}{\376\377\000C\000o\000n\000s\000t\000r\000a\000i\000n\000t\000s}{}% 57
|
||||
\BOOKMARK [1][-]{section.7.1}{\376\377\000C\000u\000s\000t\000o\000m\000\040\000p\000a\000r\000a\000m\000e\000t\000e\000r\000s}{chapter.7}% 58
|
||||
\BOOKMARK [1][-]{section.7.2}{\376\377\000C\000o\000n\000s\000t\000r\000a\000i\000n\000t\000s}{chapter.7}% 59
|
||||
\BOOKMARK [1][-]{section.7.3}{\376\377\000E\000x\000a\000m\000p\000l\000e\000:\000\040\000c\000o\000u\000p\000l\000e\000\040\000t\000h\000e\000\040\000m\000a\000g\000n\000e\000t\000i\000c\000\040\000f\000i\000e\000l\000d\000\040\000t\000o\000\040\000t\000h\000e\000\040\000L\000a\000r\000m\000o\000r\000\040\000f\000r\000e\000q\000u\000e\000n\000c\000y}{chapter.7}% 60
|
||||
\BOOKMARK [1][-]{section.7.4}{\376\377\000P\000r\000e\000v\000i\000e\000w}{chapter.7}% 61
|
||||
\BOOKMARK [0][-]{chapter.8}{\376\377\000t\0000\000\040\000/\000\040\000b\000a\000c\000k\000g\000r\000o\000u\000n\000d}{}% 62
|
||||
\BOOKMARK [1][-]{section.8.1}{\376\377\000M\000u\000l\000t\000i\000-\000g\000r\000o\000u\000p\000\040\000a\000s\000y\000m\000m\000e\000t\000r\000y\000\040\000f\000i\000t\000s}{chapter.8}% 63
|
||||
\BOOKMARK [0][-]{chapter.9}{\376\377\000M\000S\000R\000\040\000e\000d\000i\000t\000o\000r}{}% 64
|
||||
\BOOKMARK [1][-]{section.9.1}{\376\377\000O\000w\000n\000e\000r\000s\000h\000i\000p\000:\000\040\000G\000U\000I\000\040\000o\000r\000\040\000e\000d\000i\000t\000o\000r}{chapter.9}% 65
|
||||
\BOOKMARK [1][-]{section.9.2}{\376\377\000W\000o\000r\000k\000f\000l\000o\000w}{chapter.9}% 66
|
||||
\BOOKMARK [1][-]{section.9.3}{\376\377\000F\000i\000l\000e\000\040\000h\000a\000n\000d\000l\000i\000n\000g}{chapter.9}% 67
|
||||
\BOOKMARK [0][-]{chapter.10}{\376\377\000R\000e\000s\000u\000l\000t\000s\000\040\000a\000n\000d\000\040\000d\000i\000a\000g\000n\000o\000s\000t\000i\000c\000s}{}% 68
|
||||
\BOOKMARK [1][-]{section.10.1}{\376\377\000R\000e\000s\000u\000l\000t\000\040\000f\000i\000l\000e\000s}{chapter.10}% 69
|
||||
\BOOKMARK [1][-]{section.10.2}{\376\377\000E\000x\000e\000c\000u\000t\000i\000o\000n\000\040\000d\000e\000t\000a\000i\000l\000s}{chapter.10}% 70
|
||||
\BOOKMARK [1][-]{section.10.3}{\376\377\000C\000o\000m\000m\000a\000n\000d\000\040\000l\000o\000g}{chapter.10}% 71
|
||||
\BOOKMARK [1][-]{section.10.4}{\376\377\000T\000h\000e\000\040\000s\000t\000a\000t\000u\000s\000\040\000b\000a\000r}{chapter.10}% 72
|
||||
\BOOKMARK [1][-]{section.10.5}{\376\377\000R\000u\000n\000\040\000l\000o\000g\000\040\000w\000i\000n\000d\000o\000w}{chapter.10}% 73
|
||||
\BOOKMARK [1][-]{section.10.6}{\376\377\000O\000u\000t\000c\000o\000m\000e\000\040\000d\000i\000a\000l\000o\000g}{chapter.10}% 74
|
||||
\BOOKMARK [0][-]{chapter.11}{\376\377\000C\000o\000n\000f\000i\000g\000u\000r\000a\000t\000i\000o\000n\000\040\000s\000h\000a\000r\000i\000n\000g}{}% 75
|
||||
\BOOKMARK [1][-]{section.11.1}{\376\377\000W\000h\000a\000t\000\040\000i\000s\000\040\000s\000h\000a\000r\000e\000d}{chapter.11}% 76
|
||||
\BOOKMARK [1][-]{section.11.2}{\376\377\000O\000n\000\040\000t\000h\000e\000\040\000w\000e\000b}{chapter.11}% 77
|
||||
\BOOKMARK [1][-]{section.11.3}{\376\377\000O\000n\000\040\000t\000h\000e\000\040\000d\000e\000s\000k\000t\000o\000p}{chapter.11}% 78
|
||||
\BOOKMARK [1][-]{section.11.4}{\376\377\000N\000o\000t\000e\000s}{chapter.11}% 79
|
||||
\BOOKMARK [0][-]{chapter.12}{\376\377\000P\000r\000e\000f\000e\000r\000e\000n\000c\000e\000s}{}% 80
|
||||
\BOOKMARK [0][-]{chapter.13}{\376\377\000W\000e\000b\000\040\000a\000n\000d\000\040\000d\000e\000s\000k\000t\000o\000p\000\040\000e\000d\000i\000t\000i\000o\000n\000s}{}% 81
|
||||
\BOOKMARK [1][-]{section.13.1}{\376\377\000B\000u\000n\000d\000l\000e\000d\000\040\000R\000O\000O\000T\000\040\000a\000n\000d\000\040\000m\000u\000s\000r\000f\000i\000t}{chapter.13}% 82
|
||||
\BOOKMARK [1][-]{section.13.2}{\376\377\000D\000o\000w\000n\000l\000o\000a\000d\000i\000n\000g\000\040\000m\000i\000s\000s\000i\000n\000g\000\040\000r\000u\000n\000s}{chapter.13}% 83
|
||||
\BOOKMARK [0][-]{chapter.14}{\376\377\000K\000e\000y\000b\000o\000a\000r\000d\000\040\000s\000h\000o\000r\000t\000c\000u\000t\000s}{}% 84
|
||||
\BOOKMARK [1][-]{section.14.1}{\376\377\000P\000a\000r\000a\000m\000e\000t\000e\000r\000\040\000s\000e\000l\000e\000c\000t\000i\000o\000n\000\040\000\050\000P\000a\000r\000a\000m\000e\000t\000e\000r\000s\000\040\000t\000a\000b\000\051}{chapter.14}% 85
|
||||
\BOOKMARK [1][-]{section.14.2}{\376\377\000P\000a\000r\000a\000m\000e\000t\000e\000r\000-\000p\000l\000o\000t\000\040\000w\000i\000n\000d\000o\000w}{chapter.14}% 86
|
||||
\BOOKMARK [1][-]{section.14.3}{\376\377\000M\000S\000R\000\040\000e\000d\000i\000t\000o\000r}{chapter.14}% 87
|
||||
\BOOKMARK [1][-]{section.14.4}{\376\377\000G\000e\000n\000e\000r\000a\000l\000\040\000n\000o\000t\000e\000s}{chapter.14}% 88
|
||||
\BOOKMARK [0][-]{chapter.15}{\376\377\000T\000r\000o\000u\000b\000l\000e\000s\000h\000o\000o\000t\000i\000n\000g}{}% 89
|
||||
\BOOKMARK [1][-]{section.15.1}{\376\377\000F\000i\000t\000\040\000o\000r\000\040\000p\000l\000o\000t\000\040\000w\000i\000l\000l\000\040\000n\000o\000t\000\040\000s\000t\000a\000r\000t}{chapter.15}% 90
|
||||
\BOOKMARK [1][-]{section.15.2}{\376\377\040\034\000N\000o\000t\000h\000i\000n\000g\000\040\000t\000o\000\040\000f\000i\000t\040\035}{chapter.15}% 91
|
||||
\BOOKMARK [1][-]{section.15.3}{\376\377\000F\000i\000t\000t\000e\000d\000\040\000p\000a\000r\000a\000m\000e\000t\000e\000r\000s\000\040\000l\000o\000o\000k\000\040\000w\000r\000o\000n\000g\000\040\000o\000r\000\040\000u\000n\000c\000h\000a\000n\000g\000e\000d}{chapter.15}% 92
|
||||
\BOOKMARK [1][-]{section.15.4}{\376\377\000P\000a\000r\000a\000m\000e\000t\000e\000r\000\040\000p\000l\000o\000t\000\040\000i\000s\000\040\000e\000m\000p\000t\000y\000\040\000o\000r\000\040\000m\000i\000s\000s\000i\000n\000g\000\040\000d\000a\000t\000a}{chapter.15}% 93
|
||||
\BOOKMARK [1][-]{section.15.5}{\376\377\000P\000a\000r\000a\000m\000e\000t\000e\000r\000\040\000p\000l\000o\000t\000\040\000h\000a\000n\000g\000s\000\040\000o\000n\000\040\040\034\000P\000r\000e\000p\000a\000r\000i\000n\000g\000\040\000p\000l\000o\000t\000\040\000f\000i\000l\000e\000s\040\035}{chapter.15}% 94
|
||||
\BOOKMARK [1][-]{section.15.6}{\376\377\000W\000e\000b\000\040\000p\000a\000g\000e\000\040\000c\000a\000n\000n\000o\000t\000\040\000l\000o\000a\000d\000\040\000d\000a\000t\000a}{chapter.15}% 95
|
||||
\BOOKMARK [1][-]{section.15.7}{\376\377\000R\000e\000s\000t\000o\000r\000e\000d\000\040\000c\000o\000n\000f\000i\000g\000u\000r\000a\000t\000i\000o\000n\000\040\000d\000i\000f\000f\000e\000r\000s\000\040\000f\000r\000o\000m\000\040\000t\000h\000e\000\040\000o\000r\000i\000g\000i\000n\000a\000l\000\040\000m\000a\000c\000h\000i\000n\000e}{chapter.15}% 96
|
||||
\BOOKMARK [1][-]{section.15.8}{\376\377\000S\000o\000m\000e\000\040\000l\000i\000n\000k\000s\000\040\000s\000t\000a\000r\000t\000\040\000w\000i\000t\000h\000\040\000a\000\040\000d\000i\000f\000f\000e\000r\000e\000n\000t\000\040\000p\000r\000e\000f\000i\000x}{chapter.15}% 97
|
||||
\BOOKMARK [1][-]{section.15.9}{\376\377\000R\000e\000p\000o\000r\000t\000i\000n\000g\000\040\000p\000r\000o\000b\000l\000e\000m\000s}{chapter.15}% 98
|
||||
\BOOKMARK [0][-]{chapter.16}{\376\377\000G\000l\000o\000s\000s\000a\000r\000y}{}% 99
|
||||
\BOOKMARK [0][-]{section*.18}{\376\377\000I\000n\000d\000e\000x}{}% 100
|
||||
Vendored
BIN
Binary file not shown.
Vendored
+478
-119
@@ -71,7 +71,7 @@
|
||||
|
||||
|
||||
\title{muSRFlow User Manual}
|
||||
\date{Oct 26, 2026}
|
||||
\date{Oct 28, 2026}
|
||||
\release{1.0.0\sphinxhyphen{}rc.5}
|
||||
\author{Zaher Salman}
|
||||
\newcommand{\sphinxlogo}{\vbox{}}
|
||||
@@ -94,6 +94,10 @@ application and as a browser application, and both editions wrap the same set
|
||||
of command\sphinxhyphen{}line tools (\sphinxcode{\sphinxupquote{musrfit}}, \sphinxcode{\sphinxupquote{musrview}}, \sphinxcode{\sphinxupquote{msr2data}}, and
|
||||
\sphinxcode{\sphinxupquote{dump\_header}}).
|
||||
|
||||
\sphinxAtStartPar
|
||||
Start with {\hyperref[\detokenize{install-windows::doc}]{\sphinxcrossref{\DUrole{doc}{Windows installation}}}} or {\hyperref[\detokenize{install-linux::doc}]{\sphinxcrossref{\DUrole{doc}{Linux installation}}}} for desktop setup.
|
||||
For the browser edition, see {\hyperref[\detokenize{getting-started::doc}]{\sphinxcrossref{\DUrole{doc}{Getting started}}}}.
|
||||
|
||||
\sphinxAtStartPar
|
||||
These pages describe the end\sphinxhyphen{}user workflow. They are organised around the
|
||||
main window tabs, mirroring the Quick Start help that is built into the
|
||||
@@ -270,84 +274,148 @@ are expanded into the chapters of this manual.
|
||||
\chapter{Getting started}
|
||||
\label{\detokenize{getting-started:getting-started}}\label{\detokenize{getting-started::doc}}
|
||||
|
||||
\section{Prerequisites}
|
||||
\label{\detokenize{getting-started:prerequisites}}
|
||||
\sphinxAtStartPar
|
||||
muSRFlow wraps external \sphinxcode{\sphinxupquote{musrfit}} tools. How they are supplied depends on
|
||||
the edition:
|
||||
\begin{itemize}
|
||||
\section{Choose your edition}
|
||||
\label{\detokenize{getting-started:choose-your-edition}}\begin{itemize}
|
||||
\item {}
|
||||
\sphinxAtStartPar
|
||||
Linux desktop: use a local musrfit installation or install the separate
|
||||
ROOT + musrfit runtime. Select the tools through \sphinxstylestrong{File / Preferences}.
|
||||
\sphinxstylestrong{Windows desktop:} follow {\hyperref[\detokenize{install-windows::doc}]{\sphinxcrossref{\DUrole{doc}{Windows installation}}}}. ROOT and musrfit are
|
||||
included in a WSL2 runtime. The guide covers first installation, existing
|
||||
runtime updates, and Windows\sphinxhyphen{}specific errors.
|
||||
|
||||
\item {}
|
||||
\sphinxAtStartPar
|
||||
Windows desktop: the installer includes ROOT and musrfit in a WSL2 runtime.
|
||||
Install WSL first, following {\hyperref[\detokenize{getting-started:windows-installation}]{\sphinxcrossref{\DUrole{std}{\DUrole{std-ref}{Windows installation}}}}} below.
|
||||
\sphinxstylestrong{Linux desktop:} follow {\hyperref[\detokenize{install-linux::doc}]{\sphinxcrossref{\DUrole{doc}{Linux installation}}}}. Use an existing musrfit
|
||||
installation or install the separate runtime through Preferences.
|
||||
|
||||
\item {}
|
||||
\sphinxAtStartPar
|
||||
Web: the tools are installed on the server that hosts the CGI runner.
|
||||
\sphinxstylestrong{Web:} open your site’s muSRFlow URL, for example
|
||||
\sphinxcode{\sphinxupquote{http://musruser.psi.ch/muSRFlow/}}. The server runs the tools; there is
|
||||
nothing to install on your computer.
|
||||
|
||||
\end{itemize}
|
||||
|
||||
\sphinxAtStartPar
|
||||
Packaged desktop applications do not require Node.js or npm on the target
|
||||
PC. The browser edition needs no local installation at all.
|
||||
Packaged desktop applications do not require Node.js or npm.
|
||||
|
||||
|
||||
\section{Development and Linux packages}
|
||||
\label{\detokenize{getting-started:development-and-linux-packages}}\label{\detokenize{getting-started:desktop-installation}}
|
||||
\section{Desktop installation}
|
||||
\label{\detokenize{getting-started:desktop-installation}}\label{\detokenize{getting-started:id1}}
|
||||
\sphinxAtStartPar
|
||||
From a checkout, with \sphinxhref{https://nodejs.org/}{Node.js} and npm installed:
|
||||
|
||||
\begin{sphinxVerbatim}[commandchars=\\\{\}]
|
||||
\PYG{g+gp}{\PYGZdl{} }npm\PYG{+w}{ }install
|
||||
\PYG{g+gp}{\PYGZdl{} }npm\PYG{+w}{ }start
|
||||
\end{sphinxVerbatim}
|
||||
|
||||
\sphinxAtStartPar
|
||||
\sphinxtitleref{npm install} is only needed once; later sessions start with \sphinxtitleref{npm start}.
|
||||
|
||||
\sphinxAtStartPar
|
||||
Release packages (Linux RPM and AppImage) are produced with:
|
||||
|
||||
\begin{sphinxVerbatim}[commandchars=\\\{\}]
|
||||
\PYG{g+gp}{\PYGZdl{} }npm\PYG{+w}{ }run\PYG{+w}{ }dist:rpm
|
||||
\PYG{g+gp}{\PYGZdl{} }npm\PYG{+w}{ }run\PYG{+w}{ }dist:appimage
|
||||
\end{sphinxVerbatim}
|
||||
|
||||
\sphinxAtStartPar
|
||||
Each command also builds the matching standalone ROOT + musrfit runtime
|
||||
artifact (\sphinxcode{\sphinxupquote{musrflow\sphinxhyphen{}runtime}} rpm / AppImage); \sphinxcode{\sphinxupquote{npm run dist:runtime}} builds
|
||||
only the runtime. The build and runtime requirements are described in
|
||||
\sphinxcode{\sphinxupquote{docs/DESKTOP\_DEPLOYMENT.md}}.
|
||||
The complete instructions are in {\hyperref[\detokenize{install-windows::doc}]{\sphinxcrossref{\DUrole{doc}{Windows installation}}}} and
|
||||
{\hyperref[\detokenize{install-linux::doc}]{\sphinxcrossref{\DUrole{doc}{Linux installation}}}}. Choose work and data folders in \sphinxstylestrong{File / Preferences}
|
||||
before your first analysis. Keep work files outside the application
|
||||
installation directory.
|
||||
|
||||
|
||||
\section{Windows installation}
|
||||
\label{\detokenize{getting-started:windows-installation}}\label{\detokenize{getting-started:id1}}
|
||||
\label{\detokenize{getting-started:windows-installation}}\label{\detokenize{getting-started:getting-started-windows-installation}}
|
||||
\sphinxAtStartPar
|
||||
Use a 64\sphinxhyphen{}bit Intel/AMD Windows PC. Windows 11 is recommended; Windows 10
|
||||
requires build 19044 or newer for WSLg, which displays the \sphinxcode{\sphinxupquote{musrview}}
|
||||
windows. See \sphinxhref{https://learn.microsoft.com/en-us/windows/wsl/tutorials/gui-apps}{Microsoft’s WSL GUI requirements}.
|
||||
\begin{enumerate}
|
||||
The Windows instructions have their own chapter: {\hyperref[\detokenize{install-windows::doc}]{\sphinxcrossref{\DUrole{doc}{Windows installation}}}}.
|
||||
It also contains the update steps for older WSL runtimes.
|
||||
|
||||
|
||||
\section{Running the desktop app}
|
||||
\label{\detokenize{getting-started:running-the-desktop-app}}
|
||||
\sphinxAtStartPar
|
||||
When the window opens, the \sphinxstylestrong{Runs} tab is active. Choose the instrument,
|
||||
year, and run numbers, check the model, and press \sphinxstylestrong{Plot} to inspect the
|
||||
spectrum. Press \sphinxstylestrong{Fit} to fit it and refresh the parameter table. Generated
|
||||
files go to the selected work directory; the \sphinxstylestrong{Results} tab and run log
|
||||
show the outcome.
|
||||
|
||||
|
||||
\section{Opening the web edition}
|
||||
\label{\detokenize{getting-started:opening-the-web-edition}}
|
||||
\sphinxAtStartPar
|
||||
Open the deployment URL in your browser. Instrument options and available
|
||||
run data depend on that site’s server configuration. Fit and Plot run on
|
||||
the server; output files can be opened from the result links.
|
||||
|
||||
|
||||
\section{The Quick Start guide}
|
||||
\label{\detokenize{getting-started:the-quick-start-guide}}
|
||||
\sphinxAtStartPar
|
||||
The \sphinxcode{\sphinxupquote{?}} button at the right of the tab bar opens a short, tab\sphinxhyphen{}aware guide.
|
||||
On the desktop it opens in an independent window; in the browser it opens a
|
||||
modeless dialog next to the main window. The full workflow chapters follow
|
||||
the installation guides in this manual.
|
||||
|
||||
|
||||
\section{Support}
|
||||
\label{\detokenize{getting-started:support}}
|
||||
\sphinxAtStartPar
|
||||
For questions and bug reports, include the version and run log and contact
|
||||
\sphinxhref{mailto:zaher.salman@psi.ch}{Zaher Salman}. See {\hyperref[\detokenize{troubleshooting::doc}]{\sphinxcrossref{\DUrole{doc}{Troubleshooting}}}}
|
||||
for common workflow problems.
|
||||
|
||||
\sphinxstepscope
|
||||
|
||||
|
||||
\chapter{Windows installation}
|
||||
\label{\detokenize{install-windows:windows-installation}}\label{\detokenize{install-windows:id1}}\label{\detokenize{install-windows::doc}}
|
||||
\sphinxAtStartPar
|
||||
The Windows installer includes muSRFlow, ROOT, and musrfit. Install WSL2
|
||||
first; muSRFlow prepares its own Linux runtime on first launch. You do not
|
||||
need Node.js, npm, Ubuntu, or a separate ROOT/musrfit installation.
|
||||
|
||||
\sphinxAtStartPar
|
||||
Already installed muSRFlow? Read {\hyperref[\detokenize{install-windows:existing-installations}]{\sphinxcrossref{Existing installations}}} as well: updating
|
||||
the application does not update an already imported WSL runtime.
|
||||
|
||||
|
||||
\section{Before you start}
|
||||
\label{\detokenize{install-windows:before-you-start}}\begin{itemize}
|
||||
\item {}
|
||||
\sphinxAtStartPar
|
||||
Use a \sphinxstylestrong{64\sphinxhyphen{}bit Intel/AMD PC}. The current package is x64.
|
||||
|
||||
\item {}
|
||||
\sphinxAtStartPar
|
||||
Windows 11 is recommended. Windows 10 requires build 19044 or newer for
|
||||
WSLg, which displays the musrview spectrum windows.
|
||||
|
||||
\item {}
|
||||
\sphinxAtStartPar
|
||||
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}}.
|
||||
|
||||
\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.
|
||||
|
||||
\sphinxAtStartPar
|
||||
See \sphinxhref{https://learn.microsoft.com/en-us/windows/wsl/tutorials/gui-apps}{Microsoft’s WSL GUI requirements} for the
|
||||
Windows prerequisites.
|
||||
|
||||
|
||||
\section{Install step by step}
|
||||
\label{\detokenize{install-windows:install-step-by-step}}\begin{enumerate}
|
||||
\sphinxsetlistlabels{\arabic}{enumi}{enumii}{}{.}%
|
||||
\item {}
|
||||
\sphinxAtStartPar
|
||||
Open \sphinxstylestrong{PowerShell as Administrator} and install WSL:
|
||||
\sphinxstylestrong{Install WSL.} Open \sphinxstylestrong{PowerShell as Administrator} and run:
|
||||
|
||||
\begin{sphinxVerbatim}[commandchars=\\\{\}]
|
||||
\PYG{n}{wsl} \PYG{p}{\PYGZhy{}}\PYG{n}{\PYGZhy{}install} \PYG{p}{\PYGZhy{}}\PYG{n}{\PYGZhy{}no}\PYG{n}{\PYGZhy{}distribution}
|
||||
\end{sphinxVerbatim}
|
||||
|
||||
\sphinxAtStartPar
|
||||
Restart Windows afterwards. Skip this step if WSL is already installed.
|
||||
You do not need Ubuntu: muSRFlow supplies its own distribution.
|
||||
\sphinxstylestrong{Restart Windows afterwards.} Skip this step if WSL is already installed.
|
||||
muSRFlow supplies its own distribution, so Ubuntu is not required.
|
||||
|
||||
\item {}
|
||||
\sphinxAtStartPar
|
||||
Update WSL and check its components in administrator PowerShell:
|
||||
\sphinxstylestrong{Update and check WSL.} In administrator PowerShell, run:
|
||||
|
||||
\begin{sphinxVerbatim}[commandchars=\\\{\}]
|
||||
\PYG{n}{wsl} \PYG{p}{\PYGZhy{}}\PYG{n}{\PYGZhy{}update}
|
||||
@@ -356,19 +424,20 @@ Update WSL and check its components in administrator PowerShell:
|
||||
|
||||
\sphinxAtStartPar
|
||||
Follow any restart instructions. The output should include WSL and WSLg.
|
||||
See the \sphinxhref{https://learn.microsoft.com/en-us/windows/wsl/basic-commands}{Microsoft WSL command reference}.
|
||||
These commands are described in the \sphinxhref{https://learn.microsoft.com/en-us/windows/wsl/basic-commands}{Microsoft WSL command reference}.
|
||||
|
||||
\item {}
|
||||
\sphinxAtStartPar
|
||||
Copy the release installer \sphinxcode{\sphinxupquote{muSRFlow\sphinxhyphen{}<version>\sphinxhyphen{}x64.exe}} to Windows and
|
||||
double\sphinxhyphen{}click it. It includes \sphinxcode{\sphinxupquote{muSRFlow\sphinxhyphen{}runtime\sphinxhyphen{}rootfs.tar.gz}}; there is
|
||||
no separate ROOT or musrfit installation or manual archive import.
|
||||
\sphinxstylestrong{Install muSRFlow.} Double\sphinxhyphen{}click the Windows installer and complete setup.
|
||||
The runtime archive \sphinxcode{\sphinxupquote{muSRFlow\sphinxhyphen{}runtime\sphinxhyphen{}rootfs.tar.gz}} is included; do not
|
||||
extract or import it manually for a normal installation.
|
||||
|
||||
\item {}
|
||||
\sphinxAtStartPar
|
||||
Launch muSRFlow from the Start menu using your normal Windows account.
|
||||
The first launch prepares the runtime, which can take several minutes.
|
||||
Fit and Plot wait until preparation finishes. Afterwards, verify:
|
||||
\sphinxstylestrong{Launch muSRFlow} from the Start menu using your normal Windows account.
|
||||
First launch imports the runtime as \sphinxcode{\sphinxupquote{muSRFlow\sphinxhyphen{}runtime}} and can take
|
||||
several minutes. Fit and Plot wait until preparation finishes. Afterwards,
|
||||
verify in PowerShell:
|
||||
|
||||
\begin{sphinxVerbatim}[commandchars=\\\{\}]
|
||||
\PYG{n}{wsl} \PYG{p}{\PYGZhy{}}\PYG{n}{\PYGZhy{}list} \PYG{p}{\PYGZhy{}}\PYG{n}{\PYGZhy{}verbose}
|
||||
@@ -376,68 +445,356 @@ Fit and Plot wait until preparation finishes. Afterwards, verify:
|
||||
|
||||
\sphinxAtStartPar
|
||||
The list should contain \sphinxcode{\sphinxupquote{muSRFlow\sphinxhyphen{}runtime}} with \sphinxstylestrong{VERSION 2}.
|
||||
\sphinxcode{\sphinxupquote{Running}} and \sphinxcode{\sphinxupquote{Stopped}} are both normal when idle.
|
||||
\sphinxcode{\sphinxupquote{Running}} and \sphinxcode{\sphinxupquote{Stopped}} are both normal when idle. The runtime is
|
||||
stored under \sphinxcode{\sphinxupquote{\%LOCALAPPDATA\%\textbackslash{}muSRFlow\textbackslash{}muSRFlow\sphinxhyphen{}runtime}} for this account.
|
||||
|
||||
\item {}
|
||||
\sphinxAtStartPar
|
||||
Create writable work and data folders, for example
|
||||
\sphinxcode{\sphinxupquote{C:\textbackslash{}Users\textbackslash{}<your\sphinxhyphen{}name>\textbackslash{}muSRFlow\textbackslash{}work}} and
|
||||
\sphinxcode{\sphinxupquote{C:\textbackslash{}Users\textbackslash{}<your\sphinxhyphen{}name>\textbackslash{}muSRFlow\textbackslash{}data}}. Choose them in
|
||||
\sphinxstylestrong{File / Preferences}. Leave \sphinxstylestrong{musrfit binaries} and
|
||||
\sphinxstylestrong{musrfit startup XML} on automatic detection, then save.
|
||||
Enter Windows paths; muSRFlow translates them for WSL.
|
||||
\sphinxstylestrong{Choose work and data folders before fitting.} Create folders such as:
|
||||
|
||||
\begin{sphinxVerbatim}[commandchars=\\\{\}]
|
||||
C:\PYGZbs{}Users\PYGZbs{}\PYGZlt{}your\PYGZhy{}name\PYGZgt{}\PYGZbs{}muSRFlow\PYGZbs{}work
|
||||
C:\PYGZbs{}Users\PYGZbs{}\PYGZlt{}your\PYGZhy{}name\PYGZgt{}\PYGZbs{}muSRFlow\PYGZbs{}data
|
||||
\end{sphinxVerbatim}
|
||||
|
||||
\sphinxAtStartPar
|
||||
In \sphinxstylestrong{File / Preferences}, select them as \sphinxstylestrong{Work directory} and
|
||||
\sphinxstylestrong{Data directory}. Leave \sphinxstylestrong{musrfit binaries} and \sphinxstylestrong{musrfit startup XML}
|
||||
on automatic detection, then save. Enter normal Windows paths; muSRFlow
|
||||
translates them for WSL.
|
||||
|
||||
\sphinxAtStartPar
|
||||
Use a work folder outside the application installation directory. The
|
||||
default \sphinxcode{\sphinxupquote{.}} can resolve to the installation folder and place your
|
||||
results among files managed by the installer.
|
||||
|
||||
\item {}
|
||||
\sphinxAtStartPar
|
||||
Select a known instrument, year, and run, then press \sphinxstylestrong{Plot}. If data
|
||||
are missing, muSRFlow offers to download them from \sphinxcode{\sphinxupquote{musruser.psi.ch}}
|
||||
when the server is reachable. Confirm the spectrum window opens, then
|
||||
try \sphinxstylestrong{Fit} and check that the parameter table updates. Results stay in
|
||||
your Windows work directory.
|
||||
\sphinxstylestrong{Try Plot, then Fit.} Select a known instrument, year, and run. Click
|
||||
\sphinxstylestrong{Plot} and confirm that the spectrum window opens. Missing run data
|
||||
can be downloaded from \sphinxcode{\sphinxupquote{musruser.psi.ch}} after confirmation when the
|
||||
server is reachable. Then click \sphinxstylestrong{Fit}, check that the parameter table
|
||||
updates, and inspect the generated files in your work directory.
|
||||
|
||||
\end{enumerate}
|
||||
|
||||
|
||||
\section{Existing installations}
|
||||
\label{\detokenize{install-windows:existing-installations}}\begin{enumerate}
|
||||
\sphinxsetlistlabels{\arabic}{enumi}{enumii}{}{.}%
|
||||
\item {}
|
||||
\sphinxAtStartPar
|
||||
Preserve any MSR/data/result files currently stored inside the muSRFlow
|
||||
installation folder: move them to a separate work folder before upgrading.
|
||||
|
||||
\item {}
|
||||
\sphinxAtStartPar
|
||||
Close muSRFlow and install the refreshed Windows application.
|
||||
|
||||
\item {}
|
||||
\sphinxAtStartPar
|
||||
If your runtime was imported from an older bundle, add the missing Boost
|
||||
headers from PowerShell:
|
||||
|
||||
\begin{sphinxVerbatim}[commandchars=\\\{\}]
|
||||
\PYG{n}{wsl} \PYG{n}{\PYGZhy{}d} \PYG{n}{muSRFlow}\PYG{n}{\PYGZhy{}runtime} \PYG{p}{\PYGZhy{}}\PYG{p}{\PYGZhy{}} \PYG{n}{dnf} \PYG{n}{\PYGZhy{}y} \PYG{n}{install} \PYG{n}{boost}\PYG{n}{\PYGZhy{}devel}
|
||||
\end{sphinxVerbatim}
|
||||
|
||||
\sphinxAtStartPar
|
||||
This needs access to the distribution’s package repositories. ROOT uses
|
||||
these headers when loading musrview plotting classes. Fresh runtimes
|
||||
from the corrected installer already include them.
|
||||
|
||||
\item {}
|
||||
\sphinxAtStartPar
|
||||
Reopen muSRFlow, select your work directory in Preferences, and retry Plot
|
||||
and Fit.
|
||||
|
||||
\end{enumerate}
|
||||
|
||||
\sphinxAtStartPar
|
||||
If setup fails, check WSL, restart muSRFlow, and retry. If plotting fails
|
||||
after setup, check that \sphinxcode{\sphinxupquote{wsl \sphinxhyphen{}\sphinxhyphen{}version}} includes WSLg and inspect the
|
||||
command log. The Linux \sphinxstylestrong{Install runtime…} preference does not apply to
|
||||
Windows. Installation and graphical plotting still need validation on a
|
||||
Windows PC; automated setup tests use simulated WSL commands.
|
||||
Reinstalling the application preserves an existing \sphinxcode{\sphinxupquote{muSRFlow\sphinxhyphen{}runtime}}
|
||||
distribution, so the application update alone does not add those headers.
|
||||
The command above repairs it in place; do not unregister the distribution
|
||||
as part of this update. The Linux \sphinxstylestrong{Install runtime…} preference is not
|
||||
used on Windows.
|
||||
|
||||
|
||||
\section{Running the desktop app}
|
||||
\label{\detokenize{getting-started:running-the-desktop-app}}
|
||||
\section{Troubleshooting}
|
||||
\label{\detokenize{install-windows:troubleshooting}}
|
||||
|
||||
\subsection{Required feature is not installed}
|
||||
\label{\detokenize{install-windows:required-feature-is-not-installed}}
|
||||
\sphinxAtStartPar
|
||||
When the window opens, the \sphinxstylestrong{Runs} tab is active and the current year is
|
||||
already selected. Enter run numbers, choose a model, and press \sphinxstylestrong{Fit}. The
|
||||
first fit writes the working files next to your MSR document and results
|
||||
appear in the \sphinxstylestrong{Results} tab.
|
||||
For \sphinxcode{\sphinxupquote{HCS\_E\_SERVICE\_NOT\_AVAILABLE}} during runtime preparation, Windows
|
||||
could not create the WSL virtual machine. In \sphinxstylestrong{administrator PowerShell}:
|
||||
|
||||
\begin{sphinxVerbatim}[commandchars=\\\{\}]
|
||||
\PYG{n}{dism}\PYG{p}{.}\PYG{n}{exe} \PYG{p}{/}\PYG{n}{online} \PYG{p}{/}\PYG{n+nb}{enable\PYGZhy{}feature} \PYG{p}{/}\PYG{n}{featurename}\PYG{p}{:}\PYG{n}{VirtualMachinePlatform} \PYG{p}{/}\PYG{n}{all} \PYG{p}{/}\PYG{n}{norestart}
|
||||
\end{sphinxVerbatim}
|
||||
|
||||
\section{Opening the web edition}
|
||||
\label{\detokenize{getting-started:opening-the-web-edition}}
|
||||
\sphinxAtStartPar
|
||||
Point your browser at the deployment URL (e.g.
|
||||
\sphinxcode{\sphinxupquote{http://musruser.psi.ch/muSRFlow/}}). Instrument options and run numbers are
|
||||
the ones the server data tree supports. There is nothing to install; the
|
||||
parameter table is also served from the same data tree.
|
||||
Restart Windows. Check \sphinxstylestrong{Task Manager / Performance / CPU} for
|
||||
\sphinxstylestrong{Virtualization: Enabled}; if disabled, enable hardware virtualization in
|
||||
BIOS/UEFI. If Windows itself is a virtual machine, its host must expose nested
|
||||
virtualization. If the error persists, check the boot setting:
|
||||
|
||||
\begin{sphinxVerbatim}[commandchars=\\\{\}]
|
||||
\PYG{n}{bcdedit} \PYG{p}{/}\PYG{n}{enum} \PYG{p}{|} \PYG{n}{findstr} \PYG{n}{\PYGZhy{}i} \PYG{n}{hypervisorlaunchtype}
|
||||
\end{sphinxVerbatim}
|
||||
|
||||
\section{The Quick Start guide}
|
||||
\label{\detokenize{getting-started:the-quick-start-guide}}
|
||||
\sphinxAtStartPar
|
||||
The \sphinxcode{\sphinxupquote{?}} button at the right of the tab bar opens a short, tab\sphinxhyphen{}aware guide.
|
||||
On the desktop it opens in an independent window; in the browser it opens a
|
||||
modeless dialog next to the main window. Each of its sections corresponds to
|
||||
one tab and is expanded into a chapter of this manual.
|
||||
Only if it reports \sphinxcode{\sphinxupquote{Off}}, enable it and restart:
|
||||
|
||||
\begin{sphinxVerbatim}[commandchars=\\\{\}]
|
||||
\PYG{n}{bcdedit} \PYG{p}{/}\PYG{n+nb}{set }\PYG{n}{hypervisorlaunchtype} \PYG{n}{Auto}
|
||||
\end{sphinxVerbatim}
|
||||
|
||||
\section{Support}
|
||||
\label{\detokenize{getting-started:support}}
|
||||
\sphinxAtStartPar
|
||||
For questions and bug reports contact Zaher Salman
|
||||
\sphinxurl{mailto:zaher.salman@psi.ch}. Issue tracking is linked from the project
|
||||
repository.
|
||||
See \sphinxhref{https://learn.microsoft.com/en-us/windows/wsl/troubleshooting}{Microsoft’s WSL troubleshooting guide}.
|
||||
|
||||
|
||||
\subsection{Cannot find wsl.exe}
|
||||
\label{\detokenize{install-windows:cannot-find-wsl-exe}}
|
||||
\sphinxAtStartPar
|
||||
For \sphinxcode{\sphinxupquote{spawn wsl.exe ENOENT}}, first check that \sphinxcode{\sphinxupquote{wsl \sphinxhyphen{}\sphinxhyphen{}version}} works in
|
||||
PowerShell. If it does, install the refreshed muSRFlow build: early rc.5
|
||||
builds incorrectly replaced the Windows executable search path. Also check
|
||||
that the selected work directory exists and is writable.
|
||||
|
||||
|
||||
\subsection{Cannot load libCore.so}
|
||||
\label{\detokenize{install-windows:cannot-load-libcore-so}}
|
||||
\sphinxAtStartPar
|
||||
Install the refreshed muSRFlow build. It passes the ROOT library directory
|
||||
inside WSL for every bundled command. Setting a Windows \sphinxcode{\sphinxupquote{ROOTSYS}} or
|
||||
\sphinxcode{\sphinxupquote{LD\_LIBRARY\_PATH}} is not a substitute for this launcher fix.
|
||||
|
||||
|
||||
\subsection{Missing boost/version.hpp or plotting crash}
|
||||
\label{\detokenize{install-windows:missing-boost-version-hpp-or-plotting-crash}}
|
||||
\sphinxAtStartPar
|
||||
Follow {\hyperref[\detokenize{install-windows:existing-installations}]{\sphinxcrossref{Existing installations}}} to install \sphinxcode{\sphinxupquote{boost\sphinxhyphen{}devel}} in an older
|
||||
runtime. The corrected runtime includes it. If plotting still crashes,
|
||||
include the full command output when reporting the problem.
|
||||
|
||||
|
||||
\subsection{No spectrum window appears}
|
||||
\label{\detokenize{install-windows:no-spectrum-window-appears}}
|
||||
\sphinxAtStartPar
|
||||
Confirm that \sphinxcode{\sphinxupquote{wsl \sphinxhyphen{}\sphinxhyphen{}version}} lists WSLg, update WSL, and inspect the
|
||||
muSRFlow run log. Successful runtime import or a successful fit alone does
|
||||
not verify interactive graphics support.
|
||||
|
||||
|
||||
\subsection{Reporting a problem}
|
||||
\label{\detokenize{install-windows:reporting-a-problem}}
|
||||
\sphinxAtStartPar
|
||||
Include the muSRFlow version, full run log, and the output of:
|
||||
|
||||
\begin{sphinxVerbatim}[commandchars=\\\{\}]
|
||||
\PYG{n}{wsl} \PYG{p}{\PYGZhy{}}\PYG{n}{\PYGZhy{}version}
|
||||
\PYG{n}{wsl} \PYG{p}{\PYGZhy{}}\PYG{n}{\PYGZhy{}status}
|
||||
\PYG{n}{wsl} \PYG{p}{\PYGZhy{}}\PYG{n}{\PYGZhy{}list} \PYG{p}{\PYGZhy{}}\PYG{n}{\PYGZhy{}verbose}
|
||||
\end{sphinxVerbatim}
|
||||
|
||||
\sphinxAtStartPar
|
||||
The corrected runtime has completed a real fit and generated a PNG in a
|
||||
Linux container. Interactive Windows/WSLg plotting still needs validation
|
||||
on the target PC.
|
||||
|
||||
\sphinxstepscope
|
||||
|
||||
|
||||
\chapter{Linux installation}
|
||||
\label{\detokenize{install-linux:linux-installation}}\label{\detokenize{install-linux:id1}}\label{\detokenize{install-linux::doc}}
|
||||
\sphinxAtStartPar
|
||||
Install the muSRFlow application, then select a working ROOT + musrfit
|
||||
installation. \sphinxstylestrong{The Linux application package does not include the scientific
|
||||
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.
|
||||
|
||||
\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
|
||||
commands from the folder containing the downloaded files.
|
||||
|
||||
|
||||
\section{Install the application}
|
||||
\label{\detokenize{install-linux:install-the-application}}
|
||||
\sphinxAtStartPar
|
||||
Choose one application format.
|
||||
|
||||
|
||||
\subsection{RPM}
|
||||
\label{\detokenize{install-linux:rpm}}
|
||||
\sphinxAtStartPar
|
||||
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
|
||||
musrflow
|
||||
\end{sphinxVerbatim}
|
||||
|
||||
\sphinxAtStartPar
|
||||
On other RPM systems, use the distribution’s package manager. The application
|
||||
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
|
||||
\end{sphinxVerbatim}
|
||||
|
||||
\sphinxAtStartPar
|
||||
The application AppImage filename starts with \sphinxcode{\sphinxupquote{muSRFlow}}. It requires a
|
||||
compatible Linux desktop and AppImage/FUSE support. If it cannot start,
|
||||
check the terminal output or use the RPM on a supported RPM distribution.
|
||||
|
||||
|
||||
\section{Set up ROOT and musrfit}
|
||||
\label{\detokenize{install-linux:set-up-root-and-musrfit}}
|
||||
|
||||
\subsection{Use an existing installation}
|
||||
\label{\detokenize{install-linux:use-an-existing-installation}}
|
||||
\sphinxAtStartPar
|
||||
Open \sphinxstylestrong{File / Preferences}. Leave \sphinxstylestrong{musrfit binaries} on automatic detection
|
||||
for a standard installation, or choose the directory containing \sphinxcode{\sphinxupquote{musrfit}},
|
||||
\sphinxcode{\sphinxupquote{musrview}}, \sphinxcode{\sphinxupquote{msr2data}}, \sphinxcode{\sphinxupquote{musrt0}}, and \sphinxcode{\sphinxupquote{dump\_header}}. Save your settings,
|
||||
then use \sphinxstylestrong{Check tools} to verify the saved selection.
|
||||
|
||||
|
||||
\subsection{Install the separate runtime from a local bundle}
|
||||
\label{\detokenize{install-linux:install-the-separate-runtime-from-a-local-bundle}}\begin{enumerate}
|
||||
\sphinxsetlistlabels{\arabic}{enumi}{enumii}{}{.}%
|
||||
\item {}
|
||||
\sphinxAtStartPar
|
||||
Obtain the runtime bundle for your architecture. Keep
|
||||
\sphinxcode{\sphinxupquote{runtime\sphinxhyphen{}download.json}} and its matching \sphinxcode{\sphinxupquote{musrflow\sphinxhyphen{}runtime\sphinxhyphen{}*.tar.gz}}
|
||||
archive in the same folder. You do not need to unpack it.
|
||||
|
||||
\item {}
|
||||
\sphinxAtStartPar
|
||||
Open \sphinxstylestrong{File / Preferences / Install runtime…} and select
|
||||
\sphinxcode{\sphinxupquote{runtime\sphinxhyphen{}download.json}}.
|
||||
|
||||
\item {}
|
||||
\sphinxAtStartPar
|
||||
Review the versions and destination, then select \sphinxstylestrong{Install and use}.
|
||||
muSRFlow validates the archive, installs it in your personal application
|
||||
data directory, and selects its tools.
|
||||
|
||||
\item {}
|
||||
\sphinxAtStartPar
|
||||
Use \sphinxstylestrong{Check tools} to confirm the selected runtime starts.
|
||||
|
||||
\end{enumerate}
|
||||
|
||||
\sphinxAtStartPar
|
||||
This installation does not require administrator access. Runtime downloads
|
||||
are not automatic: obtain the bundle separately before opening the installer.
|
||||
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
|
||||
\end{sphinxVerbatim}
|
||||
|
||||
\sphinxAtStartPar
|
||||
This installs the runtime into \sphinxcode{\sphinxupquote{/opt/musrflow/runtime}}, which muSRFlow
|
||||
recognizes automatically when no explicit tool directory takes precedence.
|
||||
|
||||
|
||||
\subsection{Alternative: runtime AppImage}
|
||||
\label{\detokenize{install-linux:alternative-runtime-appimage}}
|
||||
\sphinxAtStartPar
|
||||
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{}}
|
||||
\end{sphinxVerbatim}
|
||||
|
||||
\sphinxAtStartPar
|
||||
Launch the application with the installed runtime selected:
|
||||
|
||||
\begin{sphinxVerbatim}[commandchars=\\\{\}]
|
||||
\PYG{n+nv}{MUSRFLOW\PYGZus{}RUNTIME\PYGZus{}ROOT}\PYG{o}{=}\PYG{l+s+s2}{\PYGZdq{}}\PYG{n+nv}{\PYGZdl{}HOME}\PYG{l+s+s2}{/.local/share/musrflow/runtime}\PYG{l+s+s2}{\PYGZdq{}}\PYG{+w}{ }musrflow
|
||||
\end{sphinxVerbatim}
|
||||
|
||||
\sphinxAtStartPar
|
||||
For the application AppImage, replace \sphinxcode{\sphinxupquote{musrflow}} in that command with its
|
||||
path. Leave \sphinxstylestrong{musrfit binaries} on automatic detection so the selected
|
||||
runtime is used. Without a custom destination, the runtime AppImage installs
|
||||
to \sphinxcode{\sphinxupquote{/opt/musrflow/runtime}} and needs permission to write there. Its filename
|
||||
is lowercase \sphinxcode{\sphinxupquote{musrflow\sphinxhyphen{}runtime}}, unlike the application AppImage.
|
||||
|
||||
|
||||
\section{Choose folders and test}
|
||||
\label{\detokenize{install-linux:choose-folders-and-test}}\begin{enumerate}
|
||||
\sphinxsetlistlabels{\arabic}{enumi}{enumii}{}{.}%
|
||||
\item {}
|
||||
\sphinxAtStartPar
|
||||
In \sphinxstylestrong{File / Preferences}, choose a writable \sphinxstylestrong{Work directory} outside
|
||||
the application installation folder, for example \sphinxcode{\sphinxupquote{\textasciitilde{}/muSRFlow/work}}.
|
||||
Use \sphinxstylestrong{Browse…} to select it.
|
||||
|
||||
\item {}
|
||||
\sphinxAtStartPar
|
||||
Set \sphinxstylestrong{Data directory} to the root of your instrument data tree, or to a
|
||||
writable folder such as \sphinxcode{\sphinxupquote{\textasciitilde{}/muSRFlow/data}} for downloaded runs.
|
||||
|
||||
\item {}
|
||||
\sphinxAtStartPar
|
||||
Leave \sphinxstylestrong{musrfit startup XML} on automatic detection unless you have a
|
||||
specific installation configuration, then save.
|
||||
|
||||
\item {}
|
||||
\sphinxAtStartPar
|
||||
Select a known instrument, year, and run. Click \sphinxstylestrong{Plot}, then \sphinxstylestrong{Fit}.
|
||||
Confirm the spectrum opens, fitted parameters update, and output files
|
||||
appear in your work directory. Missing runs can be downloaded from
|
||||
\sphinxcode{\sphinxupquote{musruser.psi.ch}} after confirmation when the server is reachable.
|
||||
|
||||
\end{enumerate}
|
||||
|
||||
|
||||
\section{Updating and troubleshooting}
|
||||
\label{\detokenize{install-linux:updating-and-troubleshooting}}\begin{itemize}
|
||||
\item {}
|
||||
\sphinxAtStartPar
|
||||
Upgrade the application RPM with your package manager, or replace the
|
||||
application AppImage. The separate runtime is not updated by an app upgrade.
|
||||
|
||||
\item {}
|
||||
\sphinxAtStartPar
|
||||
Preserve work files outside the application/runtime installation directories.
|
||||
|
||||
\item {}
|
||||
\sphinxAtStartPar
|
||||
For missing tools or shared libraries, run \sphinxstylestrong{Check tools} and inspect the
|
||||
reported executable paths. A configured binaries directory overrides
|
||||
automatic detection; clear an obsolete selection or choose the correct one.
|
||||
|
||||
\item {}
|
||||
\sphinxAtStartPar
|
||||
If fitting works but no spectrum window opens, inspect the run log and
|
||||
confirm your desktop session can display native musrview windows.
|
||||
|
||||
\item {}
|
||||
\sphinxAtStartPar
|
||||
If data are missing, check the instrument, year, run number, and data root.
|
||||
Downloaded files use the selected writable data root or the personal
|
||||
fallback folder reported in Preferences.
|
||||
|
||||
\end{itemize}
|
||||
|
||||
\sphinxAtStartPar
|
||||
Include the application version and run log when reporting a problem.
|
||||
|
||||
\sphinxstepscope
|
||||
|
||||
@@ -1684,7 +2041,9 @@ configuration and never exposes this dialog.
|
||||
\sphinxlineitem{Work directory}
|
||||
\sphinxAtStartPar
|
||||
Where generated files, MSR documents, and result artifacts are written.
|
||||
Defaults to the current directory (\sphinxcode{\sphinxupquote{.}}).
|
||||
Defaults to the current directory (\sphinxcode{\sphinxupquote{.}}), which can be the application
|
||||
installation folder. Choose a separate writable work folder before fitting
|
||||
so application upgrades do not affect your results.
|
||||
|
||||
\sphinxlineitem{Data directory}
|
||||
\sphinxAtStartPar
|
||||
@@ -1726,6 +2085,13 @@ given to them. The setting is a desktop feature: it is remembered across
|
||||
sessions, while the web edition takes its tools from the server and never
|
||||
exposes this field.
|
||||
|
||||
\sphinxlineitem{Runtime installation and checks (Linux)}
|
||||
\sphinxAtStartPar
|
||||
\sphinxstylestrong{Check tools} checks the saved tool selection. \sphinxstylestrong{Install runtime…}
|
||||
installs a local runtime bundle after confirmation and selects its tools.
|
||||
See {\hyperref[\detokenize{install-linux::doc}]{\sphinxcrossref{\DUrole{doc}{Linux installation}}}} for the required files and installation steps.
|
||||
Windows uses its bundled WSL runtime instead; see {\hyperref[\detokenize{install-windows::doc}]{\sphinxcrossref{\DUrole{doc}{Windows installation}}}}.
|
||||
|
||||
\sphinxlineitem{musrfit threads}
|
||||
\sphinxAtStartPar
|
||||
The number of OpenMP threads passed to a local \sphinxcode{\sphinxupquote{musrfit}} run (\sphinxcode{\sphinxupquote{\sphinxhyphen{}u}}).
|
||||
@@ -1872,30 +2238,18 @@ Share button copies a link; opening it restores the settings.
|
||||
\section{Bundled ROOT and musrfit}
|
||||
\label{\detokenize{platforms:bundled-root-and-musrfit}}
|
||||
\sphinxAtStartPar
|
||||
Packaged desktop builds can use a self\sphinxhyphen{}contained ROOT + musrfit runtime, so a
|
||||
separate musrfit installation is not required on the machine. The runtime may
|
||||
be bundled inside the application or, on Linux, installed separately (the
|
||||
\sphinxcode{\sphinxupquote{musrflow\sphinxhyphen{}runtime}} rpm or the portable \sphinxcode{\sphinxupquote{muSRFlow\sphinxhyphen{}runtime}} AppImage, both
|
||||
defaulting to \sphinxcode{\sphinxupquote{/opt/musrflow/runtime}}). When a runtime is found muSRFlow runs
|
||||
those tools with \sphinxcode{\sphinxupquote{ROOTSYS}}, \sphinxcode{\sphinxupquote{MUSRFITPATH}}, and \sphinxcode{\sphinxupquote{LD\_LIBRARY\_PATH}} pointed
|
||||
at it; a directory set in \sphinxstylestrong{Preferences / musrfit binaries} still takes
|
||||
precedence, and on builds without a runtime the system installation is used
|
||||
exactly as before. The runtime is built with \sphinxcode{\sphinxupquote{packaging/runtime/build.sh}} and
|
||||
packaged with \sphinxcode{\sphinxupquote{packaging/runtime/build\sphinxhyphen{}runtime\sphinxhyphen{}rpm.sh}} /
|
||||
\sphinxcode{\sphinxupquote{build\sphinxhyphen{}runtime\sphinxhyphen{}appimage.sh}} (see \sphinxcode{\sphinxupquote{packaging/runtime/README.md}}).
|
||||
On Linux, the application and scientific runtime are separate. Use an
|
||||
existing ROOT + musrfit installation, install an offline runtime bundle in
|
||||
Preferences, or install the system runtime RPM/AppImage. An explicitly
|
||||
selected binaries directory takes precedence over automatic detection.
|
||||
See {\hyperref[\detokenize{install-linux::doc}]{\sphinxcrossref{\DUrole{doc}{Linux installation}}}} for installation and tool checks.
|
||||
|
||||
\sphinxAtStartPar
|
||||
On Windows the bundled runtime runs inside a WSL2 distribution that muSRFlow
|
||||
ships: the tools are invoked through \sphinxcode{\sphinxupquote{wsl.exe}} and file paths are translated
|
||||
between the Windows and WSL forms, so inputs and outputs stay on the Windows
|
||||
side. The rootfs is built with \sphinxcode{\sphinxupquote{packaging/wsl2/build\sphinxhyphen{}wsl2.sh}} and imported
|
||||
once per user (see \sphinxcode{\sphinxupquote{packaging/wsl2/README.md}}).
|
||||
|
||||
\sphinxAtStartPar
|
||||
Follow {\hyperref[\detokenize{getting-started:windows-installation}]{\sphinxcrossref{\DUrole{std}{\DUrole{std-ref}{Windows installation}}}}} for the WSL setup, Windows installer,
|
||||
folder preferences, and first Plot/Fit check. The Windows installer includes
|
||||
\sphinxcode{\sphinxupquote{muSRFlow\sphinxhyphen{}runtime\sphinxhyphen{}rootfs.tar.gz}} and imports it automatically; the separate
|
||||
Linux runtime archive and \sphinxstylestrong{Install runtime…} preference do not apply.
|
||||
On Windows, the application installer includes the runtime. It runs inside
|
||||
a WSL2 distribution named \sphinxcode{\sphinxupquote{muSRFlow\sphinxhyphen{}runtime}}. Tools are invoked through
|
||||
\sphinxcode{\sphinxupquote{wsl.exe}}, with paths translated so inputs and outputs stay on the Windows
|
||||
side. The separate Linux runtime installer does not apply to Windows.
|
||||
See {\hyperref[\detokenize{install-windows::doc}]{\sphinxcrossref{\DUrole{doc}{Windows installation}}}} for WSL setup, installation, updates, and fixes.
|
||||
|
||||
\sphinxAtStartPar
|
||||
The workflow chapters of this manual apply to both editions. Where a step is
|
||||
@@ -2001,6 +2355,11 @@ interactive chart tools (zoom, pan, box and lasso select, downloads).
|
||||
|
||||
\chapter{Troubleshooting}
|
||||
\label{\detokenize{troubleshooting:troubleshooting}}\label{\detokenize{troubleshooting::doc}}
|
||||
\sphinxAtStartPar
|
||||
For Windows setup, WSL startup errors, missing ROOT libraries, and older
|
||||
runtime updates, see {\hyperref[\detokenize{install-windows::doc}]{\sphinxcrossref{\DUrole{doc}{Windows installation}}}}. For Linux package/runtime setup,
|
||||
see {\hyperref[\detokenize{install-linux::doc}]{\sphinxcrossref{\DUrole{doc}{Linux installation}}}}. The sections below cover analysis workflows.
|
||||
|
||||
|
||||
\section{Fit or plot will not start}
|
||||
\label{\detokenize{troubleshooting:fit-or-plot-will-not-start}}
|
||||
@@ -2221,7 +2580,7 @@ If anything in this manual does not match the behaviour you see, contact
|
||||
\sphinxhref{mailto:zaher.salman@psi.ch}{Zaher Salman}.
|
||||
|
||||
\sphinxAtStartPar
|
||||
Separate repository documents cover desk build and packaging
|
||||
Separate repository documents cover desktop builds and packaging
|
||||
(\sphinxcode{\sphinxupquote{docs/DESKTOP\_DEPLOYMENT.md}}) and the web\sphinxhyphen{}server/CGI deployment
|
||||
(\sphinxcode{\sphinxupquote{cgi/README.md}}); this manual concentrates on using the application.
|
||||
|
||||
|
||||
Vendored
+94
-72
@@ -5,75 +5,97 @@
|
||||
\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}Prerequisites}{5}{section.2.1}%
|
||||
\contentsline {section}{\numberline {2.2}Development and Linux packages}{5}{section.2.2}%
|
||||
\contentsline {section}{\numberline {2.3}Windows installation}{6}{section.2.3}%
|
||||
\contentsline {section}{\numberline {2.4}Running the desktop app}{7}{section.2.4}%
|
||||
\contentsline {section}{\numberline {2.5}Opening the web edition}{7}{section.2.5}%
|
||||
\contentsline {section}{\numberline {2.6}The Quick Start guide}{7}{section.2.6}%
|
||||
\contentsline {section}{\numberline {2.7}Support}{7}{section.2.7}%
|
||||
\contentsline {chapter}{\numberline {3}Runs and fitting}{9}{chapter.3}%
|
||||
\contentsline {section}{\numberline {3.1}Run selection}{9}{section.3.1}%
|
||||
\contentsline {section}{\numberline {3.2}Fit range}{10}{section.3.2}%
|
||||
\contentsline {section}{\numberline {3.3}Fit model}{10}{section.3.3}%
|
||||
\contentsline {section}{\numberline {3.4}Fit options}{11}{section.3.4}%
|
||||
\contentsline {section}{\numberline {3.5}Series fit actions}{11}{section.3.5}%
|
||||
\contentsline {subsection}{\numberline {3.5.1}Per\sphinxhyphen {}run statistics}{11}{subsection.3.5.1}%
|
||||
\contentsline {section}{\numberline {3.6}View settings}{12}{section.3.6}%
|
||||
\contentsline {section}{\numberline {3.7}Fit and Plot}{12}{section.3.7}%
|
||||
\contentsline {chapter}{\numberline {4}Parameters and parameter plots}{15}{chapter.4}%
|
||||
\contentsline {section}{\numberline {4.1}The parameter table}{15}{section.4.1}%
|
||||
\contentsline {subsection}{\numberline {4.1.1}The \sphinxstylestrong {Shared} column}{16}{subsection.4.1.1}%
|
||||
\contentsline {section}{\numberline {4.2}Selecting parameters for plotting}{16}{section.4.2}%
|
||||
\contentsline {section}{\numberline {4.3}The Choose X axis dialog}{16}{section.4.3}%
|
||||
\contentsline {section}{\numberline {4.4}The parameter\sphinxhyphen {}plot window}{16}{section.4.4}%
|
||||
\contentsline {subsection}{\numberline {4.4.1}Plot options}{17}{subsection.4.4.1}%
|
||||
\contentsline {subsection}{\numberline {4.4.2}Remembered plot configurations}{17}{subsection.4.4.2}%
|
||||
\contentsline {subsection}{\numberline {4.4.3}Overlay data sets (multiple files in one panel)}{18}{subsection.4.4.3}%
|
||||
\contentsline {subsection}{\numberline {4.4.4}Editing trace styles}{19}{subsection.4.4.4}%
|
||||
\contentsline {subsection}{\numberline {4.4.5}Template and series presets}{19}{subsection.4.4.5}%
|
||||
\contentsline {subsection}{\numberline {4.4.6}Keyboard shortcuts}{19}{subsection.4.4.6}%
|
||||
\contentsline {chapter}{\numberline {5}Constraints}{21}{chapter.5}%
|
||||
\contentsline {section}{\numberline {5.1}Custom parameters}{21}{section.5.1}%
|
||||
\contentsline {section}{\numberline {5.2}Constraints}{21}{section.5.2}%
|
||||
\contentsline {section}{\numberline {5.3}Example: couple the magnetic field to the Larmor frequency}{22}{section.5.3}%
|
||||
\contentsline {section}{\numberline {5.4}Preview}{22}{section.5.4}%
|
||||
\contentsline {chapter}{\numberline {6}t0 / background}{23}{chapter.6}%
|
||||
\contentsline {section}{\numberline {6.1}Multi\sphinxhyphen {}group asymmetry fits}{23}{section.6.1}%
|
||||
\contentsline {chapter}{\numberline {7}MSR editor}{25}{chapter.7}%
|
||||
\contentsline {section}{\numberline {7.1}Ownership: GUI or editor}{25}{section.7.1}%
|
||||
\contentsline {section}{\numberline {7.2}Workflow}{25}{section.7.2}%
|
||||
\contentsline {section}{\numberline {7.3}File handling}{26}{section.7.3}%
|
||||
\contentsline {chapter}{\numberline {8}Results and diagnostics}{27}{chapter.8}%
|
||||
\contentsline {section}{\numberline {8.1}Result files}{27}{section.8.1}%
|
||||
\contentsline {section}{\numberline {8.2}Execution details}{27}{section.8.2}%
|
||||
\contentsline {section}{\numberline {8.3}Command log}{28}{section.8.3}%
|
||||
\contentsline {section}{\numberline {8.4}The status bar}{28}{section.8.4}%
|
||||
\contentsline {section}{\numberline {8.5}Run log window}{28}{section.8.5}%
|
||||
\contentsline {section}{\numberline {8.6}Outcome dialog}{28}{section.8.6}%
|
||||
\contentsline {chapter}{\numberline {9}Configuration sharing}{29}{chapter.9}%
|
||||
\contentsline {section}{\numberline {9.1}What is shared}{29}{section.9.1}%
|
||||
\contentsline {section}{\numberline {9.2}On the web}{29}{section.9.2}%
|
||||
\contentsline {section}{\numberline {9.3}On the desktop}{30}{section.9.3}%
|
||||
\contentsline {section}{\numberline {9.4}Notes}{30}{section.9.4}%
|
||||
\contentsline {chapter}{\numberline {10}Preferences}{31}{chapter.10}%
|
||||
\contentsline {chapter}{\numberline {11}Web and desktop editions}{33}{chapter.11}%
|
||||
\contentsline {section}{\numberline {11.1}Bundled ROOT and musrfit}{33}{section.11.1}%
|
||||
\contentsline {section}{\numberline {11.2}Downloading missing runs}{34}{section.11.2}%
|
||||
\contentsline {chapter}{\numberline {12}Keyboard shortcuts}{35}{chapter.12}%
|
||||
\contentsline {section}{\numberline {12.1}Parameter selection (Parameters tab)}{35}{section.12.1}%
|
||||
\contentsline {section}{\numberline {12.2}Parameter\sphinxhyphen {}plot window}{35}{section.12.2}%
|
||||
\contentsline {section}{\numberline {12.3}MSR editor}{35}{section.12.3}%
|
||||
\contentsline {section}{\numberline {12.4}General notes}{36}{section.12.4}%
|
||||
\contentsline {chapter}{\numberline {13}Troubleshooting}{37}{chapter.13}%
|
||||
\contentsline {section}{\numberline {13.1}Fit or plot will not start}{37}{section.13.1}%
|
||||
\contentsline {section}{\numberline {13.2}“Nothing to fit”}{37}{section.13.2}%
|
||||
\contentsline {section}{\numberline {13.3}Fitted parameters look wrong or unchanged}{37}{section.13.3}%
|
||||
\contentsline {section}{\numberline {13.4}Parameter plot is empty or missing data}{38}{section.13.4}%
|
||||
\contentsline {section}{\numberline {13.5}Parameter plot hangs on “Preparing plot files”}{38}{section.13.5}%
|
||||
\contentsline {section}{\numberline {13.6}Web page cannot load data}{38}{section.13.6}%
|
||||
\contentsline {section}{\numberline {13.7}Restored configuration differs from the original machine}{38}{section.13.7}%
|
||||
\contentsline {section}{\numberline {13.8}Some links start with a different prefix}{38}{section.13.8}%
|
||||
\contentsline {section}{\numberline {13.9}Reporting problems}{39}{section.13.9}%
|
||||
\contentsline {chapter}{\numberline {14}Glossary}{41}{chapter.14}%
|
||||
\contentsline {chapter}{Index}{43}{section*.18}%
|
||||
\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}%
|
||||
+33
-106
@@ -1,138 +1,65 @@
|
||||
Getting started
|
||||
===============
|
||||
|
||||
Prerequisites
|
||||
-------------
|
||||
Choose your edition
|
||||
-------------------
|
||||
|
||||
muSRFlow wraps external ``musrfit`` tools. How they are supplied depends on
|
||||
the edition:
|
||||
* **Windows desktop:** follow :doc:`install-windows`. ROOT and musrfit are
|
||||
included in a WSL2 runtime. The guide covers first installation, existing
|
||||
runtime updates, and Windows-specific errors.
|
||||
* **Linux desktop:** follow :doc:`install-linux`. Use an existing musrfit
|
||||
installation or install the separate runtime through Preferences.
|
||||
* **Web:** open your site's muSRFlow URL, for example
|
||||
``http://musruser.psi.ch/muSRFlow/``. The server runs the tools; there is
|
||||
nothing to install on your computer.
|
||||
|
||||
* Linux desktop: use a local musrfit installation or install the separate
|
||||
ROOT + musrfit runtime. Select the tools through **File / Preferences**.
|
||||
* Windows desktop: the installer includes ROOT and musrfit in a WSL2 runtime.
|
||||
Install WSL first, following :ref:`windows-installation` below.
|
||||
* Web: the tools are installed on the server that hosts the CGI runner.
|
||||
|
||||
Packaged desktop applications do not require Node.js or npm on the target
|
||||
PC. The browser edition needs no local installation at all.
|
||||
Packaged desktop applications do not require Node.js or npm.
|
||||
|
||||
.. _desktop-installation:
|
||||
|
||||
Development and Linux packages
|
||||
------------------------------
|
||||
Desktop installation
|
||||
--------------------
|
||||
|
||||
From a checkout, with `Node.js <https://nodejs.org/>`_ and npm installed:
|
||||
The complete instructions are in :doc:`install-windows` and
|
||||
:doc:`install-linux`. Choose work and data folders in **File / Preferences**
|
||||
before your first analysis. Keep work files outside the application
|
||||
installation directory.
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ npm install
|
||||
$ npm start
|
||||
|
||||
`npm install` is only needed once; later sessions start with `npm start`.
|
||||
|
||||
Release packages (Linux RPM and AppImage) are produced with:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ npm run dist:rpm
|
||||
$ npm run dist:appimage
|
||||
|
||||
Each command also builds the matching standalone ROOT + musrfit runtime
|
||||
artifact (``musrflow-runtime`` rpm / AppImage); ``npm run dist:runtime`` builds
|
||||
only the runtime. The build and runtime requirements are described in
|
||||
``docs/DESKTOP_DEPLOYMENT.md``.
|
||||
|
||||
.. _windows-installation:
|
||||
.. _getting-started-windows-installation:
|
||||
|
||||
Windows installation
|
||||
--------------------
|
||||
|
||||
Use a 64-bit Intel/AMD Windows PC. Windows 11 is recommended; Windows 10
|
||||
requires build 19044 or newer for WSLg, which displays the ``musrview``
|
||||
windows. See `Microsoft's WSL GUI requirements
|
||||
<https://learn.microsoft.com/en-us/windows/wsl/tutorials/gui-apps>`_.
|
||||
|
||||
1. Open **PowerShell as Administrator** and install WSL:
|
||||
|
||||
.. code-block:: powershell
|
||||
|
||||
wsl --install --no-distribution
|
||||
|
||||
Restart Windows afterwards. Skip this step if WSL is already installed.
|
||||
You do not need Ubuntu: muSRFlow supplies its own distribution.
|
||||
|
||||
2. Update WSL and check its components in administrator PowerShell:
|
||||
|
||||
.. code-block:: powershell
|
||||
|
||||
wsl --update
|
||||
wsl --version
|
||||
|
||||
Follow any restart instructions. The output should include WSL and WSLg.
|
||||
See the `Microsoft WSL command reference
|
||||
<https://learn.microsoft.com/en-us/windows/wsl/basic-commands>`_.
|
||||
|
||||
3. Copy the release installer ``muSRFlow-<version>-x64.exe`` to Windows and
|
||||
double-click it. It includes ``muSRFlow-runtime-rootfs.tar.gz``; there is
|
||||
no separate ROOT or musrfit installation or manual archive import.
|
||||
|
||||
4. Launch muSRFlow from the Start menu using your normal Windows account.
|
||||
The first launch prepares the runtime, which can take several minutes.
|
||||
Fit and Plot wait until preparation finishes. Afterwards, verify:
|
||||
|
||||
.. code-block:: powershell
|
||||
|
||||
wsl --list --verbose
|
||||
|
||||
The list should contain ``muSRFlow-runtime`` with **VERSION 2**.
|
||||
``Running`` and ``Stopped`` are both normal when idle.
|
||||
|
||||
5. Create writable work and data folders, for example
|
||||
``C:\Users\<your-name>\muSRFlow\work`` and
|
||||
``C:\Users\<your-name>\muSRFlow\data``. Choose them in
|
||||
**File / Preferences**. Leave **musrfit binaries** and
|
||||
**musrfit startup XML** on automatic detection, then save.
|
||||
Enter Windows paths; muSRFlow translates them for WSL.
|
||||
|
||||
6. Select a known instrument, year, and run, then press **Plot**. If data
|
||||
are missing, muSRFlow offers to download them from ``musruser.psi.ch``
|
||||
when the server is reachable. Confirm the spectrum window opens, then
|
||||
try **Fit** and check that the parameter table updates. Results stay in
|
||||
your Windows work directory.
|
||||
|
||||
If setup fails, check WSL, restart muSRFlow, and retry. If plotting fails
|
||||
after setup, check that ``wsl --version`` includes WSLg and inspect the
|
||||
command log. The Linux **Install runtime...** preference does not apply to
|
||||
Windows. Installation and graphical plotting still need validation on a
|
||||
Windows PC; automated setup tests use simulated WSL commands.
|
||||
The Windows instructions have their own chapter: :doc:`install-windows`.
|
||||
It also contains the update steps for older WSL runtimes.
|
||||
|
||||
Running the desktop app
|
||||
-----------------------
|
||||
|
||||
When the window opens, the **Runs** tab is active and the current year is
|
||||
already selected. Enter run numbers, choose a model, and press **Fit**. The
|
||||
first fit writes the working files next to your MSR document and results
|
||||
appear in the **Results** tab.
|
||||
When the window opens, the **Runs** tab is active. Choose the instrument,
|
||||
year, and run numbers, check the model, and press **Plot** to inspect the
|
||||
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.
|
||||
|
||||
Opening the web edition
|
||||
-----------------------
|
||||
|
||||
Point your browser at the deployment URL (e.g.
|
||||
``http://musruser.psi.ch/muSRFlow/``). Instrument options and run numbers are
|
||||
the ones the server data tree supports. There is nothing to install; the
|
||||
parameter table is also served from the same data tree.
|
||||
Open the deployment URL in your browser. Instrument options and available
|
||||
run data depend on that site's server configuration. Fit and Plot run on
|
||||
the server; output files can be opened from the result links.
|
||||
|
||||
The Quick Start guide
|
||||
---------------------
|
||||
|
||||
The ``?`` button at the right of the tab bar opens a short, tab-aware guide.
|
||||
On the desktop it opens in an independent window; in the browser it opens a
|
||||
modeless dialog next to the main window. Each of its sections corresponds to
|
||||
one tab and is expanded into a chapter of this manual.
|
||||
modeless dialog next to the main window. The full workflow chapters follow
|
||||
the installation guides in this manual.
|
||||
|
||||
Support
|
||||
-------
|
||||
|
||||
For questions and bug reports contact Zaher Salman
|
||||
`<zaher.salman@psi.ch>`_. Issue tracking is linked from the project
|
||||
repository.
|
||||
For questions and bug reports, include the version and run log and contact
|
||||
`Zaher Salman <mailto:zaher.salman@psi.ch>`_. See :doc:`troubleshooting`
|
||||
for common workflow problems.
|
||||
@@ -7,6 +7,9 @@ application and as a browser application, and both editions wrap the same set
|
||||
of command-line tools (``musrfit``, ``musrview``, ``msr2data``, and
|
||||
``dump_header``).
|
||||
|
||||
Start with :doc:`install-windows` or :doc:`install-linux` for desktop setup.
|
||||
For the browser edition, see :doc:`getting-started`.
|
||||
|
||||
These pages describe the end-user workflow. They are organised around the
|
||||
main window tabs, mirroring the Quick Start help that is built into the
|
||||
application (the ``?`` button).
|
||||
@@ -17,6 +20,8 @@ application (the ``?`` button).
|
||||
|
||||
overview
|
||||
getting-started
|
||||
install-windows
|
||||
install-linux
|
||||
runs-fitting
|
||||
parameters-plots
|
||||
constraints
|
||||
@@ -33,6 +38,6 @@ application (the ``?`` button).
|
||||
If anything in this manual does not match the behaviour you see, contact
|
||||
`Zaher Salman <mailto:zaher.salman@psi.ch>`_.
|
||||
|
||||
Separate repository documents cover desk build and packaging
|
||||
Separate repository documents cover desktop builds and packaging
|
||||
(``docs/DESKTOP_DEPLOYMENT.md``) and the web-server/CGI deployment
|
||||
(``cgi/README.md``); this manual concentrates on using the application.
|
||||
@@ -0,0 +1,135 @@
|
||||
.. _linux-installation:
|
||||
|
||||
Linux installation
|
||||
==================
|
||||
|
||||
Install the muSRFlow application, then select a working ROOT + musrfit
|
||||
installation. **The Linux application package does not include the scientific
|
||||
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
|
||||
commands from the folder containing the downloaded files.
|
||||
|
||||
Install the application
|
||||
-----------------------
|
||||
|
||||
Choose one application format.
|
||||
|
||||
RPM
|
||||
~~~
|
||||
|
||||
On an RPM-based distribution with dnf:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
sudo dnf install ./musrflow-1.0.0-rc.5-x86_64.rpm
|
||||
musrflow
|
||||
|
||||
On other RPM systems, use the distribution's package manager. The application
|
||||
RPM filename starts with lowercase ``musrflow``.
|
||||
|
||||
AppImage
|
||||
~~~~~~~~
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
chmod +x muSRFlow-1.0.0-rc.5-x86_64.AppImage
|
||||
./muSRFlow-1.0.0-rc.5-x86_64.AppImage
|
||||
|
||||
The application AppImage filename starts with ``muSRFlow``. It requires a
|
||||
compatible Linux desktop and AppImage/FUSE support. If it cannot start,
|
||||
check the terminal output or use the RPM on a supported RPM distribution.
|
||||
|
||||
Set up ROOT and musrfit
|
||||
-----------------------
|
||||
|
||||
Use an existing installation
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Open **File / Preferences**. Leave **musrfit binaries** on automatic detection
|
||||
for a standard installation, or choose the directory containing ``musrfit``,
|
||||
``musrview``, ``msr2data``, ``musrt0``, and ``dump_header``. Save your settings,
|
||||
then use **Check tools** to verify the saved selection.
|
||||
|
||||
Install the separate runtime from a local bundle
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
1. Obtain the runtime bundle for your architecture. Keep
|
||||
``runtime-download.json`` and its matching ``musrflow-runtime-*.tar.gz``
|
||||
archive in the same folder. You do not need to unpack it.
|
||||
2. Open **File / Preferences / Install runtime...** and select
|
||||
``runtime-download.json``.
|
||||
3. Review the versions and destination, then select **Install and use**.
|
||||
muSRFlow validates the archive, installs it in your personal application
|
||||
data directory, and selects its tools.
|
||||
4. Use **Check tools** to confirm the selected runtime starts.
|
||||
|
||||
This installation does not require administrator access. Runtime downloads
|
||||
are not automatic: obtain the bundle separately before opening the installer.
|
||||
A compatible Linux system and desktop/display services are still required.
|
||||
|
||||
Alternative: system runtime RPM
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
sudo dnf install ./musrflow-runtime-1.0.0-rc.5-x86_64.rpm
|
||||
|
||||
This installs the runtime into ``/opt/musrflow/runtime``, which muSRFlow
|
||||
recognizes automatically when no explicit tool directory takes precedence.
|
||||
|
||||
Alternative: runtime AppImage
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
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"
|
||||
|
||||
Launch the application with the installed runtime selected:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
MUSRFLOW_RUNTIME_ROOT="$HOME/.local/share/musrflow/runtime" musrflow
|
||||
|
||||
For the application AppImage, replace ``musrflow`` in that command with its
|
||||
path. Leave **musrfit binaries** on automatic detection so the selected
|
||||
runtime is used. Without a custom destination, the runtime AppImage installs
|
||||
to ``/opt/musrflow/runtime`` and needs permission to write there. Its filename
|
||||
is lowercase ``musrflow-runtime``, unlike the application AppImage.
|
||||
|
||||
Choose folders and test
|
||||
-----------------------
|
||||
|
||||
1. In **File / Preferences**, choose a writable **Work directory** outside
|
||||
the application installation folder, for example ``~/muSRFlow/work``.
|
||||
Use **Browse...** to select it.
|
||||
2. Set **Data directory** to the root of your instrument data tree, or to a
|
||||
writable folder such as ``~/muSRFlow/data`` for downloaded runs.
|
||||
3. Leave **musrfit startup XML** on automatic detection unless you have a
|
||||
specific installation configuration, then save.
|
||||
4. Select a known instrument, year, and run. Click **Plot**, then **Fit**.
|
||||
Confirm the spectrum opens, fitted parameters update, and output files
|
||||
appear in your work directory. Missing runs can be downloaded from
|
||||
``musruser.psi.ch`` after confirmation when the server is reachable.
|
||||
|
||||
Updating and troubleshooting
|
||||
----------------------------
|
||||
|
||||
* Upgrade the application RPM with your package manager, or replace the
|
||||
application AppImage. The separate runtime is not updated by an app upgrade.
|
||||
* Preserve work files outside the application/runtime installation directories.
|
||||
* For missing tools or shared libraries, run **Check tools** and inspect the
|
||||
reported executable paths. A configured binaries directory overrides
|
||||
automatic detection; clear an obsolete selection or choose the correct one.
|
||||
* If fitting works but no spectrum window opens, inspect the run log and
|
||||
confirm your desktop session can display native musrview windows.
|
||||
* If data are missing, check the instrument, year, run number, and data root.
|
||||
Downloaded files use the selected writable data root or the personal
|
||||
fallback folder reported in Preferences.
|
||||
|
||||
Include the application version and run log when reporting a problem.
|
||||
@@ -0,0 +1,193 @@
|
||||
.. _windows-installation:
|
||||
|
||||
Windows installation
|
||||
====================
|
||||
|
||||
The Windows installer includes muSRFlow, ROOT, and musrfit. Install WSL2
|
||||
first; muSRFlow prepares its own Linux runtime on first launch. You do not
|
||||
need Node.js, npm, Ubuntu, or a separate ROOT/musrfit installation.
|
||||
|
||||
Already installed muSRFlow? Read `Existing installations`_ as well: updating
|
||||
the application does not update an already imported WSL runtime.
|
||||
|
||||
Before you start
|
||||
----------------
|
||||
|
||||
* Use a **64-bit Intel/AMD PC**. The current package is x64.
|
||||
* 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``.
|
||||
|
||||
**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.
|
||||
|
||||
See `Microsoft's WSL GUI requirements
|
||||
<https://learn.microsoft.com/en-us/windows/wsl/tutorials/gui-apps>`_ for the
|
||||
Windows prerequisites.
|
||||
|
||||
Install step by step
|
||||
--------------------
|
||||
|
||||
1. **Install WSL.** Open **PowerShell as Administrator** and run:
|
||||
|
||||
.. code-block:: powershell
|
||||
|
||||
wsl --install --no-distribution
|
||||
|
||||
**Restart Windows afterwards.** Skip this step if WSL is already installed.
|
||||
muSRFlow supplies its own distribution, so Ubuntu is not required.
|
||||
|
||||
2. **Update and check WSL.** In administrator PowerShell, run:
|
||||
|
||||
.. code-block:: powershell
|
||||
|
||||
wsl --update
|
||||
wsl --version
|
||||
|
||||
Follow any restart instructions. The output should include WSL and WSLg.
|
||||
These commands are described in the `Microsoft WSL command reference
|
||||
<https://learn.microsoft.com/en-us/windows/wsl/basic-commands>`_.
|
||||
|
||||
3. **Install muSRFlow.** Double-click the Windows installer and complete setup.
|
||||
The runtime archive ``muSRFlow-runtime-rootfs.tar.gz`` is included; do not
|
||||
extract or import it manually for a normal installation.
|
||||
|
||||
4. **Launch muSRFlow** from the Start menu using your normal Windows account.
|
||||
First launch imports the runtime as ``muSRFlow-runtime`` and can take
|
||||
several minutes. Fit and Plot wait until preparation finishes. Afterwards,
|
||||
verify in PowerShell:
|
||||
|
||||
.. code-block:: powershell
|
||||
|
||||
wsl --list --verbose
|
||||
|
||||
The list should contain ``muSRFlow-runtime`` with **VERSION 2**.
|
||||
``Running`` and ``Stopped`` are both normal when idle. The runtime is
|
||||
stored under ``%LOCALAPPDATA%\muSRFlow\muSRFlow-runtime`` for this account.
|
||||
|
||||
5. **Choose work and data folders before fitting.** Create folders such as:
|
||||
|
||||
.. code-block:: text
|
||||
|
||||
C:\Users\<your-name>\muSRFlow\work
|
||||
C:\Users\<your-name>\muSRFlow\data
|
||||
|
||||
In **File / Preferences**, select them as **Work directory** and
|
||||
**Data directory**. Leave **musrfit binaries** and **musrfit startup XML**
|
||||
on automatic detection, then save. Enter normal Windows paths; muSRFlow
|
||||
translates them for WSL.
|
||||
|
||||
Use a work folder outside the application installation directory. The
|
||||
default ``.`` can resolve to the installation folder and place your
|
||||
results among files managed by the installer.
|
||||
|
||||
6. **Try Plot, then Fit.** Select a known instrument, year, and run. Click
|
||||
**Plot** and confirm that the spectrum window opens. Missing run data
|
||||
can be downloaded from ``musruser.psi.ch`` after confirmation when the
|
||||
server is reachable. Then click **Fit**, check that the parameter table
|
||||
updates, and inspect the generated files in your work directory.
|
||||
|
||||
Existing installations
|
||||
----------------------
|
||||
|
||||
1. Preserve any MSR/data/result files currently stored inside the muSRFlow
|
||||
installation folder: move them to a separate work folder before upgrading.
|
||||
2. Close muSRFlow and install the refreshed Windows application.
|
||||
3. If your runtime was imported from an older bundle, add the missing Boost
|
||||
headers from PowerShell:
|
||||
|
||||
.. code-block:: powershell
|
||||
|
||||
wsl -d muSRFlow-runtime -- dnf -y install boost-devel
|
||||
|
||||
This needs access to the distribution's package repositories. ROOT uses
|
||||
these headers when loading musrview plotting classes. Fresh runtimes
|
||||
from the corrected installer already include them.
|
||||
4. Reopen muSRFlow, select your work directory in Preferences, and retry Plot
|
||||
and Fit.
|
||||
|
||||
Reinstalling the application preserves an existing ``muSRFlow-runtime``
|
||||
distribution, so the application update alone does not add those headers.
|
||||
The command above repairs it in place; do not unregister the distribution
|
||||
as part of this update. The Linux **Install runtime...** preference is not
|
||||
used on Windows.
|
||||
|
||||
Troubleshooting
|
||||
---------------
|
||||
|
||||
Required feature is not installed
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
For ``HCS_E_SERVICE_NOT_AVAILABLE`` during runtime preparation, Windows
|
||||
could not create the WSL virtual machine. In **administrator PowerShell**:
|
||||
|
||||
.. code-block:: powershell
|
||||
|
||||
dism.exe /online /enable-feature /featurename:VirtualMachinePlatform /all /norestart
|
||||
|
||||
Restart Windows. Check **Task Manager / Performance / CPU** for
|
||||
**Virtualization: Enabled**; if disabled, enable hardware virtualization in
|
||||
BIOS/UEFI. If Windows itself is a virtual machine, its host must expose nested
|
||||
virtualization. If the error persists, check the boot setting:
|
||||
|
||||
.. code-block:: powershell
|
||||
|
||||
bcdedit /enum | findstr -i hypervisorlaunchtype
|
||||
|
||||
Only if it reports ``Off``, enable it and restart:
|
||||
|
||||
.. code-block:: powershell
|
||||
|
||||
bcdedit /set hypervisorlaunchtype Auto
|
||||
|
||||
See `Microsoft's WSL troubleshooting guide
|
||||
<https://learn.microsoft.com/en-us/windows/wsl/troubleshooting>`_.
|
||||
|
||||
Cannot find wsl.exe
|
||||
~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
For ``spawn wsl.exe ENOENT``, first check that ``wsl --version`` works in
|
||||
PowerShell. If it does, install the refreshed muSRFlow build: early rc.5
|
||||
builds incorrectly replaced the Windows executable search path. Also check
|
||||
that the selected work directory exists and is writable.
|
||||
|
||||
Cannot load libCore.so
|
||||
~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Install the refreshed muSRFlow build. It passes the ROOT library directory
|
||||
inside WSL for every bundled command. Setting a Windows ``ROOTSYS`` or
|
||||
``LD_LIBRARY_PATH`` is not a substitute for this launcher fix.
|
||||
|
||||
Missing boost/version.hpp or plotting crash
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Follow `Existing installations`_ to install ``boost-devel`` in an older
|
||||
runtime. The corrected runtime includes it. If plotting still crashes,
|
||||
include the full command output when reporting the problem.
|
||||
|
||||
No spectrum window appears
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Confirm that ``wsl --version`` lists WSLg, update WSL, and inspect the
|
||||
muSRFlow run log. Successful runtime import or a successful fit alone does
|
||||
not verify interactive graphics support.
|
||||
|
||||
Reporting a problem
|
||||
~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Include the muSRFlow version, full run log, and the output of:
|
||||
|
||||
.. code-block:: powershell
|
||||
|
||||
wsl --version
|
||||
wsl --status
|
||||
wsl --list --verbose
|
||||
|
||||
The corrected runtime has completed a real fit and generated a PNG in a
|
||||
Linux container. Interactive Windows/WSLg plotting still needs validation
|
||||
on the target PC.
|
||||
+10
-21
@@ -38,28 +38,17 @@ the command-line tools live.
|
||||
Bundled ROOT and musrfit
|
||||
------------------------
|
||||
|
||||
Packaged desktop builds can use a self-contained ROOT + musrfit runtime, so a
|
||||
separate musrfit installation is not required on the machine. The runtime may
|
||||
be bundled inside the application or, on Linux, installed separately (the
|
||||
``musrflow-runtime`` rpm or the portable ``muSRFlow-runtime`` AppImage, both
|
||||
defaulting to ``/opt/musrflow/runtime``). When a runtime is found muSRFlow runs
|
||||
those tools with ``ROOTSYS``, ``MUSRFITPATH``, and ``LD_LIBRARY_PATH`` pointed
|
||||
at it; a directory set in **Preferences / musrfit binaries** still takes
|
||||
precedence, and on builds without a runtime the system installation is used
|
||||
exactly as before. The runtime is built with ``packaging/runtime/build.sh`` and
|
||||
packaged with ``packaging/runtime/build-runtime-rpm.sh`` /
|
||||
``build-runtime-appimage.sh`` (see ``packaging/runtime/README.md``).
|
||||
On Linux, the application and scientific runtime are separate. Use an
|
||||
existing ROOT + musrfit installation, install an offline runtime bundle in
|
||||
Preferences, or install the system runtime RPM/AppImage. An explicitly
|
||||
selected binaries directory takes precedence over automatic detection.
|
||||
See :doc:`install-linux` for installation and tool checks.
|
||||
|
||||
On Windows the bundled runtime runs inside a WSL2 distribution that muSRFlow
|
||||
ships: the tools are invoked through ``wsl.exe`` and file paths are translated
|
||||
between the Windows and WSL forms, so inputs and outputs stay on the Windows
|
||||
side. The rootfs is built with ``packaging/wsl2/build-wsl2.sh`` and imported
|
||||
once per user (see ``packaging/wsl2/README.md``).
|
||||
|
||||
Follow :ref:`windows-installation` for the WSL setup, Windows installer,
|
||||
folder preferences, and first Plot/Fit check. The Windows installer includes
|
||||
``muSRFlow-runtime-rootfs.tar.gz`` and imports it automatically; the separate
|
||||
Linux runtime archive and **Install runtime...** preference do not apply.
|
||||
On Windows, the application installer includes the runtime. It runs inside
|
||||
a WSL2 distribution named ``muSRFlow-runtime``. Tools are invoked through
|
||||
``wsl.exe``, with paths translated so inputs and outputs stay on the Windows
|
||||
side. The separate Linux runtime installer does not apply to Windows.
|
||||
See :doc:`install-windows` for WSL setup, installation, updates, and fixes.
|
||||
|
||||
The workflow chapters of this manual apply to both editions. Where a step is
|
||||
specific to one edition (handling files, Preferences), the text says so
|
||||
|
||||
@@ -7,7 +7,9 @@ configuration and never exposes this dialog.
|
||||
|
||||
Work directory
|
||||
Where generated files, MSR documents, and result artifacts are written.
|
||||
Defaults to the current directory (``.``).
|
||||
Defaults to the current directory (``.``), which can be the application
|
||||
installation folder. Choose a separate writable work folder before fitting
|
||||
so application upgrades do not affect your results.
|
||||
|
||||
Data directory
|
||||
The root of the instrument data tree (for example
|
||||
@@ -44,6 +46,12 @@ musrfit binaries
|
||||
sessions, while the web edition takes its tools from the server and never
|
||||
exposes this field.
|
||||
|
||||
Runtime installation and checks (Linux)
|
||||
**Check tools** checks the saved tool selection. **Install runtime...**
|
||||
installs a local runtime bundle after confirmation and selects its tools.
|
||||
See :doc:`install-linux` for the required files and installation steps.
|
||||
Windows uses its bundled WSL runtime instead; see :doc:`install-windows`.
|
||||
|
||||
musrfit threads
|
||||
The number of OpenMP threads passed to a local ``musrfit`` run (``-u``).
|
||||
Leave it blank to let musrfit use every available core. Set a lower
|
||||
|
||||
@@ -1,6 +1,10 @@
|
||||
Troubleshooting
|
||||
===============
|
||||
|
||||
For Windows setup, WSL startup errors, missing ROOT libraries, and older
|
||||
runtime updates, see :doc:`install-windows`. For Linux package/runtime setup,
|
||||
see :doc:`install-linux`. The sections below cover analysis workflows.
|
||||
|
||||
Fit or plot will not start
|
||||
--------------------------
|
||||
|
||||
|
||||
+22
-17
@@ -2,10 +2,15 @@
|
||||
|
||||
muSRFlow can use a self-contained, relocatable ROOT + musrfit runtime so users
|
||||
do not need a system-wide musrfit installation. The tree is built once in a
|
||||
low-glibc container. On Windows it is placed at `<app resources>/runtime` and
|
||||
discovered automatically; on Linux it is distributed as a separate runtime rpm
|
||||
or portable AppImage that installs into `/opt/musrflow/runtime` (see
|
||||
`muSRFitelec.js::bundledRuntimeRoot` and `::systemRuntimeRoot`).
|
||||
low-glibc container. On Linux it is distributed separately as an offline
|
||||
bundle, RPM, or runtime AppImage. On Windows the full tree runs inside the
|
||||
bundled WSL2 distribution; only tool markers and startup XML are placed in
|
||||
`<app resources>/runtime`.
|
||||
|
||||
**Installing rather than building?** Follow the
|
||||
[Linux installation guide](../../docs/source/install-linux.rst) or
|
||||
[Windows installation guide](../../docs/source/install-windows.rst).
|
||||
The following sections describe runtime production and implementation.
|
||||
|
||||
## Layout
|
||||
|
||||
@@ -29,7 +34,8 @@ the command-line tools.
|
||||
|
||||
## Environment contract
|
||||
|
||||
`muSRFitelec.js::buildToolEnvironment` exports, for every spawned musrfit tool:
|
||||
For a selected native Linux runtime,
|
||||
`muSRFitelec.js::buildToolEnvironment` supplies:
|
||||
|
||||
| Variable | Value |
|
||||
|-------------------|---------------------------------------------------|
|
||||
@@ -38,6 +44,10 @@ the command-line tools.
|
||||
| `LD_LIBRARY_PATH` | `<runtime>/lib` prepended to the host value |
|
||||
| `PATH` | `<runtime>/bin` prepended (after a user-configured tools dir) |
|
||||
|
||||
Windows bundled tools receive the corresponding Linux environment **inside
|
||||
WSL** through `prepareLocalLaunch`, not through the Windows host environment.
|
||||
See the [WSL runtime guide](../wsl2/README.md#how-it-works).
|
||||
|
||||
Resolution order for a tool (`resolveLocalCommand`):
|
||||
|
||||
1. user-configured tools directory (Preferences → musrfit binaries)
|
||||
@@ -71,7 +81,7 @@ lean and can share one runtime (or use a system musrfit):
|
||||
|
||||
```sh
|
||||
packaging/runtime/build-runtime-rpm.sh # dist/musrflow-runtime-<version>-x86_64.rpm
|
||||
packaging/runtime/build-runtime-appimage.sh # dist/muSRFlow-runtime-<version>-x86_64.AppImage
|
||||
packaging/runtime/build-runtime-appimage.sh # dist/musrflow-runtime-<version>-x86_64.AppImage
|
||||
```
|
||||
|
||||
Both install the tree into `/opt/musrflow/runtime`, which the app discovers
|
||||
@@ -79,9 +89,9 @@ automatically (`MUSRFLOW_RUNTIME_ROOT` overrides the location). The rpm is built
|
||||
with `fpm`, and the AppImage launcher supports:
|
||||
|
||||
```sh
|
||||
./muSRFlow-runtime-<version>-x86_64.AppImage --install [DIR]
|
||||
./muSRFlow-runtime-<version>-x86_64.AppImage --prefix
|
||||
./muSRFlow-runtime-<version>-x86_64.AppImage musrfit --version
|
||||
./musrflow-runtime-<version>-x86_64.AppImage --install [DIR]
|
||||
./musrflow-runtime-<version>-x86_64.AppImage --prefix
|
||||
./musrflow-runtime-<version>-x86_64.AppImage musrfit --version
|
||||
```
|
||||
|
||||
`npm run dist:runtime` builds the RPM, AppImage, and download archive. `dist:linux`,
|
||||
@@ -159,14 +169,9 @@ Windows continues using its WSL2 rootfs; native macOS delivery is a separate ste
|
||||
|
||||
### Offline desktop installation
|
||||
|
||||
On Linux, open **File -> Preferences**. **Check tools** tests the currently saved
|
||||
tool selection using bounded `--version` calls. It does not require a manifest
|
||||
for an ordinary host installation, and does not change that installation.
|
||||
|
||||
**Install runtime...** opens a native file chooser for `runtime-download.json`.
|
||||
Keep its matching archive alongside it. A confirmation shows the versions,
|
||||
archive size, source, and private installation directory. Install only bundles
|
||||
from a trusted source, since they contain executable programs.
|
||||
User steps are in the
|
||||
[Linux installation guide](../../docs/source/install-linux.rst#install-the-separate-runtime-from-a-local-bundle).
|
||||
The following describes validation and persistence for maintainers.
|
||||
|
||||
After **Install and use**, the main process verifies the entire archive hash,
|
||||
checks its entries and disk-space requirements, extracts into private staging,
|
||||
|
||||
+11
-18
@@ -4,7 +4,7 @@ The Windows package runs the **same Linux ROOT + musrfit runtime tree** used
|
||||
by the Linux runtime packages inside a bundled WSL2 distribution.
|
||||
|
||||
For installation on a Windows PC, follow the
|
||||
[step-by-step Windows installation guide](../../docs/DESKTOP_DEPLOYMENT.md#installing-on-windows).
|
||||
[step-by-step Windows installation guide](../../docs/source/install-windows.rst).
|
||||
It covers WSL/WSLg, the `.exe` installer, automatic runtime preparation, folder
|
||||
preferences, and a first Plot/Fit check. The remaining sections describe
|
||||
building and debugging the runtime.
|
||||
@@ -81,21 +81,13 @@ It requires Windows 11 or Windows 10 build 19044 or newer; see
|
||||
|
||||
## Updating an existing imported runtime
|
||||
|
||||
Installing a newer application does not replace an already registered
|
||||
`muSRFlow-runtime` distribution. Older runtime archives omitted Boost headers,
|
||||
which ROOT needs when loading musrview plotting classes. After installing the
|
||||
application with the WSL library-path fix, update an existing runtime from
|
||||
PowerShell with:
|
||||
Application upgrades preserve the registered distribution. Follow
|
||||
[Existing installations](../../docs/source/install-windows.rst#existing-installations)
|
||||
for the in-place Boost-header repair needed by older bundles. Keep user-facing
|
||||
update and troubleshooting instructions in that guide.
|
||||
|
||||
```powershell
|
||||
wsl -d muSRFlow-runtime -- dnf -y install boost-devel
|
||||
```
|
||||
|
||||
This requires access to the distribution's package repositories. It adds the
|
||||
missing headers without removing the WSL distribution or your work files.
|
||||
Fresh runtimes built with the updated script already include them. The build
|
||||
also checks that ROOT can parse `PMusrCanvas.h`, because `--version` alone
|
||||
does not exercise the plotting dependencies.
|
||||
The rootfs build checks that ROOT can parse `PMusrCanvas.h`, because
|
||||
`--version` alone does not exercise the plotting dependencies.
|
||||
|
||||
## Packaging
|
||||
|
||||
@@ -118,11 +110,12 @@ currently supports Linux only.
|
||||
|
||||
- The rootfs is built from `manylinux_2_28` (AlmaLinux 8). Adjust `BASE_IMAGE`
|
||||
if the runtime is rebuilt against a different baseline.
|
||||
- `wsl --import` of the ~750 MB archive can take a few minutes; status is
|
||||
- `wsl --import` of the runtime archive can take a few minutes; status is
|
||||
reported but the import cannot yet be cancelled.
|
||||
- WSL must be installed before launching muSRFlow. On a PC without WSL, use
|
||||
administrator PowerShell to run `wsl --install --no-distribution`, then
|
||||
restart Windows. muSRFlow imports its own distribution afterwards.
|
||||
- Setup tests simulate WSL commands; installation and graphical plotting
|
||||
still need validation on a Windows PC.
|
||||
- Setup tests simulate WSL commands. The corrected runtime has also completed
|
||||
a real fit and PNG plot in its Linux container environment; installation and
|
||||
interactive WSLg plotting still need validation on a Windows PC.
|
||||
- Only Linux and Windows bundles exist; the macOS runtime is not built yet.
|
||||
Reference in new issue
Block a user