Files
muSRFlow/docs/source/preferences.rst
salman 184c5b9eb1 Add musrflow:// configuration links and musrfit thread preference
Register the musrflow:// URL scheme at startup (electron-builder writes the
matching MimeType=x-scheme-handler desktop entry for the packaged Linux
builds), accept musrflow://open/#c= links on the launch path and macOS
open-url alongside the existing http(s)/bare-fragment forms, and add a web
Share button that emits the identical encoded fragment under musrflow://open/
so a browser can hand a configuration to the installed desktop app.

Add a musrfit threads field to the Electron Preferences dialog. A set count
is passed to local fits as `musrfit -u <n>`; blank keeps the previous
all-cores behaviour and the web edition ignores it.

Document both features (preferences, runs/fitting, configuration sharing,
desktop deployment, CHANGELOG) and rebuild the Sphinx HTML and PDF.
2026-10-10 10:40:41 +02:00

54 lines
2.5 KiB
ReStructuredText

Preferences
===========
The **Preferences** dialog is a desktop (Electron) feature: it opens from the
**File** menu. The web edition derives the same settings from server
configuration and never exposes this dialog.
Work directory
Where generated files, MSR documents, and result artifacts are written.
Defaults to the current directory (``.``).
Data directory
The root of the instrument data tree (for example
``/psi.ch/group/lmu/public/data``). Run paths are resolved under it.
musrfit startup XML
The ``musrfit_startup.xml`` used to resolve portable run names. Leave it
as **auto-detect** and muSRFlow looks for the standard installation file;
choose a specific file when you run a specialised setup. A hint under the
field shows the naming mode the detected XML enables.
musrfit binaries
The directory that holds the musrfit tools (``musrfit``, ``musrview``,
``msr2data``, and ``dump_header``). Leave it empty for **auto-detect**
and muSRFlow searches the usual installation locations; choose a
directory when the tools live somewhere non-standard (for example a
developer build tree). The configured directory wins over every
auto-detected location for the tool commands muSRFlow runs, and is put
first on the ``PATH`` 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.
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
number to keep a fit from saturating a shared workstation or login node.
The value is validated by musrfit (``1 ... number of cores``) and has no
effect on the web edition, which runs fits on the server.
Initial parameters
**Guess initial parameters from first-run header** (on by default): when
a run set is added, muSRFlow reads the first run's metadata to seed
sensible starting values (for example an approximate frequency or
asymmetry) instead of generic defaults.
Output file suffixes
The suffixes appended to generated artifacts: **Asymmetry** (default
``_asy``) and **Single histogram** (default ``_singleHist``). Change
them to avoid clashing with existing files or to match a naming
convention.
Save stores the values for the next session; **Cancel** closes the dialog
without changing anything. Directory changes take effect from the next
action that resolves or writes files.