66 lines
1.9 KiB
ReStructuredText
66 lines
1.9 KiB
ReStructuredText
Getting started
|
|
===============
|
|
|
|
Prerequisites
|
|
-------------
|
|
|
|
muSRFlow wraps external ``musrfit`` tools. They must be installed and on the
|
|
``PATH`` on the machine that runs the tools:
|
|
|
|
* Desktop: on the machine running the Electron app.
|
|
* Web: on the server that hosts the CGI runner.
|
|
|
|
The browser edition needs no local installation at all.
|
|
|
|
Desktop installation
|
|
--------------------
|
|
|
|
From a checkout, with `Node.js <https://nodejs.org/>`_ and npm installed:
|
|
|
|
.. code-block:: console
|
|
|
|
$ npm install
|
|
$ npm start
|
|
|
|
`npm install` is only needed once; later sessions start with `npm start`.
|
|
|
|
Release packages (Linux RPM and AppImage) are produced with:
|
|
|
|
.. code-block:: console
|
|
|
|
$ npm run dist:rpm
|
|
$ npm run dist:appimage
|
|
|
|
The build and runtime requirements are described in
|
|
``docs/DESKTOP_DEPLOYMENT.md``.
|
|
|
|
Running the desktop app
|
|
-----------------------
|
|
|
|
When the window opens, the **Runs** tab is active and the current year is
|
|
already selected. Enter run numbers, choose a model, and press **Fit**. The
|
|
first fit writes the working files next to your MSR document and results
|
|
appear in the **Results** tab.
|
|
|
|
Opening the web edition
|
|
-----------------------
|
|
|
|
Point your browser at the deployment URL (e.g.
|
|
``http://musruser.psi.ch/muSRFlow/``). Instrument options and run numbers are
|
|
the ones the server data tree supports. There is nothing to install; the
|
|
parameter table is also served from the same data tree.
|
|
|
|
The Quick Start guide
|
|
---------------------
|
|
|
|
The ``?`` button at the right of the tab bar opens a short, tab-aware guide.
|
|
On the desktop it opens in an independent window; in the browser it opens a
|
|
modeless dialog next to the main window. Each of its sections corresponds to
|
|
one tab and is expanded into a chapter of this manual.
|
|
|
|
Support
|
|
-------
|
|
|
|
For questions and bug reports contact Zaher Salman
|
|
`<zaher.salman@psi.ch>`_. Issue tracking is linked from the project
|
|
repository. |