diff --git a/.gitignore b/.gitignore index dca64ee..7a04e3f 100644 --- a/.gitignore +++ b/.gitignore @@ -51,6 +51,10 @@ Thumbs.db # Electron/Node.JS package-lock.json +# Bundled relocatable ROOT + musrfit runtime (built by packaging/runtime) +runtime/* +!runtime/.gitkeep + # Generated local fit artifacts /*_asy.msr /*_asy.out @@ -70,6 +74,7 @@ package-lock.json # Sphinx build caches (the built HTML/PDF themselves are committed) docs/_build/doctrees/ +docs/_build/**/.doctrees/ docs/_build/html/.buildinfo # Editors diff --git a/CHANGELOG.md b/CHANGELOG.md index b0b35bf..cf0e626 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -71,6 +71,20 @@ release path documented in [`TODO.md`](TODO.md). `musrfit` to write explicit `t0` lines from the histogram peak into the generated MSR; the step is skipped automatically for LEM data. +### Bundled ROOT + musrfit runtime +- muSRFlow can now run against a relocatable ROOT + musrfit runtime shipped + inside the packaged app (`/runtime`) instead of a system-wide + installation. Local fits prefer the bundled tools over `/usr/local/bin` + (still yielding to a user-configured **musrfit binaries** directory) and + spawn them with `ROOTSYS`, `MUSRFITPATH`, `LD_LIBRARY_PATH`, and `PATH` + pointing at the bundle, so no separate musrfit install is required. When the + bundle is absent the previous host-installation behaviour is unchanged. +- The runtime is produced by `packaging/runtime/build.sh`, which builds ROOT + and musrfit in a low-glibc manylinux container, rewrites runpaths to + `$ORIGIN`-relative paths, and bundles the non-system shared-library closure. + The tree is git-ignored and shipped through the `extraResources` entry in + `package.json`. + ## 1.0.0-rc.4 (2026-09-23) ### Parameter ordering diff --git a/docs/_build/html/_sources/platforms.rst.txt b/docs/_build/html/_sources/platforms.rst.txt index a4b3c12..743a9ae 100644 --- a/docs/_build/html/_sources/platforms.rst.txt +++ b/docs/_build/html/_sources/platforms.rst.txt @@ -35,6 +35,18 @@ the command-line tools live. - Share webpage links; **Restore configuration link** to paste one. - Share button copies a link; opening it restores the settings. +Bundled ROOT and musrfit +------------------------ + +Packaged desktop builds can carry a self-contained ROOT + musrfit runtime +inside the application, so a separate musrfit installation is not required on +the machine. When the bundle is present muSRFlow runs those tools with +``ROOTSYS``, ``MUSRFITPATH``, and ``LD_LIBRARY_PATH`` pointed at the bundled +tree; a directory set in **Preferences / musrfit binaries** still takes +precedence, and on builds without the bundle the system installation is used +exactly as before. The runtime is built with ``packaging/runtime/build.sh`` +(see ``packaging/runtime/README.md``). + 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. \ No newline at end of file diff --git a/docs/_build/html/_sources/preferences.rst.txt b/docs/_build/html/_sources/preferences.rst.txt index 865c621..6249ce7 100644 --- a/docs/_build/html/_sources/preferences.rst.txt +++ b/docs/_build/html/_sources/preferences.rst.txt @@ -22,13 +22,14 @@ musrfit startup XML 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. + and muSRFlow searches, in order, the bundled runtime shipped with the + packaged app, 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. musrfit threads The number of OpenMP threads passed to a local ``musrfit`` run (``-u``). @@ -43,6 +44,13 @@ Initial parameters sensible starting values (for example an approximate frequency or asymmetry) instead of generic defaults. + **Estimate t0 from the prompt peak (non-LEM data)** (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 skipped automatically for LEM data. Uncheck it to + preserve the MSR as generated. + Output file suffixes The suffixes appended to generated artifacts: **Asymmetry** (default ``_asy``) and **Single histogram** (default ``_singleHist``). Change diff --git a/docs/_build/html/index.html b/docs/_build/html/index.html index 640d2c9..6fea8cd 100644 --- a/docs/_build/html/index.html +++ b/docs/_build/html/index.html @@ -163,7 +163,10 @@ application (the ?<
  • Preferences
  • -
  • Web and desktop editions
  • +
  • Web and desktop editions +
  • Keyboard shortcuts
    • Parameter selection (Parameters tab)
    • Parameter-plot window
    • diff --git a/docs/_build/html/platforms.html b/docs/_build/html/platforms.html index 1375d12..54696c6 100644 --- a/docs/_build/html/platforms.html +++ b/docs/_build/html/platforms.html @@ -54,7 +54,10 @@
    • Results and diagnostics
    • Configuration sharing
    • Preferences
    • -
    • Web and desktop editions
    • +
    • Web and desktop editions +
    • Keyboard shortcuts
    • Troubleshooting
    • Glossary
    • @@ -133,9 +136,20 @@ JSROOT in the page.

      +
      +

      Bundled ROOT and musrfit

      +

      Packaged desktop builds can carry a self-contained ROOT + musrfit runtime +inside the application, so a separate musrfit installation is not required on +the machine. When the bundle is present muSRFlow runs those tools with +ROOTSYS, MUSRFITPATH, and LD_LIBRARY_PATH pointed at the bundled +tree; a directory set in Preferences / musrfit binaries still takes +precedence, and on builds without the bundle the system installation is used +exactly as before. The runtime is built with packaging/runtime/build.sh +(see packaging/runtime/README.md).

      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.

      +
      diff --git a/docs/_build/html/preferences.html b/docs/_build/html/preferences.html index 218ee43..4509a97 100644 --- a/docs/_build/html/preferences.html +++ b/docs/_build/html/preferences.html @@ -89,7 +89,7 @@

      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 (.).

      @@ -103,13 +103,14 @@ 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.

      +and muSRFlow searches, in order, the bundled runtime shipped with the +packaged app, 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.

      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 @@ -121,6 +122,12 @@ effect on the web edition, which runs fits on the server.

      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 (non-LEM data) (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 skipped automatically for LEM data. Uncheck it to +preserve the MSR as generated.

      Output file suffixes

      The suffixes appended to generated artifacts: Asymmetry (default _asy) and Single histogram (default _singleHist). Change diff --git a/docs/_build/html/searchindex.js b/docs/_build/html/searchindex.js index 0baa236..06b1421 100644 --- a/docs/_build/html/searchindex.js +++ b/docs/_build/html/searchindex.js @@ -1 +1 @@ -Search.setIndex({"alltitles":{"A first fit":[[7,"a-first-fit"]],"Command log":[[11,"command-log"]],"Configuration sharing":[[0,null]],"Constraints":[[1,null],[1,"id1"]],"Contents":[[4,null]],"Custom parameters":[[1,"custom-parameters"]],"Desktop installation":[[2,"desktop-installation"]],"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"]],"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":{},"objects":{},"objnames":{},"objtypes":{},"terms":{"":[0,3,5,6,8,10,12,13,14],"0":12,"01":12,"012":11,"1":[8,10,11,12,13],"100":[8,12],"101":13,"103":13,"12":[8,12],"16":12,"1998":12,"2":[8,12,13],"21":12,"24":12,"25":12,"3":[8,12,13],"300":8,"4":[12,13],"5":12,"514":[3,12],"515":[3,12],"516":12,"520":12,"525":12,"540":12,"7":12,"8":12,"A":[0,1,3,4,8,10,11,12,13,14],"For":[2,6,8,11,12,13],"If":[0,4,8,11,12,14],"In":[5,7,8,14],"It":[0,1,4,6,7,11],"Its":[5,7],"On":[2,3,4,6,7,9,11,12,14],"One":[3,12],"The":[0,1,3,4,5,6,7,9,10,12,13,14],"Then":8,"There":2,"These":4,"To":[1,12],"With":[5,8],"_asi":10,"_par":[0,8],"_singlehist":10,"abov":[0,8],"abragamco":12,"accept":14,"access":9,"accumul":12,"across":[7,8,10,13],"action":[0,3,4,5,7,8,10,11,14],"activ":[2,5,6,7,8,14],"actor":6,"actual":[0,12,13],"ad":[8,10,12],"add":[1,5,8,11,12,14],"addit":8,"addrun":[3,12],"adjust":[7,8,13],"affect":8,"after":[0,8,12,14],"afterward":[8,11],"again":[7,8,12,14],"against":[8,14],"aggreg":[11,12],"agre":[13,14],"align":8,"all":[2,3,8,11,12,14],"alpha":[8,12],"alreadi":[2,8,12],"also":[0,2,6,8],"alwai":[8,12],"among":8,"amplitud":[8,12],"an":[0,1,2,3,4,6,7,8,10,11,12,13,14],"analysi":[0,3,6,7,11,14],"anchor":5,"ani":[1,6,7,8,9,11,12,13],"anoth":[0,3,7,8,14],"anyon":0,"anyth":[4,10],"apod":[3,12],"app":[0,4],"appear":[2,8,11],"append":[3,10],"appimag":[0,2],"appli":[0,1,3,5,8,9,12],"applic":[0,4],"approxim":10,"ar":[0,1,2,4,7,8,10,12,13,14],"area":[5,11],"argument":11,"arithmet":1,"around":4,"arrang":[0,8],"artifact":[6,9,10,11],"ask":[6,8],"assign":8,"asymmetri":[4,8,10,12],"attempt":[6,14],"authorit":[11,12,14],"auto":[8,10],"automat":[3,5,8,12],"auxiliari":9,"avail":[0,1,4,8,10,12],"avoid":[1,10],"awar":2,"ax":[5,8],"axi":[4,12,14],"b":8,"back":[6,8,12,13],"background":[4,7,8],"backward":[0,12],"bar":[0,2,4,5,7,8,12,14],"base":[0,8],"becom":[1,6,8,12],"been":5,"befor":[1,8,12,14],"behaviour":[4,11,12,13],"behind":[8,9],"below":[11,12],"bench":14,"besid":9,"best":[11,12],"between":[5,8,12],"beyond":8,"bfield":[1,8],"bg":[7,13],"bin":[12,13],"binari":10,"bind":1,"blank":[10,12],"blob":8,"block":[1,3,8,11,12],"bold":8,"both":[1,3,4,7,8,9,13,14],"bottom":11,"box":[5,8],"browser":[0,2,3,4,7,8,9,14],"bug":2,"build":[0,2,4,8,10],"built":[4,6,8],"bulk":8,"button":[0,1,2,3,4,6,7,8,9,11,12],"byte":0,"c":[0,14],"cach":12,"calcul":12,"came":12,"can":[0,1,3,6,7,8,12],"cancel":10,"cannot":[0,4,8,11,12,13],"canon":0,"canva":[3,7,9,11,12],"canvas":3,"cap":[8,12],"carri":[0,3,8,12,14],"caveat":0,"cfg":14,"cgi":[2,4,9,14],"ch":[0,2,10,14],"chain":0,"chang":[1,6,8,10,12,14],"chapter":[2,7,9],"chart":5,"check":[8,14],"checkbox":8,"checkout":2,"chip":[3,8,12,14],"choic":[8,12],"choos":[0,1,2,4,7,10],"chosen":[8,12],"clash":10,"classic":[7,12],"clear":8,"click":[0,5,6,7,8,11,12,14],"client":0,"clipboard":5,"clone":8,"close":[5,6,8,10,11,14],"closest":8,"cmd":[5,8],"code":11,"collaps":[11,13],"colleagu":[0,8],"collect":[7,11],"collid":5,"colon":12,"colour":8,"column":[3,12,14],"combin":12,"come":9,"comma":12,"command":[3,4,7,9,10,12,14],"commit":8,"common":[8,13],"compact":[0,14],"companion":3,"compar":8,"compat":12,"complet":[0,6,11],"compon":[0,1,8,12,14],"compos":12,"compress":[0,3,14],"concentr":4,"concern":9,"concret":8,"configur":[3,4,7,9,10],"confirm":[6,8,12,14],"constant":[1,8],"constrain":1,"constraint":[0,3,4,6,7,8,12],"contact":[2,4,14],"contain":[1,8,11],"content":[8,12],"context":11,"contigu":[8,12],"contrast":12,"control":[1,6,7,8,13,14],"conveni":12,"convent":10,"converg":[11,12],"convert":7,"coordin":8,"copi":[0,6,8,9],"core":[10,12],"correct":[3,12],"correspond":2,"could":[0,14],"count":[8,12],"coupl":4,"covari":12,"cover":[4,14],"cpu":12,"creat":4,"cross":8,"ctrl":[5,8],"current":[0,2,3,6,7,8,10,12,13,14],"cursor":5,"curv":8,"custom":[4,7,8,12],"cycl":12,"dai":7,"damp":8,"dash":12,"dat":[0,3,7,8,11],"data":[0,2,3,4,7,9,10,11,12,13],"dc":12,"dedic":0,"default":[8,10,12,13],"defin":1,"degrad":8,"degre":12,"delet":8,"depend":[5,12],"deploi":14,"deploy":[0,2,4],"deriv":[8,10],"describ":[2,3,4,8,12],"deselect":[5,8],"desk":4,"desktop":[3,4,6,7,8,10,11,12,14],"desktop_deploy":[2,4],"detail":[4,7,12,14],"detect":10,"detector":[8,12,13],"develop":10,"diagnos":11,"diagnost":4,"dialog":[0,2,3,4,7,9,10,14],"did":[11,12],"differ":[0,4,7,9,12,13],"direct":[3,12],"directli":[0,1,6,7,8],"directori":[0,7,9,10,11,14],"disabl":12,"disagre":13,"disappear":[8,12],"disclosur":12,"disk":[0,6,12],"dismiss":8,"displai":[3,6,7,8,9,11,12],"dist":2,"distinct":[8,12,13],"do":[6,12,13,14],"doc":[2,4],"document":[0,2,3,4,5,6,7,10,11,12,13,14],"doe":[0,4,6,7,8,11,12],"dolli":12,"domain":[3,12],"dot":12,"download":[5,8,11],"drag":8,"draw":[0,8],"drawn":[3,7,8,9,12],"drive":8,"driven":5,"dropdown":[1,8,12,14],"dump_head":[3,4,7,10],"dynam":12,"e":[2,8,12],"each":[2,3,8,11,12],"edit":[3,4,5,6,10,12,13,14],"editor":[3,4,7,8,9,12,14],"effect":[10,13],"effici":12,"eight":8,"either":[0,12],"electron":[0,2,4,6,7,9,10],"element":11,"elig":12,"embed":[0,8],"empti":[4,8,10,12],"enabl":[8,10,12],"encod":[0,7],"end":[4,8,12],"endpoint":[9,14],"energi":8,"engin":[3,7,9],"enter":[2,5,6,7,12],"entri":[3,5,8],"equal":1,"equival":8,"eras":11,"error":[0,8,12],"esc":[5,8],"even":8,"event":5,"everi":[3,5,7,8,10,11,12,13,14],"everydai":5,"everyth":[1,12],"evolv":7,"exact":[8,12],"exactli":[1,8],"exampl":[4,8,10,11,12,13],"exce":12,"execut":[4,7],"exist":[0,8,10,12,13],"exit":11,"expand":[2,7,8,12],"expert":[7,13],"explain":11,"explicit":8,"explicitli":9,"exponenti":12,"exponentialbessel":12,"exponentialco":12,"expos":[0,6,7,9,10,12,14],"express":[1,12],"extern":2,"extra":8,"factor":12,"factori":7,"fail":[11,12,14],"fast":3,"fastest":14,"featur":10,"fed":7,"feed":[7,8,11],"fetch":14,"few":5,"fft":[0,3,7,12],"field":[4,5,6,8,10,12,13],"file":[0,2,3,4,7,9,10,12,13],"final":[7,8],"finish":[11,14],"first":[0,2,4,6,8,10,12,14],"fit":[0,1,2,3,4,6,8,9,10,11],"fitparamet":[3,8],"fix":[8,9,12,13,14],"flame":12,"flip":12,"flow":12,"focu":5,"focus":[5,8],"follow":[8,12],"forget":8,"form":[3,12,14],"format":3,"forward":[12,13],"four":8,"fourier":[3,12],"fragment":[0,3],"frame":[3,12],"free":12,"frequenc":[3,4,8,10,12],"fresh":6,"freshli":12,"from":[0,1,2,3,4,5,6,7,8,9,10,11,12,13],"frq":[1,8],"full":[5,7,8,11],"function":[1,3,12],"further":12,"g":[2,8,12],"gain":12,"gamma_mu":[1,8],"gauss":12,"gaussian":12,"gaussianbessel":12,"gaussianco":12,"gbgco":12,"gbgexp":12,"gbgsexp":12,"gbgzf":12,"gdktlf":12,"gener":[1,3,4,6,7,8,10,11,12,13],"get":[0,4,8],"give":11,"given":10,"glfexp":12,"glfsexp":12,"global":[3,8,12],"glossari":4,"good":13,"gp":12,"gpd":12,"gracefulli":8,"graphic":4,"grid":8,"group":[4,8,10,12],"grow":8,"guess":[3,7,8,10,13],"gui":[1,4,7,11,12,14],"guid":[4,7],"gyromagnet":1,"ha":[0,3,5,8,10,12,14],"hal":12,"hand":[0,5,6,8,11,12,14],"handl":[0,4,8,9],"hang":4,"happen":8,"harmlessli":0,"hash":0,"have":[8,12,13],"header":10,"health":14,"help":[4,9,14],"hess":12,"hide":[8,12],"highest":8,"highlight":[7,12],"hint":10,"hist":12,"histogram":[10,12,13],"hold":[5,8,10,12,13,14],"hood":4,"host":[2,13],"hover":11,"how":[0,7,12],"http":[0,2],"i":[1,2,3,4,5,6,7,8,9,10,11,12,13],"icon":[0,6],"ident":[0,8,12],"identifi":[8,12],"idl":11,"ignor":[0,5,12,14],"imaginari":12,"immedi":[0,1,8,11],"import":[8,13],"includ":[0,1,8,12,14],"inconsist":13,"independ":[2,3,8,9,11,12,14],"indic":8,"individu":[8,12],"inform":12,"initi":[3,7,8,10],"inlin":[0,8,12],"input":[3,5],"insid":[3,7,12],"inspect":[4,7,11],"instal":[0,4,10,12,14],"instanc":0,"instead":[0,1,8,10,11,14],"instrument":[0,2,7,10,12],"interact":[5,7,8],"interfac":7,"introduc":8,"invalid":11,"invok":11,"involv":14,"issu":2,"its":[0,2,3,7,8,9,10,11,12,13,14],"itself":8,"j":2,"join":3,"jsroot":[3,7,9,12],"just":[5,6,8],"k":8,"keep":[6,8,10,11,12,13],"kei":[0,5,8],"kept":[11,12],"kev":8,"keyboard":4,"khz":12,"kt":12,"kubo":12,"label":[8,12],"lack":14,"lai":8,"lam_2255":8,"larg":11,"larger":8,"larmor":4,"lasso":5,"last":11,"later":[2,11,13],"layout":8,"ldktlf":12,"le":8,"leak":8,"least":14,"leav":[8,10,12,13],"left":8,"legaci":[12,14],"legend":8,"lem":12,"let":[0,8,10],"level":8,"lgkt":12,"lgktexp":12,"lgktsexp":12,"librari":9,"lifetim":12,"like":[1,13],"likelihood":12,"limit":[3,7,8,12],"line":[3,4,7,8,9,11,14],"linear":8,"lineshap":8,"link":[0,2,3,4,7,8,9,11],"linux":2,"list":[1,6,8,11,12,14],"liter":1,"live":[1,7,9,10,11,12],"llfexp":12,"llfsexp":12,"lmu":10,"load":[4,8,13],"local":[0,2,7,8,9,10,12,14],"locat":10,"lock":[6,14],"log":[4,7,12,14],"logarithm":[8,12],"login":[10,12],"long":0,"longer":8,"look":[4,7,10],"lose":12,"lower":[8,10],"lowest":8,"ltf":12,"machin":[0,2,4,7,11,12],"made":3,"magnet":4,"mai":[0,6,14],"mail":0,"mailto":[2,14],"main":[0,1,2,4,7,8,9,11],"make":12,"manag":7,"manual":[2,3,7,9],"map":8,"mark":[3,12],"marker":8,"match":[0,3,4,8,10,14],"matter":7,"max":12,"mc":12,"md":[2,4,14],"mean":[6,12],"measur":[3,8],"mechan":[3,8],"median":12,"medium":12,"menu":[6,7,9,10],"merg":12,"messag":[11,14],"metadata":[3,7,10],"mhz":12,"microsecond":12,"might":12,"migrad":12,"minim":12,"minimis":12,"mino":12,"minuit2":12,"mirror":4,"miss":4,"mix":13,"mode":[5,8,10,13],"model":[0,1,2,4,6,7,8,9,14],"modeless":[2,9,11],"modern":7,"modifi":13,"monitor":0,"monochrom":8,"more":[7,8,12,14],"most":[5,8],"mous":5,"msr":[1,2,3,4,7,8,9,10,11,12,13,14],"msr2data":[0,3,4,7,8,10],"multi":[3,4,8,12],"multipl":6,"multipli":1,"muon":[1,3,7],"musrfit":[1,2,3,4,7,8,10,11,12],"musrfit_startup":10,"musrflow":[0,2,3,5,6,7,10,11,14],"musrus":[0,2],"musrview":[3,4,7,9,10,12],"must":[2,13,14],"name":[1,3,5,7,8,10,12],"nativ":[3,7,8,9,12],"navig":0,"ndf":[11,12],"need":[2,7,8],"neither":0,"never":[0,5,8,10,14],"new":[8,12,14],"newest":8,"newli":8,"next":[0,1,2,6,8,10,12,13],"node":[2,10,12],"non":10,"none":12,"normal":[0,1,5,8,12,13],"note":[4,8,14],"noth":[0,2,4,12],"notic":11,"npm":2,"number":[2,7,8,10],"numer":[8,12],"object":12,"off":12,"offer":[8,11,12],"offset":12,"old":12,"oldest":8,"omit":8,"onc":[1,2,6,8,12],"one":[1,2,3,5,6,7,9,12,13,14],"ones":[2,12],"onli":[0,1,2,8,11,12,13,14],"onto":8,"opac":8,"open":[0,4,6,7,8,9,10,11,12,14],"openmp":[10,12],"oper":11,"opt":12,"option":[0,2,3,4,7,14],"order":[8,11,12,13],"ordinari":1,"organis":4,"origin":[4,8],"oscil":12,"other":[1,8,11,13],"otherwis":[0,12],"out":[8,11,12],"outcom":[4,14],"outlier":12,"output":[3,10,11,12],"over":[7,10,11,12],"overlai":[0,14],"overlaid":[8,14],"overrid":[8,12],"overview":4,"overwrit":6,"own":[0,3,6,7,8,9,12],"ownership":[4,5],"pack":12,"packag":[2,4,7,11,12],"padlock":6,"page":[0,3,4,7,9,12],"pair":12,"palett":[0,8],"pan":[5,8],"pane":[1,11],"panel":[0,5,14],"par":[3,7,11,12],"par4":12,"par7":12,"paramet":[0,2,3,4,6,7,9,10,11,12],"parr":12,"part":[1,3,8],"parti":0,"pass":[0,10],"past":[0,9],"pastel":8,"path":[0,2,8,9,10,12],"payload":0,"per":[1,8,9,11,13],"perform":14,"perman":11,"phase":[3,8,12],"phi":12,"physic":[7,8,12,13],"pick":8,"picker":8,"place":[8,14],"plain":8,"plot":[0,3,4,6,7,9,11,13],"plotli":[5,8],"plottabl":14,"plu":[3,8,12],"point":[2,14],"pointer":8,"polici":12,"pop":11,"popul":[0,8],"portabl":[3,7,10],"power":12,"precess":8,"predefin":8,"prefer":[0,4,7,9,12,14],"prefix":[4,8],"prepar":[3,4,6,12],"prerequisit":4,"preselect":8,"present":[8,13],"press":[1,2,5,7,8],"preview":[4,6,12],"previou":12,"previous":13,"primari":11,"print":3,"prioriti":8,"problem":4,"process":11,"produc":[0,2,3,7,8,9,11,12],"progress":12,"project":[2,3],"protocol":9,"provid":[5,7,8],"psi":[0,2,10,14],"public":10,"put":10,"q":[5,8],"qualiti":12,"question":2,"quick":[4,7,9],"ran":11,"rang":[0,3,4,5,6,7,8,13],"rank":8,"rate":12,"rather":[8,12],"ratio":[1,8,12],"raw":0,"re":[8,12,14],"reachabl":14,"read":[0,1,3,7,8,10,12,13,14],"readabl":[11,14],"readm":[4,14],"real":[6,8,12,14],"reason":14,"rebuild":[8,12,14],"rebuilt":[0,8],"recent":8,"recipi":0,"recognis":[6,8],"recolour":8,"record":[3,11,12,14],"recreat":0,"redraw":8,"refer":[0,1,3,7,12],"referenc":1,"refin":1,"refit":[3,8,12,14],"reflect":1,"refresh":[8,14],"regener":6,"regist":0,"regular":12,"reimplement":7,"reject":13,"relat":[0,1],"relax":[8,12],"releas":2,"relev":[7,11],"remain":0,"rememb":[0,10],"remov":[1,8,12],"renam":8,"render":[1,7,8],"replac":[6,8,12],"report":[2,4,12],"reposit":8,"repositori":[2,4],"repres":[1,8],"reproduc":[0,11],"request":8,"requir":[2,12],"reread":[8,14],"reset":[5,8,14],"resolut":[12,14],"resolv":[3,7,8,10,12,14],"respect":12,"rest":8,"restor":[0,3,4,7,8,9],"restyl":8,"result":[2,4,6,7,8,10,12,14],"return":[6,12,13],"reus":[3,12,14],"revert":8,"right":[2,7,8],"role":8,"root":[3,7,9,10,11,12,14],"rotat":[3,12],"rout":[8,12],"row":[1,8,12,13,14],"rpm":2,"rrf":[0,3,7,12],"run":[0,1,3,4,6,7,8,9,10,13,14],"runner":2,"runtim":2,"sai":[8,9],"salman":[2,4,14],"same":[0,1,2,3,4,5,7,8,10,11,12,14],"satur":[10,12],"save":[6,7,8,9,10,12],"scale":12,"scan":[0,8],"scana_par":8,"scanb_par":8,"scatter":8,"scheme":0,"scope":8,"scratch":8,"search":10,"second":[0,12],"section":[2,7],"see":[0,3,4,5,7,8,11,12,13,14],"seed":[3,10],"select":[0,2,4,6,7,11],"sender":0,"sensibl":10,"sent":0,"separ":[4,8,12],"sequenc":[8,12],"seri":[3,4,11,14],"serial":8,"serv":2,"server":[0,2,4,6,7,8,9,10,11,12,14],"session":[0,2,7,10],"set":[0,3,4,5,6,7,9,10,13,14],"setup":[0,10,14],"sever":[8,12],"sgkt":12,"shadow":8,"share":[3,4,7,9,10,12,13,14],"shift":[5,8,13],"ship":0,"short":[2,7,11],"shortcut":4,"shorten":11,"should":14,"show":[1,3,6,7,8,10,11,12,13,14],"shown":[6,8,12],"side":[8,9,11,14],"signal":[3,12],"silent":[6,12],"simplex":12,"sinc":13,"singl":[0,3,7,8,10,12,13],"six":12,"size":8,"skip":[3,8,12,14],"slash":12,"slkt":12,"small":8,"smart":8,"so":[0,1,3,5,6,7,8,9,11,12,13],"some":[4,12,13],"someth":8,"somewher":10,"sourc":[0,6,8,14],"space":5,"special":3,"specialis":10,"specif":[8,9,10],"spectra":[3,7,9,11,12],"spectromet":12,"spectroscopi":[3,7],"speed":5,"spin":[3,12],"split":1,"spread":12,"squar":8,"stack":8,"stage":8,"stai":[8,11,12,13],"stand":12,"standard":[5,10,13],"stanza":0,"start":[0,3,4,7,8,9,10,11,12],"startup":[10,14],"state":[0,5,8,11,12],"static":12,"statist":[3,11],"statu":[4,12,14],"step":[3,7,8,9,12,14],"still":[0,8,12],"store":[10,13],"strategi":12,"stretch":12,"stretchco":12,"strictli":12,"stripe":[8,14],"strkt":12,"strktexp":12,"strktsexp":12,"strong":12,"style":0,"subtract":3,"success":[11,12],"suffix":[8,10],"sum":12,"summari":12,"summaris":12,"support":4,"surrend":6,"surviv":8,"swatch":8,"switch":12,"symbol":8,"sync":8,"synchronis":[7,11],"syntax":[1,12],"system":0,"t":8,"t0":[4,7],"tab":[0,1,2,4,6,7,8,9,11,12,13],"tabl":[0,2,3,4,7,11,12,14],"tag":8,"take":[8,10,12,13],"target":0,"task":5,"temperatur":8,"templat":[6,11],"ters":11,"tesla":12,"text":[1,3,5,6,8,9,11,12,14],"tf":8,"than":[8,12],"thei":[1,2,4,5,7,8,11,12,13],"theirs":8,"them":[1,8,10,13,14],"theori":[1,3,12],"therefor":[0,8],"thi":[0,1,2,3,4,6,7,8,9,10,11,12,13,14],"third":0,"those":[8,14],"thread":[10,12],"three":[1,8,12],"through":[3,6,8,9,12],"tick":8,"time":[0,1,7,8,12,13],"titl":8,"togeth":12,"toggl":[5,8],"token":13,"tool":[2,3,4,5,7,9,10,14],"toolbar":[6,7,8,12],"top":[0,8],"total":8,"toward":8,"toyab":12,"trace":0,"track":2,"transform":[3,12],"transient":11,"treat":3,"tree":[2,7,9,10,12,14],"troubleshoot":4,"truth":6,"twice":[8,12],"two":[3,4,6,8,12,13,14],"type":[1,3,5,8,12],"typic":[1,7],"u":[5,8,10,12],"unaffect":12,"uncertainti":[3,8],"unchang":[4,13],"uncheck":[8,14],"under":[1,4,8,9,10,11,14],"underneath":8,"unexpect":11,"unifi":8,"uniform":12,"unit":[3,12],"unless":8,"unlock":[6,14],"unmatch":8,"unspecifi":12,"until":[6,14],"untouch":[0,12],"up":[5,8,11,12],"updat":[1,8],"upload":8,"upper":8,"url":[0,2,3],"us":[0,1,3,4,6,7,8,10,11,12,13,14],"usabl":11,"user":[8,9],"usual":[5,10],"valid":[10,12,14],"valu":[0,1,3,7,8,10,11,12,13,14],"vari":[7,8],"variabl":[0,8],"variant":12,"varieti":12,"verifi":[1,7,14],"version":14,"vertic":8,"via":[9,12],"view":[0,3,4,7],"viewer":[3,7],"visibl":[6,8],"visitor":0,"visual":12,"vm":12,"wa":[0,6,8,11,14],"wai":[8,11,12,13],"warn":[12,14],"weak":12,"web":[3,4,6,7,8,10,11,12],"webpag":9,"well":[0,5],"went":11,"were":11,"what":[1,4,8,9,11,14],"whatev":0,"when":[0,2,8,10,11,12,13],"whenev":8,"where":[9,10,12,14],"whether":[5,8,11],"which":[3,6,8,10,12],"while":[0,5,6,8,10,11,12],"who":0,"whole":[8,11],"whose":[12,13],"win":[8,10],"window":[0,2,3,4,7,9,12],"within":8,"without":[0,1,8,10,11,12,13],"work":[0,2,5,7,8,10,12,14],"workflow":[1,4,7,9],"workstat":10,"worst":[11,12],"would":[6,12,13],"wrap":[2,4],"writabl":14,"write":[2,3,6,7,10,12],"written":[10,13],"wrong":[4,11],"x":[4,5,12,14],"xml":[10,14],"y":[5,8,12],"year":[0,2,7,12],"yet":8,"you":[1,4,6,8,10,12,13,14],"your":[0,2,7,8,11,12],"zaher":[2,4,14],"zoom":[5,8],"\u00b5sr":[7,8],"\u03bb\u2081":8,"\u03c7\u00b2":[11,12]},"titles":["Configuration sharing","Constraints","Getting started","Glossary","muSRFlow User Manual","Keyboard shortcuts","MSR editor","Overview","Parameters and parameter plots","Web and desktop editions","Preferences","Results and diagnostics","Runs and fitting","t0 / background","Troubleshooting"],"titleterms":{"A":7,"On":0,"The":[2,8,11],"action":12,"app":2,"asymmetri":13,"axi":8,"background":13,"bar":11,"cannot":14,"choos":8,"column":8,"command":11,"configur":[0,8,14],"constraint":1,"content":4,"coupl":1,"custom":1,"data":[8,14],"desktop":[0,2,9],"detail":11,"diagnost":11,"dialog":[8,11],"differ":14,"edit":[2,7,8,9],"editor":[5,6],"empti":14,"exampl":1,"execut":11,"field":1,"file":[6,8,11,14],"first":7,"fit":[7,12,13,14],"frequenc":1,"from":14,"gener":5,"get":[2,7],"glossari":3,"group":13,"gui":6,"guid":2,"handl":6,"hang":14,"hood":7,"i":[0,14],"instal":2,"keyboard":[5,8],"larmor":1,"link":14,"load":14,"log":11,"look":14,"machin":14,"magnet":1,"manual":4,"miss":14,"model":12,"msr":[5,6],"multi":13,"multipl":8,"musrflow":4,"note":[0,5],"noth":14,"one":8,"open":2,"option":[8,12],"origin":14,"outcom":11,"overlai":8,"overview":7,"ownership":6,"page":14,"panel":8,"paramet":[1,5,8,14],"per":12,"plot":[5,8,12,14],"prefer":10,"prefix":14,"prepar":14,"prerequisit":2,"preset":8,"preview":1,"problem":14,"quick":2,"rang":12,"rememb":8,"report":14,"restor":14,"result":11,"run":[2,11,12],"select":[5,8,12],"seri":[8,12],"set":[8,12],"share":[0,8],"shortcut":[5,8],"some":14,"start":[2,14],"statist":12,"statu":11,"style":8,"support":2,"t0":13,"tab":5,"tabl":8,"templat":8,"trace":8,"troubleshoot":14,"two":7,"unchang":14,"under":7,"user":4,"view":12,"web":[0,2,9,14],"what":[0,7],"window":[5,8,11],"workflow":6,"wrong":14,"x":8,"you":7}}) \ No newline at end of file +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"]],"Desktop installation":[[2,"desktop-installation"]],"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"]],"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]],"msr":[[3,"term-MSR",true]],"msr2data":[[3,"term-msr2data",true]],"musrfit":[[3,"term-musrfit",true]],"musrview":[[3,"term-musrview",true]],"par.dat":[[3,"term-par.dat",true]],"root plot":[[3,"term-ROOT-plot",true]],"rrf":[[3,"term-RRF",true]],"run":[[3,"term-RUN",true]]},"objects":{},"objnames":{},"objtypes":{},"terms":{"":[0,3,5,6,8,10,12,13,14],"0":12,"01":12,"012":11,"1":[8,10,11,12,13],"100":[8,12],"101":13,"103":13,"12":[8,12],"16":12,"1998":12,"2":[8,12,13],"21":12,"24":12,"25":12,"3":[8,12,13],"300":8,"4":[12,13],"5":12,"514":[3,12],"515":[3,12],"516":12,"520":12,"525":12,"540":12,"7":12,"8":12,"A":[0,1,3,4,8,10,11,12,13,14],"For":[2,6,8,11,12,13],"If":[0,4,8,11,12,14],"In":[5,7,8,14],"It":[0,1,4,6,7,11],"Its":[5,7],"On":[2,3,4,6,7,9,11,12,14],"One":[3,12],"The":[0,1,3,4,5,6,7,9,10,12,13,14],"Then":8,"There":2,"These":4,"To":[1,12],"With":[5,8],"_asi":10,"_par":[0,8],"_singlehist":10,"abov":[0,8],"abragamco":12,"accept":14,"access":9,"accumul":12,"across":[7,8,10,13],"action":[0,3,4,5,7,8,10,11,14],"activ":[2,5,6,7,8,14],"actor":6,"actual":[0,12,13],"ad":[8,10,12],"add":[1,5,8,11,12,14],"addit":8,"addrun":[3,12],"adjust":[7,8,13],"affect":8,"after":[0,8,12,14],"afterward":[8,11],"again":[7,8,12,14],"against":[8,14],"aggreg":[11,12],"agre":[13,14],"align":8,"all":[2,3,8,11,12,14],"alpha":[8,12],"alreadi":[2,8,12],"also":[0,2,6,8],"alwai":[8,12],"among":8,"amplitud":[8,12],"an":[0,1,2,3,4,6,7,8,10,11,12,13,14],"analysi":[0,3,6,7,11,14],"anchor":5,"ani":[1,6,7,8,9,11,12,13],"anoth":[0,3,7,8,14],"anyon":0,"anyth":[4,10],"apod":[3,12],"app":[0,4,10],"appear":[2,8,11],"append":[3,10],"appimag":[0,2],"appli":[0,1,3,5,8,9,12],"applic":[0,4,9],"approxim":10,"ar":[0,1,2,4,7,8,10,12,13,14],"area":[5,11],"argument":11,"arithmet":1,"around":4,"arrang":[0,8],"artifact":[6,9,10,11],"ask":[6,8],"assign":8,"asymmetri":[4,8,10,12],"attempt":[6,14],"authorit":[11,12,14],"auto":[8,10],"automat":[3,5,8,10,12],"auxiliari":9,"avail":[0,1,4,8,10,12],"avoid":[1,10],"awar":2,"ax":[5,8],"axi":[4,12,14],"b":8,"back":[6,8,12,13],"background":[4,7,8],"backward":[0,12],"bar":[0,2,4,5,7,8,12,14],"base":[0,8],"becom":[1,6,8,12],"been":5,"befor":[1,8,9,10,12,14],"behaviour":[4,11,12,13],"behind":[8,9],"below":[11,12],"bench":14,"besid":9,"best":[11,12],"between":[5,8,12],"beyond":8,"bfield":[1,8],"bg":[7,13],"bin":[12,13],"binari":[9,10],"bind":1,"blank":[10,12],"blob":8,"block":[1,3,8,11,12],"bold":8,"both":[1,3,4,7,8,9,13,14],"bottom":11,"box":[5,8],"browser":[0,2,3,4,7,8,9,14],"bug":2,"build":[0,2,4,8,9,10],"built":[4,6,8,9],"bulk":8,"bundl":[4,10],"button":[0,1,2,3,4,6,7,8,9,11,12],"byte":0,"c":[0,14],"cach":12,"calcul":12,"came":12,"can":[0,1,3,6,7,8,9,12],"cancel":10,"cannot":[0,4,8,11,12,13],"canon":0,"canva":[3,7,9,11,12],"canvas":3,"cap":[8,12],"carri":[0,3,8,9,12,14],"caveat":0,"cfg":14,"cgi":[2,4,9,14],"ch":[0,2,10,14],"chain":0,"chang":[1,6,8,10,12,14],"chapter":[2,7,9],"chart":5,"check":[8,14],"checkbox":8,"checkout":2,"chip":[3,8,12,14],"choic":[8,12],"choos":[0,1,2,4,7,10],"chosen":[8,12],"clash":10,"classic":[7,12],"clear":8,"click":[0,5,6,7,8,11,12,14],"client":0,"clipboard":5,"clone":8,"close":[5,6,8,10,11,14],"closest":8,"cmd":[5,8],"code":11,"collaps":[11,13],"colleagu":[0,8],"collect":[7,11],"collid":5,"colon":12,"colour":8,"column":[3,12,14],"combin":12,"come":9,"comma":12,"command":[3,4,7,9,10,12,14],"commit":8,"common":[8,13],"compact":[0,14],"companion":3,"compar":8,"compat":12,"complet":[0,6,11],"compon":[0,1,8,12,14],"compos":12,"compress":[0,3,14],"concentr":4,"concern":9,"concret":8,"configur":[3,4,7,9,10],"confirm":[6,8,12,14],"constant":[1,8],"constrain":1,"constraint":[0,3,4,6,7,8,12],"contact":[2,4,14],"contain":[1,8,9,11],"content":[8,12],"context":11,"contigu":[8,12],"contrast":12,"control":[1,6,7,8,13,14],"conveni":12,"convent":10,"converg":[11,12],"convert":7,"coordin":8,"copi":[0,6,8,9],"core":[10,12],"correct":[3,12],"correspond":2,"could":[0,14],"count":[8,12],"coupl":4,"covari":12,"cover":[4,14],"cpu":12,"creat":4,"cross":8,"ctrl":[5,8],"current":[0,2,3,6,7,8,10,12,13,14],"cursor":5,"curv":8,"custom":[4,7,8,12],"cycl":12,"dai":7,"damp":8,"dash":12,"dat":[0,3,7,8,11],"data":[0,2,3,4,7,9,10,11,12,13],"dc":12,"dedic":0,"default":[8,10,12,13],"defin":1,"degrad":8,"degre":12,"delet":8,"depend":[5,12],"deploi":14,"deploy":[0,2,4],"deriv":[8,10],"describ":[2,3,4,8,12],"deselect":[5,8],"desk":4,"desktop":[3,4,6,7,8,10,11,12,14],"desktop_deploy":[2,4],"detail":[4,7,12,14],"detect":10,"detector":[8,12,13],"develop":10,"diagnos":11,"diagnost":4,"dialog":[0,2,3,4,7,9,10,14],"did":[11,12],"differ":[0,4,7,9,12,13],"direct":[3,12],"directli":[0,1,6,7,8],"directori":[0,7,9,10,11,14],"disabl":12,"disagre":13,"disappear":[8,12],"disclosur":12,"disk":[0,6,12],"dismiss":8,"displai":[3,6,7,8,9,11,12],"dist":2,"distinct":[8,12,13],"do":[6,12,13,14],"doc":[2,4],"document":[0,2,3,4,5,6,7,10,11,12,13,14],"doe":[0,4,6,7,8,11,12],"dolli":12,"domain":[3,12],"dot":12,"download":[5,8,11],"drag":8,"draw":[0,8],"drawn":[3,7,8,9,12],"drive":8,"driven":5,"dropdown":[1,8,12,14],"dump_head":[3,4,7,10],"dynam":12,"e":[2,8,12],"each":[2,3,8,11,12],"edit":[3,4,5,6,10,12,13,14],"editor":[3,4,7,8,9,12,14],"effect":[10,13],"effici":12,"eight":8,"either":[0,12],"electron":[0,2,4,6,7,9,10],"element":11,"elig":12,"embed":[0,8],"empti":[4,8,10,12],"enabl":[8,10,12],"encod":[0,7],"end":[4,8,12],"endpoint":[9,14],"energi":8,"engin":[3,7,9],"enter":[2,5,6,7,12],"entri":[3,5,8],"equal":1,"equival":8,"eras":11,"error":[0,8,12],"esc":[5,8],"estim":10,"even":8,"event":5,"everi":[3,5,7,8,10,11,12,13,14],"everydai":5,"everyth":[1,12],"evolv":7,"exact":[8,12],"exactli":[1,8,9],"exampl":[4,8,10,11,12,13],"exce":12,"execut":[4,7],"exist":[0,8,10,12,13],"exit":11,"expand":[2,7,8,12],"expert":[7,13],"explain":11,"explicit":[8,10],"explicitli":9,"exponenti":12,"exponentialbessel":12,"exponentialco":12,"expos":[0,6,7,9,10,12,14],"express":[1,12],"extern":2,"extra":8,"factor":12,"factori":7,"fail":[11,12,14],"fast":3,"fastest":14,"featur":10,"fed":7,"feed":[7,8,11],"fetch":14,"few":5,"fft":[0,3,7,12],"field":[4,5,6,8,10,12,13],"file":[0,2,3,4,7,9,10,12,13],"final":[7,8],"finish":[11,14],"first":[0,2,4,6,8,10,12,14],"fit":[0,1,2,3,4,6,8,9,10,11],"fitparamet":[3,8],"fix":[8,9,12,13,14],"flame":12,"flip":12,"flow":12,"focu":5,"focus":[5,8],"follow":[8,12],"forc":10,"forget":8,"form":[3,12,14],"format":3,"forward":[12,13],"four":8,"fourier":[3,12],"fragment":[0,3],"frame":[3,12],"free":12,"frequenc":[3,4,8,10,12],"fresh":6,"freshli":12,"from":[0,1,2,3,4,5,6,7,8,9,10,11,12,13],"frq":[1,8],"full":[5,7,8,11],"function":[1,3,12],"further":12,"g":[2,8,12],"gain":12,"gamma_mu":[1,8],"gauss":12,"gaussian":12,"gaussianbessel":12,"gaussianco":12,"gbgco":12,"gbgexp":12,"gbgsexp":12,"gbgzf":12,"gdktlf":12,"gener":[1,3,4,6,7,8,10,11,12,13],"get":[0,4,8],"gett0frompromptpeak":10,"give":11,"given":10,"glfexp":12,"glfsexp":12,"global":[3,8,12],"glossari":4,"good":13,"gp":12,"gpd":12,"gracefulli":8,"graphic":4,"grid":8,"group":[4,8,10,12],"grow":8,"guess":[3,7,8,10,13],"gui":[1,4,7,11,12,14],"guid":[4,7],"gyromagnet":1,"ha":[0,3,5,8,10,12,14],"hal":12,"hand":[0,5,6,8,11,12,14],"handl":[0,4,8,9],"hang":4,"happen":8,"harmlessli":0,"hash":0,"have":[8,12,13],"header":10,"health":14,"help":[4,9,14],"hess":12,"hide":[8,12],"highest":8,"highlight":[7,12],"hint":10,"hist":12,"histogram":[10,12,13],"hold":[5,8,10,12,13,14],"hood":4,"host":[2,13],"hover":11,"how":[0,7,12],"http":[0,2],"i":[1,2,3,4,5,6,7,8,9,10,11,12,13],"icon":[0,6],"ident":[0,8,12],"identifi":[8,12],"idl":11,"ignor":[0,5,12,14],"imaginari":12,"immedi":[0,1,8,11],"import":[8,13],"includ":[0,1,8,12,14],"inconsist":13,"independ":[2,3,8,9,11,12,14],"indic":8,"individu":[8,12],"inform":12,"initi":[3,7,8,10],"inlin":[0,8,12],"input":[3,5],"insid":[3,7,9,12],"inspect":[4,7,11],"instal":[0,4,9,10,12,14],"instanc":0,"instead":[0,1,8,10,11,14],"instrument":[0,2,7,10,12],"interact":[5,7,8],"interfac":7,"introduc":8,"invalid":11,"invok":11,"involv":14,"issu":2,"its":[0,2,3,7,8,9,10,11,12,13,14],"itself":8,"j":2,"join":3,"jsroot":[3,7,9,12],"just":[5,6,8],"k":8,"keep":[6,8,10,11,12,13],"kei":[0,5,8],"kept":[11,12],"kev":8,"keyboard":4,"khz":12,"kt":12,"kubo":12,"label":[8,12],"lack":14,"lai":8,"lam_2255":8,"larg":11,"larger":8,"larmor":4,"lasso":5,"last":11,"later":[2,11,13],"layout":8,"ld_library_path":9,"ldktlf":12,"le":8,"leak":8,"least":14,"leav":[8,10,12,13],"left":8,"legaci":[12,14],"legend":8,"lem":[10,12],"let":[0,8,10],"level":8,"lgkt":12,"lgktexp":12,"lgktsexp":12,"librari":9,"lifetim":12,"like":[1,13],"likelihood":12,"limit":[3,7,8,12],"line":[3,4,7,8,9,10,11,14],"linear":8,"lineshap":8,"link":[0,2,3,4,7,8,9,11],"linux":2,"list":[1,6,8,11,12,14],"liter":1,"live":[1,7,9,10,11,12],"llfexp":12,"llfsexp":12,"lmu":10,"load":[4,8,13],"local":[0,2,7,8,9,10,12,14],"locat":10,"lock":[6,14],"log":[4,7,12,14],"logarithm":[8,12],"login":[10,12],"long":0,"longer":8,"look":[4,7,10],"lose":12,"lower":[8,10],"lowest":8,"ltf":12,"machin":[0,2,4,7,9,11,12],"made":3,"magnet":4,"mai":[0,6,14],"mail":0,"mailto":[2,14],"main":[0,1,2,4,7,8,9,11],"make":12,"manag":7,"manual":[2,3,7,9],"map":8,"mark":[3,12],"marker":8,"match":[0,3,4,8,10,14],"matter":7,"max":12,"mc":12,"md":[2,4,9,14],"mean":[6,12],"measur":[3,8],"mechan":[3,8],"median":12,"medium":12,"menu":[6,7,9,10],"merg":12,"messag":[11,14],"metadata":[3,7,10],"mhz":12,"microsecond":12,"might":12,"migrad":12,"minim":12,"minimis":12,"mino":12,"minuit2":12,"mirror":4,"miss":4,"mix":13,"mode":[5,8,10,13],"model":[0,1,2,4,6,7,8,9,14],"modeless":[2,9,11],"modern":7,"modifi":13,"monitor":0,"monochrom":8,"more":[7,8,12,14],"most":[5,8],"mous":5,"msr":[1,2,3,4,7,8,9,10,11,12,13,14],"msr2data":[0,3,4,7,8,10],"multi":[3,4,8,12],"multipl":6,"multipli":1,"muon":[1,3,7],"musrfit":[1,2,3,4,7,8,10,11,12],"musrfit_startup":10,"musrfitpath":9,"musrflow":[0,2,3,5,6,7,9,10,11,14],"musrt0":10,"musrus":[0,2],"musrview":[3,4,7,9,10,12],"must":[2,13,14],"name":[1,3,5,7,8,10,12],"nativ":[3,7,8,9,12],"navig":0,"ndf":[11,12],"need":[2,7,8],"neither":0,"never":[0,5,8,10,14],"new":[8,12,14],"newest":8,"newli":8,"next":[0,1,2,6,8,10,12,13],"node":[2,10,12],"non":10,"none":12,"normal":[0,1,5,8,12,13],"note":[4,8,14],"noth":[0,2,4,12],"notic":11,"npm":2,"number":[2,7,8,10],"numer":[8,12],"object":12,"off":12,"offer":[8,11,12],"offset":12,"old":12,"oldest":8,"omit":8,"onc":[1,2,6,8,12],"one":[1,2,3,5,6,7,9,12,13,14],"ones":[2,12],"onli":[0,1,2,8,11,12,13,14],"onto":8,"opac":8,"open":[0,4,6,7,8,9,10,11,12,14],"openmp":[10,12],"oper":11,"opt":12,"option":[0,2,3,4,7,14],"order":[8,10,11,12,13],"ordinari":1,"organis":4,"origin":[4,8],"oscil":12,"other":[1,8,11,13],"otherwis":[0,12],"out":[8,11,12],"outcom":[4,14],"outlier":12,"output":[3,10,11,12],"over":[7,10,11,12],"overlai":[0,14],"overlaid":[8,14],"overrid":[8,12],"overview":4,"overwrit":6,"own":[0,3,6,7,8,9,12],"ownership":[4,5],"pack":12,"packag":[2,4,7,9,10,11,12],"padlock":6,"page":[0,3,4,7,9,12],"pair":12,"palett":[0,8],"pan":[5,8],"pane":[1,11],"panel":[0,5,14],"par":[3,7,11,12],"par4":12,"par7":12,"paramet":[0,2,3,4,6,7,9,10,11,12],"parr":12,"part":[1,3,8],"parti":0,"pass":[0,10],"past":[0,9],"pastel":8,"path":[0,2,8,9,10,12],"payload":0,"peak":10,"per":[1,8,9,11,13],"perform":14,"perman":11,"phase":[3,8,12],"phi":12,"physic":[7,8,12,13],"pick":8,"picker":8,"place":[8,14],"plain":8,"plot":[0,3,4,6,7,9,11,13],"plotli":[5,8],"plottabl":14,"plu":[3,8,12],"point":[2,9,14],"pointer":8,"polici":12,"pop":11,"popul":[0,8],"portabl":[3,7,10],"power":12,"preced":9,"precess":8,"predefin":8,"prefer":[0,4,7,9,12,14],"prefix":[4,8],"prepar":[3,4,6,12],"prerequisit":4,"preselect":8,"present":[8,9,13],"preserv":10,"press":[1,2,5,7,8],"preview":[4,6,12],"previou":12,"previous":13,"primari":11,"print":3,"prioriti":8,"problem":4,"process":11,"produc":[0,2,3,7,8,9,11,12],"progress":12,"project":[2,3],"prompt":10,"protocol":9,"provid":[5,7,8],"psi":[0,2,10,14],"public":10,"put":10,"q":[5,8],"qualiti":12,"question":2,"quick":[4,7,9],"ran":11,"rang":[0,3,4,5,6,7,8,13],"rank":8,"rate":12,"rather":[8,12],"ratio":[1,8,12],"raw":0,"re":[8,12,14],"reachabl":14,"read":[0,1,3,7,8,10,12,13,14],"readabl":[11,14],"readm":[4,9,14],"real":[6,8,12,14],"reason":14,"rebuild":[8,12,14],"rebuilt":[0,8],"recent":8,"recipi":0,"recognis":[6,8],"recolour":8,"record":[3,11,12,14],"recreat":0,"redraw":8,"refer":[0,1,3,7,12],"referenc":1,"refin":1,"refit":[3,8,12,14],"reflect":1,"refresh":[8,14],"regener":6,"regist":0,"regular":12,"reimplement":7,"reject":13,"relat":[0,1],"relax":[8,12],"releas":2,"relev":[7,11],"remain":0,"rememb":[0,10],"remov":[1,8,12],"renam":8,"render":[1,7,8],"replac":[6,8,12],"report":[2,4,12],"reposit":8,"repositori":[2,4],"repres":[1,8],"reproduc":[0,11],"request":8,"requir":[2,9,12],"reread":[8,14],"reset":[5,8,14],"resolut":[12,14],"resolv":[3,7,8,10,12,14],"respect":12,"rest":8,"restor":[0,3,4,7,8,9],"restyl":8,"result":[2,4,6,7,8,10,12,14],"return":[6,12,13],"reus":[3,12,14],"revert":8,"right":[2,7,8],"role":8,"root":[3,4,7,10,11,12,14],"rootsi":9,"rotat":[3,12],"rout":[8,12],"row":[1,8,12,13,14],"rpm":2,"rrf":[0,3,7,12],"run":[0,1,3,4,6,7,8,9,10,13,14],"runner":2,"runtim":[2,9,10],"sai":[8,9],"salman":[2,4,14],"same":[0,1,2,3,4,5,7,8,10,11,12,14],"satur":[10,12],"save":[6,7,8,9,10,12],"scale":12,"scan":[0,8],"scana_par":8,"scanb_par":8,"scatter":8,"scheme":0,"scope":8,"scratch":8,"search":10,"second":[0,12],"section":[2,7],"see":[0,3,4,5,7,8,9,11,12,13,14],"seed":[3,10],"select":[0,2,4,6,7,11],"self":9,"sender":0,"sensibl":10,"sent":0,"separ":[4,8,9,12],"sequenc":[8,12],"seri":[3,4,11,14],"serial":8,"serv":2,"server":[0,2,4,6,7,8,9,10,11,12,14],"session":[0,2,7,10],"set":[0,3,4,5,6,7,9,10,13,14],"setup":[0,10,14],"sever":[8,12],"sgkt":12,"sh":9,"shadow":8,"share":[3,4,7,9,10,12,13,14],"shift":[5,8,13],"ship":[0,10],"short":[2,7,11],"shortcut":4,"shorten":11,"should":14,"show":[1,3,6,7,8,10,11,12,13,14],"shown":[6,8,12],"side":[8,9,11,14],"signal":[3,12],"silent":[6,12],"simplex":12,"sinc":13,"singl":[0,3,7,8,10,12,13],"six":12,"size":8,"skip":[3,8,10,12,14],"slash":12,"slkt":12,"small":8,"smart":8,"so":[0,1,3,5,6,7,8,9,11,12,13],"some":[4,12,13],"someth":8,"somewher":10,"sourc":[0,6,8,14],"space":5,"special":3,"specialis":10,"specif":[8,9,10],"spectra":[3,7,9,11,12],"spectromet":12,"spectroscopi":[3,7],"speed":5,"spin":[3,12],"split":1,"spread":12,"squar":8,"stack":8,"stage":8,"stai":[8,11,12,13],"stand":12,"standard":[5,10,13],"stanza":0,"start":[0,3,4,7,8,9,10,11,12],"startup":[10,14],"state":[0,5,8,11,12],"static":12,"statist":[3,11],"statu":[4,12,14],"step":[3,7,8,9,10,12,14],"still":[0,8,9,12],"store":[10,13],"strategi":12,"stretch":12,"stretchco":12,"strictli":12,"stripe":[8,14],"strkt":12,"strktexp":12,"strktsexp":12,"strong":12,"style":0,"subtract":3,"success":[11,12],"suffix":[8,10],"sum":12,"summari":12,"summaris":12,"support":4,"surrend":6,"surviv":8,"swatch":8,"switch":12,"symbol":8,"sync":8,"synchronis":[7,11],"syntax":[1,12],"system":[0,9],"t":8,"t0":[4,7,10],"tab":[0,1,2,4,6,7,8,9,11,12,13],"tabl":[0,2,3,4,7,11,12,14],"tag":8,"take":[8,9,10,12,13],"target":0,"task":5,"temperatur":8,"templat":[6,11],"ters":11,"tesla":12,"text":[1,3,5,6,8,9,11,12,14],"tf":8,"than":[8,12],"thei":[1,2,4,5,7,8,11,12,13],"theirs":8,"them":[1,8,10,13,14],"theori":[1,3,12],"therefor":[0,8],"thi":[0,1,2,3,4,6,7,8,9,10,11,12,13,14],"third":0,"those":[8,9,14],"thread":[10,12],"three":[1,8,12],"through":[3,6,8,9,12],"tick":8,"time":[0,1,7,8,10,12,13],"titl":8,"togeth":12,"toggl":[5,8],"token":13,"tool":[2,3,4,5,7,9,10,14],"toolbar":[6,7,8,12],"top":[0,8],"total":8,"toward":8,"toyab":12,"trace":0,"track":2,"transform":[3,12],"transient":11,"treat":3,"tree":[2,7,9,10,12,14],"troubleshoot":4,"truth":6,"twice":[8,12],"two":[3,4,6,8,12,13,14],"type":[1,3,5,8,12],"typic":[1,7],"u":[5,8,10,12],"unaffect":12,"uncertainti":[3,8],"unchang":[4,13],"uncheck":[8,10,14],"under":[1,4,8,9,10,11,14],"underneath":8,"unexpect":11,"unifi":8,"uniform":12,"unit":[3,12],"unless":8,"unlock":[6,14],"unmatch":8,"unreli":10,"unspecifi":12,"until":[6,14],"untouch":[0,12],"up":[5,8,11,12],"updat":[1,8],"upload":8,"upper":8,"url":[0,2,3],"us":[0,1,3,4,6,7,8,9,10,11,12,13,14],"usabl":11,"user":[8,9],"usual":[5,10],"valid":[10,12,14],"valu":[0,1,3,7,8,10,11,12,13,14],"vari":[7,8],"variabl":[0,8],"variant":12,"varieti":12,"verifi":[1,7,14],"version":14,"vertic":8,"via":[9,12],"view":[0,3,4,7],"viewer":[3,7],"visibl":[6,8],"visitor":0,"visual":12,"vm":12,"wa":[0,6,8,11,14],"wai":[8,11,12,13],"warn":[12,14],"weak":12,"web":[3,4,6,7,8,10,11,12],"webpag":9,"well":[0,5],"went":11,"were":11,"what":[1,4,8,9,11,14],"whatev":0,"when":[0,2,8,9,10,11,12,13],"whenev":8,"where":[9,10,12,14],"whether":[5,8,11],"which":[3,6,8,10,12],"while":[0,5,6,8,10,11,12],"who":0,"whole":[8,11],"whose":[10,12,13],"win":[8,10],"window":[0,2,3,4,7,9,12],"within":8,"without":[0,1,8,9,10,11,12,13],"work":[0,2,5,7,8,10,12,14],"workflow":[1,4,7,9],"workstat":10,"worst":[11,12],"would":[6,12,13],"wrap":[2,4],"writabl":14,"write":[2,3,6,7,10,12],"written":[10,13],"wrong":[4,11],"x":[4,5,12,14],"xml":[10,14],"y":[5,8,12],"year":[0,2,7,12],"yet":8,"you":[1,4,6,8,10,12,13,14],"your":[0,2,7,8,11,12],"zaher":[2,4,14],"zero":10,"zoom":[5,8],"\u00b5sr":[7,8],"\u03bb\u2081":8,"\u03c7\u00b2":[11,12]},"titles":["Configuration sharing","Constraints","Getting started","Glossary","muSRFlow User Manual","Keyboard shortcuts","MSR editor","Overview","Parameters and parameter plots","Web and desktop editions","Preferences","Results and diagnostics","Runs and fitting","t0 / background","Troubleshooting"],"titleterms":{"A":7,"On":0,"The":[2,8,11],"action":12,"app":2,"asymmetri":13,"axi":8,"background":13,"bar":11,"bundl":9,"cannot":14,"choos":8,"column":8,"command":11,"configur":[0,8,14],"constraint":1,"content":4,"coupl":1,"custom":1,"data":[8,14],"desktop":[0,2,9],"detail":11,"diagnost":11,"dialog":[8,11],"differ":14,"edit":[2,7,8,9],"editor":[5,6],"empti":14,"exampl":1,"execut":11,"field":1,"file":[6,8,11,14],"first":7,"fit":[7,12,13,14],"frequenc":1,"from":14,"gener":5,"get":[2,7],"glossari":3,"group":13,"gui":6,"guid":2,"handl":6,"hang":14,"hood":7,"i":[0,14],"instal":2,"keyboard":[5,8],"larmor":1,"link":14,"load":14,"log":11,"look":14,"machin":14,"magnet":1,"manual":4,"miss":14,"model":12,"msr":[5,6],"multi":13,"multipl":8,"musrfit":9,"musrflow":4,"note":[0,5],"noth":14,"one":8,"open":2,"option":[8,12],"origin":14,"outcom":11,"overlai":8,"overview":7,"ownership":6,"page":14,"panel":8,"paramet":[1,5,8,14],"per":12,"plot":[5,8,12,14],"prefer":10,"prefix":14,"prepar":14,"prerequisit":2,"preset":8,"preview":1,"problem":14,"quick":2,"rang":12,"rememb":8,"report":14,"restor":14,"result":11,"root":9,"run":[2,11,12],"select":[5,8,12],"seri":[8,12],"set":[8,12],"share":[0,8],"shortcut":[5,8],"some":14,"start":[2,14],"statist":12,"statu":11,"style":8,"support":2,"t0":13,"tab":5,"tabl":8,"templat":8,"trace":8,"troubleshoot":14,"two":7,"unchang":14,"under":7,"user":4,"view":12,"web":[0,2,9,14],"what":[0,7],"window":[5,8,11],"workflow":6,"wrong":14,"x":8,"you":7}}) \ No newline at end of file diff --git a/docs/_build/latex/muSRFlow.aux b/docs/_build/latex/muSRFlow.aux index 5ea51a1..41e11f6 100644 --- a/docs/_build/latex/muSRFlow.aux +++ b/docs/_build/latex/muSRFlow.aux @@ -157,6 +157,8 @@ \@writefile{lot}{\addvspace {10\p@ }} \newlabel{platforms:web-and-desktop-editions}{{11}{31}{Web and desktop editions}{chapter.11}{}} \newlabel{platforms::doc}{{11}{31}{Web and desktop editions}{chapter.11}{}} +\@writefile{toc}{\contentsline {section}{\numberline {11.1}Bundled ROOT and musrfit}{31}{section.11.1}\protected@file@percent } +\newlabel{platforms:bundled-root-and-musrfit}{{11.1}{31}{Bundled ROOT and musrfit}{section.11.1}{}} \@writefile{toc}{\contentsline {chapter}{\numberline {12}Keyboard shortcuts}{33}{chapter.12}\protected@file@percent } \@writefile{lof}{\addvspace {10\p@ }} \@writefile{lot}{\addvspace {10\p@ }} diff --git a/docs/_build/latex/muSRFlow.fdb_latexmk b/docs/_build/latex/muSRFlow.fdb_latexmk index 74029a7..09e156f 100644 --- a/docs/_build/latex/muSRFlow.fdb_latexmk +++ b/docs/_build/latex/muSRFlow.fdb_latexmk @@ -1,11 +1,11 @@ # Fdb version 4 -["makeindex muSRFlow.idx"] 1791621490.17959 "muSRFlow.idx" "muSRFlow.ind" "muSRFlow" 1791621492.68928 0 - "muSRFlow.idx" 1791621492.57293 1189 cca9fe93ffba026d593c5ed228d742a4 "pdflatex" +["makeindex muSRFlow.idx"] 1791621490.17959 "muSRFlow.idx" "muSRFlow.ind" "muSRFlow" 1791730106.16275 0 + "muSRFlow.idx" 1791730106.04479 1189 cca9fe93ffba026d593c5ed228d742a4 "pdflatex" (generated) "muSRFlow.ilg" "muSRFlow.ind" (rewritten before read) -["pdflatex"] 1791621490.25453 "muSRFlow.tex" "muSRFlow.pdf" "muSRFlow" 1791621492.6894 0 +["pdflatex"] 1791730103.78886 "muSRFlow.tex" "muSRFlow.pdf" "muSRFlow" 1791730106.16288 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" 1791621492.57093 24094 b9641ed569624ace42786c1a19c9abb9 "pdflatex" + "muSRFlow.aux" 1791730106.04279 24322 9176e2a8d1447fe1bc48c56f4059a194 "pdflatex" "muSRFlow.ind" 1791621490.25033 1435 1ea9e98c4c43945295d6873d01cf2032 "makeindex muSRFlow.idx" - "muSRFlow.out" 1791621492.57293 11693 68c631c84176186f2178a7a81175bf94 "pdflatex" - "muSRFlow.tex" 1791621487.58409 81175 1a7462f4e771ce8d5723409ab1ef1caa "" - "muSRFlow.toc" 1791621492.57293 6146 1a3955ffa5b979e4c4a53a6e506c02eb "pdflatex" + "muSRFlow.out" 1791730106.04479 11879 c29038db42596b165f0732dea8edf516 "pdflatex" + "muSRFlow.tex" 1791730092.72346 82633 31a973eb060f51d752bbd1915b2056e9 "" + "muSRFlow.toc" 1791730106.04479 6233 a8f6b0c136864b1af14f888e6e6bff3e "pdflatex" "sphinx.sty" 1789374174.58095 54203 ee7fe875437470f5328ee20661bb9f1d "" - "sphinxhighlight.sty" 1791621487.45696 7553 83fb52292c17957d9f4aadcb28c57a87 "" + "sphinxhighlight.sty" 1791730092.60905 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" 1791621487.5879 745 3f5fcd6cdd7964ed608767954a8ced6f "" + "sphinxmessages.sty" 1791730092.72877 745 3f5fcd6cdd7964ed608767954a8ced6f "" "sphinxoptionsgeometry.sty" 1789374174.58695 2060 6c27b3eba37bde592ae8908ab2c1ac0f "" "sphinxoptionshyperref.sty" 1789374174.58695 1093 e468489bae7631a7f387b4b0f7bc15d4 "" "sphinxpackageboxes.sty" 1789374174.58695 36106 1be2053eb1cb9b083b3a75e3657bcb24 "" diff --git a/docs/_build/latex/muSRFlow.out b/docs/_build/latex/muSRFlow.out index 25c00fd..7278072 100644 --- a/docs/_build/latex/muSRFlow.out +++ b/docs/_build/latex/muSRFlow.out @@ -56,20 +56,21 @@ \BOOKMARK [1][-]{section.9.4}{\376\377\000N\000o\000t\000e\000s}{chapter.9}% 56 \BOOKMARK [0][-]{chapter.10}{\376\377\000P\000r\000e\000f\000e\000r\000e\000n\000c\000e\000s}{}% 57 \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}{}% 58 -\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}{}% 59 -\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}% 60 -\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}% 61 -\BOOKMARK [1][-]{section.12.3}{\376\377\000M\000S\000R\000\040\000e\000d\000i\000t\000o\000r}{chapter.12}% 62 -\BOOKMARK [1][-]{section.12.4}{\376\377\000G\000e\000n\000e\000r\000a\000l\000\040\000n\000o\000t\000e\000s}{chapter.12}% 63 -\BOOKMARK [0][-]{chapter.13}{\376\377\000T\000r\000o\000u\000b\000l\000e\000s\000h\000o\000o\000t\000i\000n\000g}{}% 64 -\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}% 65 -\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}% 66 -\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}% 67 -\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}% 68 -\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}% 69 -\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}% 70 -\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}% 71 -\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}% 72 -\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}% 73 -\BOOKMARK [0][-]{chapter.14}{\376\377\000G\000l\000o\000s\000s\000a\000r\000y}{}% 74 -\BOOKMARK [0][-]{section*.18}{\376\377\000I\000n\000d\000e\000x}{}% 75 +\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}% 59 +\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}{}% 60 +\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}% 61 +\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}% 62 +\BOOKMARK [1][-]{section.12.3}{\376\377\000M\000S\000R\000\040\000e\000d\000i\000t\000o\000r}{chapter.12}% 63 +\BOOKMARK [1][-]{section.12.4}{\376\377\000G\000e\000n\000e\000r\000a\000l\000\040\000n\000o\000t\000e\000s}{chapter.12}% 64 +\BOOKMARK [0][-]{chapter.13}{\376\377\000T\000r\000o\000u\000b\000l\000e\000s\000h\000o\000o\000t\000i\000n\000g}{}% 65 +\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}% 66 +\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}% 67 +\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}% 68 +\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}% 69 +\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}% 70 +\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}% 71 +\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}% 72 +\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}% 73 +\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}% 74 +\BOOKMARK [0][-]{chapter.14}{\376\377\000G\000l\000o\000s\000s\000a\000r\000y}{}% 75 +\BOOKMARK [0][-]{section*.18}{\376\377\000I\000n\000d\000e\000x}{}% 76 diff --git a/docs/_build/latex/muSRFlow.pdf b/docs/_build/latex/muSRFlow.pdf index 62a4c04..0b7a6de 100644 Binary files a/docs/_build/latex/muSRFlow.pdf and b/docs/_build/latex/muSRFlow.pdf differ diff --git a/docs/_build/latex/muSRFlow.tex b/docs/_build/latex/muSRFlow.tex index 1013239..cd5884d 100644 --- a/docs/_build/latex/muSRFlow.tex +++ b/docs/_build/latex/muSRFlow.tex @@ -71,7 +71,7 @@ \title{muSRFlow User Manual} -\date{Oct 10, 2026} +\date{Oct 11, 2026} \release{1.0.0\sphinxhyphen{}rc.4} \author{Zaher Salman} \newcommand{\sphinxlogo}{\vbox{}} @@ -1613,13 +1613,14 @@ field shows the naming mode the detected XML enables. \sphinxAtStartPar The directory that holds the musrfit tools (\sphinxcode{\sphinxupquote{musrfit}}, \sphinxcode{\sphinxupquote{musrview}}, \sphinxcode{\sphinxupquote{msr2data}}, and \sphinxcode{\sphinxupquote{dump\_header}}). Leave it empty for \sphinxstylestrong{auto\sphinxhyphen{}detect} -and muSRFlow searches the usual installation locations; choose a -directory when the tools live somewhere non\sphinxhyphen{}standard (for example a -developer build tree). The configured directory wins over every -auto\sphinxhyphen{}detected location for the tool commands muSRFlow runs, and is put -first on the \sphinxcode{\sphinxupquote{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. +and muSRFlow searches, in order, the bundled runtime shipped with the +packaged app, then the usual installation locations; choose a directory +when the tools live somewhere non\sphinxhyphen{}standard (for example a developer build +tree). The configured directory wins over every auto\sphinxhyphen{}detected location +for the tool commands muSRFlow runs, and is put first on the \sphinxcode{\sphinxupquote{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. \sphinxlineitem{musrfit threads} \sphinxAtStartPar @@ -1636,6 +1637,14 @@ 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. +\sphinxAtStartPar +\sphinxstylestrong{Estimate t0 from the prompt peak (non\sphinxhyphen{}LEM data)} (on by default): before a +local fit, muSRFlow runs \sphinxcode{\sphinxupquote{musrt0 \sphinxhyphen{}\sphinxhyphen{}getT0FromPromptPeak}} to write explicit +\sphinxcode{\sphinxupquote{t0}} lines into the generated MSR. This forces musrfit to use the +histogram peak as the time\sphinxhyphen{}zero for instruments whose data\sphinxhyphen{}file header t0 is +unreliable; the step is skipped automatically for LEM data. Uncheck it to +preserve the MSR as generated. + \sphinxlineitem{Output file suffixes} \sphinxAtStartPar The suffixes appended to generated artifacts: \sphinxstylestrong{Asymmetry} (default @@ -1753,6 +1762,19 @@ Share button copies a link; opening it restores the settings. \sphinxtableafterendhook\par \sphinxattableend\end{savenotes} + +\section{Bundled ROOT and musrfit} +\label{\detokenize{platforms:bundled-root-and-musrfit}} +\sphinxAtStartPar +Packaged desktop builds can carry a self\sphinxhyphen{}contained ROOT + musrfit runtime +inside the application, so a separate musrfit installation is not required on +the machine. When the bundle is present muSRFlow runs those tools with +\sphinxcode{\sphinxupquote{ROOTSYS}}, \sphinxcode{\sphinxupquote{MUSRFITPATH}}, and \sphinxcode{\sphinxupquote{LD\_LIBRARY\_PATH}} pointed at the bundled +tree; a directory set in \sphinxstylestrong{Preferences / musrfit binaries} still takes +precedence, and on builds without the bundle the system installation is used +exactly as before. The runtime is built with \sphinxcode{\sphinxupquote{packaging/runtime/build.sh}} +(see \sphinxcode{\sphinxupquote{packaging/runtime/README.md}}). + \sphinxAtStartPar 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 diff --git a/docs/_build/latex/muSRFlow.toc b/docs/_build/latex/muSRFlow.toc index 7515a8f..ba35ae2 100644 --- a/docs/_build/latex/muSRFlow.toc +++ b/docs/_build/latex/muSRFlow.toc @@ -57,6 +57,7 @@ \contentsline {section}{\numberline {9.4}Notes}{28}{section.9.4}% \contentsline {chapter}{\numberline {10}Preferences}{29}{chapter.10}% \contentsline {chapter}{\numberline {11}Web and desktop editions}{31}{chapter.11}% +\contentsline {section}{\numberline {11.1}Bundled ROOT and musrfit}{31}{section.11.1}% \contentsline {chapter}{\numberline {12}Keyboard shortcuts}{33}{chapter.12}% \contentsline {section}{\numberline {12.1}Parameter selection (Parameters tab)}{33}{section.12.1}% \contentsline {section}{\numberline {12.2}Parameter\sphinxhyphen {}plot window}{33}{section.12.2}% diff --git a/docs/source/platforms.rst b/docs/source/platforms.rst index a4b3c12..743a9ae 100644 --- a/docs/source/platforms.rst +++ b/docs/source/platforms.rst @@ -35,6 +35,18 @@ the command-line tools live. - Share webpage links; **Restore configuration link** to paste one. - Share button copies a link; opening it restores the settings. +Bundled ROOT and musrfit +------------------------ + +Packaged desktop builds can carry a self-contained ROOT + musrfit runtime +inside the application, so a separate musrfit installation is not required on +the machine. When the bundle is present muSRFlow runs those tools with +``ROOTSYS``, ``MUSRFITPATH``, and ``LD_LIBRARY_PATH`` pointed at the bundled +tree; a directory set in **Preferences / musrfit binaries** still takes +precedence, and on builds without the bundle the system installation is used +exactly as before. The runtime is built with ``packaging/runtime/build.sh`` +(see ``packaging/runtime/README.md``). + 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. \ No newline at end of file diff --git a/docs/source/preferences.rst b/docs/source/preferences.rst index 84ec028..6249ce7 100644 --- a/docs/source/preferences.rst +++ b/docs/source/preferences.rst @@ -22,13 +22,14 @@ musrfit startup XML 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. + and muSRFlow searches, in order, the bundled runtime shipped with the + packaged app, 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. musrfit threads The number of OpenMP threads passed to a local ``musrfit`` run (``-u``). diff --git a/muSRFitelec.js b/muSRFitelec.js index db6d497..914fd87 100644 --- a/muSRFitelec.js +++ b/muSRFitelec.js @@ -751,8 +751,7 @@ function selectBinFolder() { function loadRunHeaderText(filePath, fileFormat) { let dumpHeader = resolveLocalCommand("dump_header"); - let env = Object.assign({}, nodeProcess.env); - env.PATH = localCommandPathBias(); + let env = buildToolEnvironment(); let args = ["-fn", filePath]; if (fileFormat) args.push("-ff", fileFormat); let result = nodeChildProcess.spawnSync(dumpHeader, args, { @@ -897,7 +896,7 @@ function executeCapture(command, cwd = undefined, envOverrides = {}) { try { const stdout = nodeChildProcess.execSync(command, { cwd: cwd, - env: Object.assign({}, nodeProcess.env, envOverrides || {}), + env: Object.assign(buildToolEnvironment(), envOverrides || {}), stdio: ['ignore', 'pipe', 'pipe'], encoding: 'utf8' }); @@ -1023,6 +1022,46 @@ function fileExists(filename) { return 0; } +// A relocatable ROOT + musrfit runtime can be shipped inside the packaged app +// (built by packaging/runtime and installed under /runtime). It is +// detected only when a musrfit executable is actually present, so development +// checkouts, web builds, and packages without the bundle fall back to the host +// installation unchanged. +function bundledRuntimeRoot() { + if (!nodeProcess || !nodeProcess.resourcesPath) return ""; + let root = nodePath.join(nodeProcess.resourcesPath, "runtime"); + if (fileExists(nodePath.join(root, "bin", "musrfit")) + || fileExists(nodePath.join(root, "bin", "musrt0"))) { + return root; + } + return ""; +} + +function bundledRuntimeBinDir() { + let root = bundledRuntimeRoot(); + return root === "" ? "" : nodePath.join(root, "bin"); +} + +// Environment for externally spawned musrfit tools. When the bundled runtime is +// present, point ROOTSYS/MUSRFITPATH at it and prepend its lib directory so the +// binaries load the bundled ROOT and musrfit shared libraries regardless of the +// host; otherwise the host environment is passed through with the usual PATH +// bias for the configured and PSI/local tool locations. +function buildToolEnvironment() { + let env = Object.assign({}, nodeProcess.env); + let root = bundledRuntimeRoot(); + if (root !== "") { + let libDir = nodePath.join(root, "lib"); + env.ROOTSYS = root; + env.MUSRFITPATH = root; + env.LD_LIBRARY_PATH = env.LD_LIBRARY_PATH + ? libDir + ":" + env.LD_LIBRARY_PATH + : libDir; + } + env.PATH = localCommandPathBias(); + return env; +} + function resolveLocalCommand(commandName) { let candidates = []; let configuredBinDir = typeof getConfiguredBinDir === "function" @@ -1032,6 +1071,12 @@ function resolveLocalCommand(commandName) { // location, since auto-detection does not always find an installation. candidates.push(nodePath.join(configuredBinDir, commandName)); } + let bundledBinDir = bundledRuntimeBinDir(); + if (bundledBinDir !== "") { + // The bundled runtime outranks the host installation but still yields to + // an explicit user-configured tools directory. + candidates.push(nodePath.join(bundledBinDir, commandName)); + } candidates = candidates.concat([ "/usr/local/bin/" + commandName, "/usr/bin/" + commandName @@ -1048,11 +1093,16 @@ function resolveLocalCommand(commandName) { return commandName; } -// Path bias applied to externally spawned tools. The configured musrfit-tool -// directory, when present, is placed ahead of the usual PSI/local locations so -// children of musrfit that resolve their own helpers follow the preference. +// Path bias applied to externally spawned tools. The bundled runtime and the +// configured musrfit-tool directory, when present, are placed ahead of the +// usual PSI/local locations so children of musrfit that resolve their own +// helpers follow the preference. function localCommandPathBias() { let dirs = ["/usr/local/bin", "/usr/bin", "/bin"]; + let bundledBinDir = bundledRuntimeBinDir(); + if (bundledBinDir !== "") { + dirs.unshift(bundledBinDir); + } let configuredBinDir = typeof getConfiguredBinDir === "function" ? getConfiguredBinDir() : ""; if (configuredBinDir !== "") { @@ -1112,10 +1162,9 @@ function runLocalProcess(label, command, args, cwd, logFile, options = {}) { } appendFitLog(logFile, "\n$ " + commandLine + "\n"); - // Preserve the user's environment but bias PATH toward the configured and - // PSI/local locations where musrfit installations usually live. - let env = Object.assign({}, nodeProcess.env); - env.PATH = localCommandPathBias(); + // Preserve the user's environment but bias PATH toward the bundled, + // configured, and PSI/local locations where musrfit installations live. + let env = buildToolEnvironment(); // In the hardened build child_process access lives behind the preload // bridge, which buffers the streams and invokes onChunk per chunk so the @@ -1441,8 +1490,7 @@ async function collectIndependentSeriesArtifactsLocal(spec) { let runsArg = "[" + prepared.runs.join(" ") + "]"; let msr2data = resolveLocalCommand("msr2data"); - let env = Object.assign({}, nodeProcess.env); - env.PATH = ["/usr/local/bin", "/usr/bin", "/bin", env.PATH || ""].join(":"); + let env = buildToolEnvironment(); let runMsr2data = function(label, args) { let commandLine = displayCommand(msr2data, args); appendFitLog(logPath, "\n$ " + commandLine + "\n"); @@ -1576,8 +1624,7 @@ function exportLocalMusrfitParameterData(resolvedPath, options, logFile) { appendJobLog("Starting msr2data parameter export: " + commandLine); } - let env = Object.assign({}, nodeProcess.env); - env.PATH = ["/usr/local/bin", "/usr/bin", "/bin", env.PATH || ""].join(":"); + let env = buildToolEnvironment(); let result = nodeChildProcess.spawnSync(msr2data, args, { cwd: fitDir, env: env, @@ -1836,6 +1883,11 @@ function loadLocalPortableRunNaming() { let home = nodeProcess.env.HOME || ""; if (home) candidates.push(nodePath.join(home, ".musrfit", "musrfit_startup.xml")); candidates.push(nodePath.join(nodeProcess.cwd(), "musrfit_startup.xml")); + let bundledRoot = bundledRuntimeRoot(); + if (bundledRoot !== "") { + // Final fallback: the startup XML shipped alongside the bundled runtime. + candidates.push(nodePath.join(bundledRoot, "musrfit_startup.xml")); + } for (let i = 0; i < candidates.length; i++) { if (nodeFs.existsSync(candidates[i])) { startupPath = candidates[i]; diff --git a/package.json b/package.json index 67afacf..9bbbf74 100644 --- a/package.json +++ b/package.json @@ -13,7 +13,7 @@ "checksums:md5": "sh -c 'd=dist; [ -d \"$d\" ] || exit 0; for f in \"$d\"/*; do [ -f \"$f\" ] || continue; case \"$f\" in *.rpm|*.AppImage) base=$(basename \"$f\"); (cd \"$d\" && md5sum \"$base\" > \"$base.md5\");; esac; done'", "checksums:sha256": "sh -c 'd=dist; [ -d \"$d\" ] || exit 0; for f in \"$d\"/*; do [ -f \"$f\" ] || continue; case \"$f\" in *.rpm|*.AppImage) base=$(basename \"$f\"); (cd \"$d\" && sha256sum \"$base\" > \"$base.sha256\");; esac; done'", "checksums": "npm run checksums:md5 && npm run checksums:sha256", - "test:electron": "node tests/log-highlighting.test.js && node tests/action-state.test.js && node tests/electron-missing-data.test.js && node tests/electron-msr-title.test.js && node tests/electron-musrfit-threads.test.js && node tests/window-layering.test.js && node tests/msr-generation.test.js && node tests/root-plot-clean.test.js && node tests/parameter-plot.test.js && node tests/help-window.test.js && node tests/release-packaging.test.js && node tests/addrun.test.js && node tests/fit-statistic.test.js && node tests/series-fit-planner.test.js && node tests/series-fit-result.test.js && node tests/series-fit-inventory.test.js && node tests/series-fit-msr-preparation.test.js && node tests/series-artifact-contract.test.js && node tests/series-global-merge.test.js && node tests/series-fit-staging.test.js && node tests/series-fit-runner.test.js && node tests/series-runner-adapters.test.js && node tests/series-fit-routing.test.js && node tests/series-action-chips.test.js && node tests/singlehist-parity.test.js && node tests/url-parameters.test.js && node tests/run-naming.test.js && node tests/electron-portable-naming.test.js && node tests/shared-configuration.test.js && node tests/session-persistence.test.js && node tests/reference-fixtures.test.js && node tests/electron-bridge.test.js" + "test:electron": "node tests/log-highlighting.test.js && node tests/action-state.test.js && node tests/electron-missing-data.test.js && node tests/electron-msr-title.test.js && node tests/electron-musrfit-threads.test.js && node tests/window-layering.test.js && node tests/msr-generation.test.js && node tests/root-plot-clean.test.js && node tests/parameter-plot.test.js && node tests/help-window.test.js && node tests/release-packaging.test.js && node tests/addrun.test.js && node tests/fit-statistic.test.js && node tests/series-fit-planner.test.js && node tests/series-fit-result.test.js && node tests/series-fit-inventory.test.js && node tests/series-fit-msr-preparation.test.js && node tests/series-artifact-contract.test.js && node tests/series-global-merge.test.js && node tests/series-fit-staging.test.js && node tests/series-fit-runner.test.js && node tests/series-runner-adapters.test.js && node tests/series-fit-routing.test.js && node tests/series-action-chips.test.js && node tests/singlehist-parity.test.js && node tests/url-parameters.test.js && node tests/run-naming.test.js && node tests/electron-portable-naming.test.js && node tests/shared-configuration.test.js && node tests/session-persistence.test.js && node tests/reference-fixtures.test.js && node tests/electron-bridge.test.js && node tests/electron-bundled-runtime.test.js" }, "repository": { "type": "git", @@ -61,6 +61,15 @@ "directories": { "output": "dist" }, + "extraResources": [ + { + "from": "runtime", + "to": "runtime", + "filter": [ + "**/*" + ] + } + ], "protocols": [ { "name": "muSRFlow configuration link", diff --git a/packaging/runtime/Dockerfile b/packaging/runtime/Dockerfile new file mode 100644 index 0000000..ca75dc5 --- /dev/null +++ b/packaging/runtime/Dockerfile @@ -0,0 +1,53 @@ +# Copyright (C) 2026 Zaher Salman +# SPDX-License-Identifier: GPL-3.0-or-later +# +# Build container for the relocatable ROOT + musrfit runtime bundled with +# muSRFlow. The default base is a manylinux_2_28 image (AlmaLinux 8, glibc +# 2.28): it has a C++17 toolchain and gives a low glibc floor for the AppImage. +# Override BASE_IMAGE to target a different baseline (for example a custom +# manylinux2014 + devtoolset image), but note ROOT 6.38 will not build with the +# stock CentOS 7 GCC 4.8. + +ARG BASE_IMAGE=quay.io/pypa/manylinux_2_28_x86_64 +FROM ${BASE_IMAGE} + +ARG DEPS="" + +RUN dnf -y install \ + cmake \ + gcc \ + gcc-c++ \ + make \ + wget \ + git \ + which \ + tar \ + gzip \ + patchelf \ + gsl-devel \ + fftw-devel \ + libxml2-devel \ + boost-devel \ + openssl-devel \ + pcre-devel \ + zlib-devel \ + xz-devel \ + freetype-devel \ + fontconfig-devel \ + libpng-devel \ + libjpeg-turbo-devel \ + libtiff-devel \ + mesa-libGL-devel \ + mesa-libGLU-devel \ + libX11-devel \ + libXext-devel \ + libXft-devel \ + libXpm-devel \ + libXcursor-devel \ + libXrandr-devel \ + libXi-devel \ + python3 \ + && dnf clean all + +WORKDIR /work +ENTRYPOINT ["/work/packaging/runtime/build-runtime.sh"] diff --git a/packaging/runtime/README.md b/packaging/runtime/README.md new file mode 100644 index 0000000..24d4d7f --- /dev/null +++ b/packaging/runtime/README.md @@ -0,0 +1,91 @@ +# Bundled ROOT + musrfit runtime + +muSRFlow can ship 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 and placed at `/runtime`, where the renderer +discovers it automatically (see `muSRFitelec.js::bundledRuntimeRoot`). + +## Layout + +The runtime is a single install prefix that doubles as `ROOTSYS`: + +``` +runtime/ + bin/ # root-config, musrfit, musrt0, musrview, msr2data, ... + lib/ # libCore.so…, libPMusr.so…, bundled third-party .so + include/ + etc/ # ROOT/system config + share/ + musrfit_startup.xml # default startup file found via MUSRFITPATH +``` + +ROOT is configured with `-Dgnuinstall=OFF` so its libraries land in `lib/` +alongside `libPMusr`, letting a single `LD_LIBRARY_PATH` entry cover both. +Qt-based tools are disabled (`-Dqt_based_tools=OFF`) because muSRFlow only needs +the command-line tools. + +## Environment contract + +`muSRFitelec.js::buildToolEnvironment` exports, for every spawned musrfit tool: + +| Variable | Value | +|-------------------|---------------------------------------------------| +| `ROOTSYS` | `` | +| `MUSRFITPATH` | `` (musrfit finds `/musrfit_startup.xml`) | +| `LD_LIBRARY_PATH` | `/lib` prepended to the host value | +| `PATH` | `/bin` prepended (after a user-configured tools dir) | + +Resolution order for a tool (`resolveLocalCommand`): + +1. user-configured tools directory (Preferences → musrfit binaries) +2. `/runtime/bin` +3. `/usr/local/bin`, `/usr/bin` +4. `/bin`, `` +5. current working directory + +If `/runtime/bin/musrfit` (or `musrt0`) is absent, the bundle is +considered unavailable and the host installation is used unchanged. This keeps +development checkouts and web builds working with no configuration. + +## Building + +Requires Docker or Podman. + +```sh +packaging/runtime/build.sh +``` + +The host wrapper builds the image from `Dockerfile` and runs `build-runtime.sh`, +which downloads and builds ROOT, builds musrfit against it, bundles the +non-system shared-library closure, and writes the result to `/runtime`. +`electron-builder` then ships it via the `extraResources` entry in +`package.json`, and `dist:linux` produces an AppImage/RPM with the runtime +inside. + +Overridable variables (environment or `build.sh` arguments): + +- `ROOT_VERSION` (default `6.38.00`) +- `BASE_IMAGE` (default `quay.io/pypa/manylinux_2_28_x86_64`) +- `JOBS` (default: number of CPUs) +- `MUSRFIT_REPO` (default: the sibling `../musrfit.psi` checkout) + +## Notes / open items + +- The manylinux_2_28 base (AlmaLinux 8, glibc 2.28) is used because ROOT 6.38 + needs a C++17 toolchain that the original CentOS 7 / manylinux2014 image does + not provide out of the box. Override `BASE_IMAGE` to target a different glibc + baseline. +- `bundle-deps` copies the non-glibc shared-library closure using an allow-list + of host-provided libraries. Review `runtime/lib` after a build and add any + missing sonames to the allow-list in `build-runtime.sh`. +- The runtime is git-ignored (`runtime/*`, `!runtime/.gitkeep`); only the build + recipe and the placeholder are committed. +- Windows delivery reuses this same Linux tree inside a bundled WSL2 + distribution (tracked separately). + +## Verifying a build + +```sh +runtime/bin/musrt0 --version +ldd runtime/bin/musrt0 | grep -v "$PWD/runtime" # only host-provided libs left +``` diff --git a/packaging/runtime/build-runtime.sh b/packaging/runtime/build-runtime.sh new file mode 100755 index 0000000..2d8aa29 --- /dev/null +++ b/packaging/runtime/build-runtime.sh @@ -0,0 +1,125 @@ +#!/usr/bin/env bash +# Copyright (C) 2026 Zaher Salman +# SPDX-License-Identifier: GPL-3.0-or-later +# +# Build a relocatable ROOT + musrfit runtime for muSRFlow. Runs inside the +# container built from packaging/runtime/Dockerfile (see build.sh for the host +# wrapper). The repo is mounted at /work, so the finished tree lands directly in +# /work/runtime where electron-builder ships it as extraResources. +# +# Environment overrides: +# ROOT_VERSION ROOT release to build (default 6.38.00) +# ROOT_SOURCE "build" (default) or "binary" +# ROOT_BINARY_URL source tarball URL for ROOT_SOURCE=binary +# MUSRFIT_REPO path to the musrfit checkout (default /src/musrfit) +# PREFIX install prefix (default /work/runtime) +# JOBS build parallelism (default: nproc) + +set -euo pipefail + +ROOT_VERSION="${ROOT_VERSION:-6.38.00}" +ROOT_SOURCE="${ROOT_SOURCE:-build}" +MUSRFIT_REPO="${MUSRFIT_REPO:-/src/musrfit}" +PREFIX="${PREFIX:-/work/runtime}" +JOBS="${JOBS:-$(nproc)}" +ROOT_TARBALL_URL="https://root.cern/download/root_v${ROOT_VERSION}.source.tar.gz" + +# Host-provided libraries that must NOT be bundled: the AppImage contract keeps +# the C/C++ runtime, the dynamic loader, and the low-level system calls on the +# host so the bundle works across distributions. +SYSTEM_LIB_RE='^(libc|libm|libmvec|libdl|libpthread|librt|libgcc_s|libstdc\+\+|ld-linux[^/]*|libresolv|libutil|libnsl|libcrypt|libanl|libasound|libdl)\.so' + +log() { printf '\n=== %s ===\n' "$*"; } + +log "Building ROOT ${ROOT_VERSION} (${ROOT_SOURCE}) into ${PREFIX}" +mkdir -p "$PREFIX" + +if [ "$ROOT_SOURCE" = "binary" ]; then + : "${ROOT_BINARY_URL:?ROOT_BINARY_URL is required when ROOT_SOURCE=binary}" + wget -q -O /tmp/root.tar.gz "$ROOT_BINARY_URL" + mkdir -p /tmp/root-bin + tar -C /tmp/root-bin --strip-components=1 -xzf /tmp/root.tar.gz + cp -a /tmp/root-bin/. "$PREFIX/" +else + wget -q -O /tmp/root.tar.gz "$ROOT_TARBALL_URL" + mkdir -p /tmp/root-src + tar -C /tmp/root-src --strip-components=1 -xzf /tmp/root.tar.gz + cmake -S /tmp/root-src -B /tmp/root-build \ + -DCMAKE_INSTALL_PREFIX="$PREFIX" \ + -Dgnuinstall=OFF \ + -DCMAKE_BUILD_TYPE=Release \ + -DCMAKE_INSTALL_RPATH='$ORIGIN/../lib' \ + -Droofit=OFF \ + -Dtmva=OFF \ + -Dhttp=OFF \ + -Dsqlite=OFF \ + -Dbuiltin_xrootd=OFF \ + -Dminuit2=ON \ + -Dmathmore=ON \ + -Dx11=ON \ + -Dopengl=OFF \ + -Dpython=OFF \ + -Dpythia8=OFF + cmake --build /tmp/root-build -j "$JOBS" + cmake --install /tmp/root-build +fi + +log "Building musrfit against ${PREFIX}" +cmake -S "$MUSRFIT_REPO" -B /tmp/musrfit-build \ + -DCMAKE_INSTALL_PREFIX="$PREFIX" \ + -DCMAKE_BUILD_TYPE=Release \ + -DCMAKE_INSTALL_RPATH='$ORIGIN/../lib' \ + -Dqt_based_tools=OFF \ + -Dtry_OpenMP=ON +cmake --build /tmp/musrfit-build -j "$JOBS" +cmake --install /tmp/musrfit-build + +# musrfit resolves its default startup file via MUSRFITPATH (set by muSRFlow to +# the runtime root); ship a sane template so a fresh install has one. +if [ -f /work/packaging/runtime/musrfit_startup.xml ] && [ ! -f "$PREFIX/musrfit_startup.xml" ]; then + cp /work/packaging/runtime/musrfit_startup.xml "$PREFIX/musrfit_startup.xml" +fi + +log "Patching runpaths to \$ORIGIN" +if command -v patchelf >/dev/null 2>&1; then + find "$PREFIX/bin" -type f -perm -u+x -print0 2>/dev/null \ + | xargs -0 -r patchelf --set-rpath '$ORIGIN/../lib' 2>/dev/null || true + find "$PREFIX/lib" -maxdepth 1 -name '*.so*' -type f -print0 2>/dev/null \ + | xargs -0 -r patchelf --set-rpath '$ORIGIN' 2>/dev/null || true +else + echo "WARNING: patchelf not found; the runtime may depend on absolute paths" >&2 +fi + +log "Bundling non-system shared libraries into ${PREFIX}/lib" +bundle_deps() { + local dest="$PREFIX/lib" + local libs base + libs="$( + { + find "$PREFIX/bin" -type f -perm -u+x -exec ldd {} \; 2>/dev/null || true + find "$PREFIX/lib" -maxdepth 1 -name '*.so*' -type f -exec ldd {} \; 2>/dev/null || true + } | awk '/=>/ && $3 ~ /^\// {print $3}' | sort -u + )" + while IFS= read -r lib; do + [ -n "$lib" ] || continue + case "$lib" in + "$PREFIX"/*) continue ;; + esac + base="$(basename "$lib")" + if printf '%s\n' "$base" | grep -Eq "$SYSTEM_LIB_RE"; then + continue + fi + if [ ! -e "$dest/$base" ]; then + cp -Lf "$lib" "$dest/$base" + if command -v patchelf >/dev/null 2>&1; then + patchelf --set-rpath '$ORIGIN' "$dest/$base" 2>/dev/null || true + fi + fi + done <<< "$libs" +} +bundle_deps + +log "Result" +du -sh "$PREFIX" +ls "$PREFIX/bin" | head -40 +echo "musrfit_startup.xml present: $([ -f "$PREFIX/musrfit_startup.xml" ] && echo yes || echo no)" diff --git a/packaging/runtime/build.sh b/packaging/runtime/build.sh new file mode 100755 index 0000000..0565455 --- /dev/null +++ b/packaging/runtime/build.sh @@ -0,0 +1,51 @@ +#!/usr/bin/env bash +# Copyright (C) 2026 Zaher Salman +# SPDX-License-Identifier: GPL-3.0-or-later +# +# Host wrapper: build the runtime image, run the build inside it, and drop the +# relocatable ROOT + musrfit tree into /runtime for electron-builder. +# +# Requires Docker or Podman. The musrfit checkout is mounted read-only from the +# sibling directory ../musrfit.psi by default; set MUSRFIT_REPO to override. + +set -euo pipefail + +HERE="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)" +REPO="$(cd "$HERE/../.." && pwd)" +MUSRFIT_REPO="${MUSRFIT_REPO:-$(cd "$REPO/.." && pwd)/musrfit.psi}" + +ROOT_VERSION="${ROOT_VERSION:-6.38.00}" +ROOT_SOURCE="${ROOT_SOURCE:-build}" +BASE_IMAGE="${BASE_IMAGE:-quay.io/pypa/manylinux_2_28_x86_64}" +IMAGE="${IMAGE:-musrflow-runtime-builder}" +JOBS="${JOBS:-$(nproc)}" + +if command -v docker >/dev/null 2>&1; then + ENGINE=docker +elif command -v podman >/dev/null 2>&1; then + ENGINE=podman +else + echo "ERROR: docker or podman is required" >&2 + exit 1 +fi + +if [ ! -d "$MUSRFIT_REPO" ]; then + echo "ERROR: musrfit checkout not found at $MUSRFIT_REPO (set MUSRFIT_REPO)" >&2 + exit 1 +fi + +echo "Building image $IMAGE from $BASE_IMAGE" +"$ENGINE" build --build-arg "BASE_IMAGE=$BASE_IMAGE" -t "$IMAGE" "$HERE" + +echo "Building runtime into $REPO/runtime" +"$ENGINE" run --rm \ + -v "$REPO:/work" \ + -v "$MUSRFIT_REPO:/src/musrfit:ro" \ + -e "ROOT_VERSION=$ROOT_VERSION" \ + -e "ROOT_SOURCE=$ROOT_SOURCE" \ + -e "MUSRFIT_REPO=/src/musrfit" \ + -e "PREFIX=/work/runtime" \ + -e "JOBS=$JOBS" \ + "$IMAGE" + +echo "Done. Runtime written to $REPO/runtime" diff --git a/packaging/runtime/musrfit_startup.xml b/packaging/runtime/musrfit_startup.xml new file mode 100644 index 0000000..4fe90c2 --- /dev/null +++ b/packaging/runtime/musrfit_startup.xml @@ -0,0 +1,121 @@ + + + + Defines default settings for the musrfit package + + /psi.ch/group/lmu/public/data/lem/his + /psi.ch/group/lmu/public/data/alc/his + /psi.ch/group/lmu/public/data/dolly/his + /psi.ch/group/lmu/public/data/flame/his + /psi.ch/group/lmu/public/data/gpd/his + /psi.ch/group/lmu/public/data/gps/his + /psi.ch/group/lmu/public/data/hal/his + /psi.ch/group/lmu/public/data/ltf/his + /psi.ch/group/lmu/public/data/misc/his + /psi.ch/group/lmu/public/data/vms/his + + d%yyyy%/deltat_misc_%rrrr%.bin + + d%yyyy%/deltat_zh_chem_%rrrr%.bin + d%yyyy%/deltat_tdc_alc_%rrrr%.bin + d%yyyy%/tdc/deltat_tdc_alc_%rrrr%.bin + + d%yyyy%/tdc/root/deltat_tdc_vms_%yyyy%_%rrrr%.root + + d%yyyy%/tdc/root/deltat_tdc_dolly_%yyyy%_%rrrr%.root + d%yyyy%/pie1/deltat_flc_%rrrr%.bin + d%yyyy%/pie3/deltat_flc_%rrrr%.bin + d%yyyy%/deltat_flc_%rrrr%.bin + d%yyyy%/deltat_pta_dolly_%rrrr%.bin + d%yyyy%/pta/deltat_pta_dolly_%rrrr%.bin + d%yyyy%/tdc/deltat_tdc_dolly_%rrrr%.bin + d%yyyy%/tdc/mdu/deltat_tdc_dolly_%rrrr%.mdu + + d%yyyy%/tdc/root/deltat_tdc_flame_%yyyy%_%rrrr%.root + d%yyyy%/tdc/deltat_tdc_flame_%rrrr%.bin + d%yyyy%/tdc/mdu/deltat_tdc_flame_%yyyy%_%rrrr%.mdu + + d%yyyy%/tdc/root/deltat_tdc_gpd_%yyyy%_%rrrr%.root + d%yyyy%/deltat_mue1_%rrrr%.bin + d%yyyy%/deltat_fq_si_%rrrr%.bin + d%yyyy%/deltat_strobo_%rrrr%.bin + d%yyyy%/deltat_hp_ni_ht_%rrrr%.bin + d%yyyy%/deltat_hp_ni_%rrrr%.bin + d%yyyy%/deltat_ccr2_%rrrr%.bin + d%yyyy%/deltat_gpd_%rrrr%.bin + d%yyyy%/deltat_janis_%rrrr%.bin + d%yyyy%/deltat_janis_gpd_%rrrr%.bin + d%yyyy%/deltat_pta_gpd_%rrrr%.bin + d%yyyy%/pta/deltat_pta_gpd_%rrrr%.bin + d%yyyy%/tdc/deltat_tdc_gpd_%rrrr%.bin + d%yyyy%/tdc/mdu/deltat_tdc_gpd_%rrrr%.mdu + + d%yyyy%/tdc/root/deltat_tdc_gps_%yyyy%_%rrrr%.root + d%yyyy%/deltat_ccr_%rrrr%.bin + d%yyyy%/deltat_he3_%rrrr%.bin + d%yyyy%/deltat_stutt_%rrrr%.bin + d%yyyy%/deltat_ltf_%rrrr%.bin + d%yyyy%/deltat_flc_%rrrr%.bin + d%yyyy%/deltat_flc2_%rrrr%.bin + d%yyyy%/deltat_oven_%rrrr%.bin + d%yyyy%/deltat_oven2_%rrrr%.bin + d%yyyy%/deltat_pta_gps_%rrrr%.bin + d%yyyy%/tdc/deltat_tdc_gps_%rrrr%.bin + d%yyyy%/tdc/mdu/deltat_tdc_gps_%yyyy%_%rrrr%.mdu + + d%yyyy%/tdc/root/deltat_tdc_hifi_%yyyy%_%rrrr%.root + d%yyyy%/tdc/deltat_hifi_%rrrr%.bin + d%yyyy%/tdc/tdc_hifi_%yyyy%_%rrrrr%.mdu + d%yyyy%/tdc/root/deltat_tdc_hifi_%yyyy%_%rrrr%.mdu + + d%yyyy%/deltat_ltf_%rrrr%.bin + d%yyyy%/deltat_ltf2_%rrrr%.bin + d%yyyy%/deltat_pta_ltf_%rrrr%.bin + d%yyyy%/pta/deltat_pta_ltf_%rrrr%.bin + d%yyyy%/tdc/deltat_tdc_ltf_%rrrr%.bin + + %yyyy%/lem%yy%_his_%rrrr%.root + d%yyyy%/tdc/lem%yy%_his_%rrrr%.root + %yyyy%/lem%yy%_his_%rrrrr%.root + d%yyyy%/tdc/lem%yy%_his_%rrrrr%.root + + Gauss + 0 + none + real_and_imag + 0.0 + 1.0 + + + + + 24 + 25 + 26 + 27 + 28 + 29 + 30 + 20 + 21 + 22 + 23 + 2 + 3 + 5 + + + + 0,0,0 + 255,0,0 + 0,153,0 + 0,0,255 + 255,0,255 + 0,255,255 + 153,0,255 + 102,102,51 + 51,102,51 + 153,0,0 + + + diff --git a/runtime/.gitkeep b/runtime/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/tests/electron-bundled-runtime.test.js b/tests/electron-bundled-runtime.test.js new file mode 100644 index 0000000..526f115 --- /dev/null +++ b/tests/electron-bundled-runtime.test.js @@ -0,0 +1,149 @@ +// Copyright (C) 2026 Zaher Salman +// SPDX-License-Identifier: GPL-3.0-or-later + +// Bundled ROOT + musrfit runtime resolution. When a relocatable runtime is +// shipped under /runtime, muSRFlow must discover its bin directory, +// prefer it over the host installation (but still yield to a user-configured +// tools directory), and point ROOTSYS/MUSRFITPATH/LD_LIBRARY_PATH at it when +// spawning musrfit tools. Without the bundle everything falls back to the host. + +const assert = require("assert"); +const fs = require("fs"); +const os = require("os"); +const path = require("path"); +const vm = require("vm"); + +const repoRoot = path.resolve(__dirname, ".."); +const testRoot = fs.mkdtempSync(path.join(os.tmpdir(), "musrflow-runtime-")); +const emptyCwd = path.join(testRoot, "cwd"); +const emptyHome = path.join(testRoot, "home"); +fs.mkdirSync(emptyCwd, { recursive: true }); +fs.mkdirSync(emptyHome, { recursive: true }); + +const runtimeRoot = path.join(testRoot, "resources", "runtime"); +fs.mkdirSync(path.join(runtimeRoot, "bin"), { recursive: true }); +fs.mkdirSync(path.join(runtimeRoot, "lib"), { recursive: true }); +fs.writeFileSync(path.join(runtimeRoot, "bin", "musrfit"), "#!/bin/sh\n"); +fs.writeFileSync(path.join(runtimeRoot, "bin", "musrt0"), "#!/bin/sh\n"); +fs.writeFileSync(path.join(runtimeRoot, "lib", "libPMusr.so"), ""); +fs.writeFileSync(path.join(runtimeRoot, "musrfit_startup.xml"), + "\n" + emptyCwd + "\n\n"); + +function localStoreFactory() { + const store = {}; + return { + getItem: function(key) { + return Object.prototype.hasOwnProperty.call(store, key) ? store[key] : null; + }, + setItem: function(key, value) { store[key] = String(value); }, + removeItem: function(key) { delete store[key]; } + }; +} + +function buildSandbox(resourcesPath, envOverrides) { + const sandbox = { + console: { log: function() {}, error: console.error, warn: console.warn }, + document: { getElementById: function() { return null; } }, + process: { + cwd: function() { return emptyCwd; }, + env: Object.assign({ HOME: emptyHome }, envOverrides || {}), + resourcesPath: resourcesPath + }, + require: require, + window: { + electronIpcRenderer: { on: function() {}, send: function() {} }, + nodeChildProcess: {}, + nodeFs: fs, + nodePath: path, + localStorage: localStoreFactory() + } + }; + sandbox.global = sandbox; + return sandbox; +} + +function loadLibraries(sandbox) { + vm.runInNewContext( + fs.readFileSync(path.join(repoRoot, "muSRFitlib.js"), "utf8"), + sandbox, { filename: "muSRFitlib.js" }); + vm.runInNewContext( + fs.readFileSync(path.join(repoRoot, "muSRFitelec.js"), "utf8"), + sandbox, { filename: "muSRFitelec.js" }); +} + +const resourcesPath = path.join(testRoot, "resources"); + +// With the bundle present the runtime bin must win over /usr/local/bin and the +// spawn environment must expose ROOTSYS, MUSRFITPATH, and LD_LIBRARY_PATH. +(function testBundledRuntimeIsPreferredAndExported() { + const sandbox = buildSandbox(resourcesPath, { LD_LIBRARY_PATH: "/host/lib" }); + loadLibraries(sandbox); + + assert.strictEqual(sandbox.bundledRuntimeRoot(), runtimeRoot); + assert.strictEqual( + sandbox.resolveLocalCommand("musrfit"), + path.join(runtimeRoot, "bin", "musrfit")); + assert.strictEqual( + sandbox.resolveLocalCommand("musrt0"), + path.join(runtimeRoot, "bin", "musrt0")); + assert.strictEqual( + sandbox.localCommandPathBias().indexOf(path.join(runtimeRoot, "bin") + ":") === 0, + true); + + const env = sandbox.buildToolEnvironment(); + assert.strictEqual(env.ROOTSYS, runtimeRoot); + assert.strictEqual(env.MUSRFITPATH, runtimeRoot); + assert.strictEqual(env.LD_LIBRARY_PATH, + path.join(runtimeRoot, "lib") + ":/host/lib"); + assert.strictEqual(env.PATH.indexOf(path.join(runtimeRoot, "bin") + ":") === 0, true); +})(); + +// An explicit user-configured tools directory must still outrank the bundle, +// both for command resolution and for the PATH bias. +(function testConfiguredBinDirOutranksBundle() { + const tools = path.join(testRoot, "tools"); + fs.mkdirSync(tools, { recursive: true }); + fs.writeFileSync(path.join(tools, "musrfit"), "#!/bin/sh\n"); + + const sandbox = buildSandbox(resourcesPath, {}); + loadLibraries(sandbox); + sandbox.window.localStorage.setItem("musrflow.binDir", tools); + + assert.strictEqual( + sandbox.resolveLocalCommand("musrfit"), + path.join(tools, "musrfit")); + assert.strictEqual( + sandbox.localCommandPathBias().indexOf(tools + ":" + path.join(runtimeRoot, "bin") + ":") === 0, + true); +})(); + +// Without the bundle (no runtime/bin/musrfit) detection is off and the host +// environment is passed through unchanged. +(function testNoBundleFallsBackToHost() { + const plainResources = path.join(testRoot, "plain-resources"); + fs.mkdirSync(plainResources, { recursive: true }); + + const sandbox = buildSandbox(plainResources, {}); + loadLibraries(sandbox); + + assert.strictEqual(sandbox.bundledRuntimeRoot(), ""); + assert.strictEqual(sandbox.bundledRuntimeBinDir(), ""); + const env = sandbox.buildToolEnvironment(); + assert.strictEqual(env.ROOTSYS, undefined); + assert.strictEqual(env.MUSRFITPATH, undefined); + assert.strictEqual(env.LD_LIBRARY_PATH, undefined); + assert.strictEqual(env.PATH.indexOf(plainResources) === -1, true); +})(); + +// The startup XML shipped with the bundle is used as the last resort when no +// user, home, or working-directory startup file exists. +(function testBundledStartupXmlFallback() { + const sandbox = buildSandbox(resourcesPath, {}); + loadLibraries(sandbox); + + assert.strictEqual( + sandbox.loadLocalPortableRunNaming(), + path.join(runtimeRoot, "musrfit_startup.xml")); +})(); + +console.log("Bundled runtime resolution tests passed");