Files

88 lines
4.6 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 (``.``), 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
``/psi.ch/group/lmu/public/data``). Run paths are resolved under it.
When Fit or Plot needs runs that are missing locally, the desktop can
download them from ``musruser.psi.ch`` after confirmation. Downloads go
into this directory when the instrument/year folder is writable. Otherwise
they go into ``run-data`` under your personal muSRFlow application data
directory. The hint under the Data directory shows that fallback path,
and the confirmation lists the actual destination and total size.
Both locations remain available to subsequent fits, including offline.
Cancelling a transfer discards its incomplete file. Your selected Data
directory and startup XML are preserved; muSRFlow supplies the additional
search paths through ``MUSRFULLDATAPATH`` when launching its tools.
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``, ``musrt0``, and ``dump_header``). On Linux, the application
packages do not include these binaries (the runtime is distributed
separately); leave empty for **auto-detect** and muSRFlow searches, in
order, the runtime shipped with the packaged app, then a separately
installed one (``/opt/musrflow/runtime``), then 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.
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
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.
**Estimate t0 from the prompt peak (except LEM/HAL)** (on by default): before a
local fit, muSRFlow runs ``musrt0 --getT0FromPromptPeak`` to write explicit
``t0`` lines into the generated MSR. This forces musrfit to use the
histogram peak as the time-zero for instruments whose data-file header t0 is
unreliable; the step is never applied to LEM or HAL/HIFI data, regardless
of this preference. RUN and ADDRUN entries are also checked so an expert
MSR cannot bypass the exclusion through a different GUI selection.
Uncheck it to preserve the MSR as generated for other instruments too.
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.