muSRFlow User Manual
====================

muSRFlow is a graphical workflow for creating, editing, fitting, plotting, and
inspecting ``musrfit`` MSR files. It is available as an Electron desktop
application and as a browser application, and both editions wrap the same set
of command-line tools (``musrfit``, ``musrview``, ``msr2data``, and
``dump_header``).

Start with :doc:`install-windows` or :doc:`install-linux` for desktop setup.
For the browser edition, see :doc:`getting-started`.

These pages describe the end-user workflow. They are organised around the
main window tabs, mirroring the Quick Start help that is built into the
application (the ``?`` button).

.. toctree::
   :maxdepth: 2
   :caption: Contents

   overview
   getting-started
   install-windows
   install-linux
   runs-fitting
   parameters-plots
   constraints
   t0-background
   msr-editor
   results-diagnostics
   configuration-sharing
   preferences
   platforms
   keyboard-shortcuts
   troubleshooting
   glossary

If anything in this manual does not match the behaviour you see, contact
`Zaher Salman <mailto:zaher.salman@psi.ch>`_.

Separate repository documents cover desktop builds and packaging
(``docs/DESKTOP_DEPLOYMENT.md``) and the web-server/CGI deployment
(``cgi/README.md``); this manual concentrates on using the application.