From eac9a8adc9d5c06858d6fcaa83fe8b1c147ebb48 Mon Sep 17 00:00:00 2001 From: Andreas Suter Date: Fri, 15 May 2020 21:17:32 +0200 Subject: [PATCH] update of the docu for version 1.6.0 --- doc/html/_images/mupp-add-var.svg | 950 ++ doc/html/_images/mupp-gui-0.svg | 2699 ++--- doc/html/_images/mupp-plot-0.svg | 1044 +- doc/html/_sources/mupp.rst.txt | 152 +- doc/html/_static/basic.css | 13 +- doc/html/_static/doctools.js | 2 +- doc/html/_static/documentation_options.js | 2 +- doc/html/_static/jquery-3.4.1.js | 10598 ++++++++++++++++++++ doc/html/_static/jquery.js | 6 +- doc/html/_static/language_data.js | 2 +- doc/html/_static/nature.css | 2 +- doc/html/_static/searchtools.js | 2 +- doc/html/acknowledgement.html | 10 +- doc/html/any2many.html | 10 +- doc/html/bugtracking.html | 10 +- doc/html/cite.html | 10 +- doc/html/genindex.html | 10 +- doc/html/index.html | 10 +- doc/html/msr2data.html | 10 +- doc/html/mupp.html | 158 +- doc/html/musr-root.html | 10 +- doc/html/musredit.html | 10 +- doc/html/search.html | 12 +- doc/html/searchindex.js | 2 +- doc/html/setup-dks.html | 10 +- doc/html/setup-standard.html | 10 +- doc/html/tutorial.html | 10 +- doc/html/user-libs.html | 10 +- doc/html/user-manual.html | 12 +- 29 files changed, 13657 insertions(+), 2129 deletions(-) create mode 100644 doc/html/_images/mupp-add-var.svg create mode 100644 doc/html/_static/jquery-3.4.1.js diff --git a/doc/html/_images/mupp-add-var.svg b/doc/html/_images/mupp-add-var.svg new file mode 100644 index 00000000..0e9d334b --- /dev/null +++ b/doc/html/_images/mupp-add-var.svg @@ -0,0 +1,950 @@ + + + + + + image/svg+xml + + + + + + + + + + + 1 + + 2 + + 3 + + 4 + + 5 + + diff --git a/doc/html/_images/mupp-gui-0.svg b/doc/html/_images/mupp-gui-0.svg index 2e046894..5b6c6aaa 100644 --- a/doc/html/_images/mupp-gui-0.svg +++ b/doc/html/_images/mupp-gui-0.svg @@ -1,6 +1,4 @@ - - + version="1.1"> @@ -32,1363 +30,1398 @@ - + + - + preserveAspectRatio="none" + height="715" + width="840" /> + 1 - - - + 2 - - - - 3 - - - + id="tspan1478-7" + x="429.03146" + y="288.18073" + style="stroke-width:0.685867">2 + 4 - - - + id="tspan1478-5" + x="626.03149" + y="287.98648" + style="stroke-width:0.685867">3 + 5 - - - + style="stroke-width:0.685867" + y="287.99988" + x="742.03149" + id="tspan1478-5-9" + sodipodi:role="line">4 + 6 - - - + id="tspan1478-5-9-7" + x="672.03149" + y="388.80576" + style="stroke-width:0.685867">5 + 6 + + 7 + + 8 + + 9 - - - + + 10 + 7 - - - - 9 - - - + id="tspan1478-5-9-6-3-9" + x="54.304081" + y="520" + style="stroke-width:0.685867">11 + 10 + id="tspan1478-5-9-6-3-8" + x="333.9491" + y="520.18085" + style="stroke-width:0.685867">12 - - - 11 - - - + style="fill:none;stroke:#ff9900;stroke-width:2.38854" + id="path1476-5-6-6-20-9" + cx="97" + cy="669" + rx="23.805731" + ry="16.805731" /> 12 + id="tspan1478-5-9-6-3-3" + x="78.949097" + y="679" + style="stroke-width:0.685867">14 - - + ry="16.805731" + rx="23.805731" + cy="588" + cx="68" + id="path1476-5-6-6-20-9-6" + style="fill:none;stroke:#ff9900;stroke-width:2.38854" /> 13 - diff --git a/doc/html/_images/mupp-plot-0.svg b/doc/html/_images/mupp-plot-0.svg index 1304ec4e..bbf93bb6 100644 --- a/doc/html/_images/mupp-plot-0.svg +++ b/doc/html/_images/mupp-plot-0.svg @@ -1,6 +1,4 @@ - - + version="1.1"> @@ -32,617 +30,425 @@ - + + + preserveAspectRatio="none" + height="874" + width="640" /> + diff --git a/doc/html/_sources/mupp.rst.txt b/doc/html/_sources/mupp.rst.txt index ae79c471..c8156723 100644 --- a/doc/html/_sources/mupp.rst.txt +++ b/doc/html/_sources/mupp.rst.txt @@ -13,6 +13,11 @@ Also a collection of ``msr``-files can be invoked. ``mupp`` is heavily inspired ``mupp`` can be operated from within as graphical user interface or via a command line scripting interface. The ``mupp`` GUI can be invoked either directly from the command line or from within :ref:`musredit `. +Each collection bundles a number of runs, where a run is a single |mgr|\SR measurement. +A run is analyzed by a number of parameters (defined in the msr-files), and complemented by +additional physical parameters as the temperature, magnetic field, implantation energy, etc. +Hence parameters can be seen as vectors and can be plot against each other. + .. index:: mupp-gui The Graphical User Interface @@ -52,10 +57,30 @@ A typical setting could look like this 11. ``Remove Collection``: will remove the selected collection 12. ``Refresh Collection``: will reload the collection (``db``- or ``dat``-file). This is often useful during beamtime where the collection is growing run-by-run. -13. This is the script command line. Currently it allows to perform the tasks without mouse gambling. +13. Command history window. +14. This is the script command line. Currently it allows to perform the tasks without mouse gambling. In the future much more commands are planed. See the ``Help / Cmd's`` for the currently available commands. +Define Variable Dialog +++++++++++++++++++++++ + +.. image:: ../images/mupp-add-var.* + +1. Variable text edit window. +2. Collection link window. +3. Shows the parameters of the selected collection. +4. Check if the variable/error variable from the edit window is valid. +5. Add the variable to the selected collection(s) if the parsing is successful. + +A variable defined here is a mathematical expression defined by parameters of loaded collections. +Since a parameter also has an associated error, also newly defined variables **always** need +to be defined together with a corresponding error variable. If the name of a variable is defined +as ``SigmaSC_10`` (see the above snapshot), the error variable need to be named as ``SigmaSC_10Err``. + +Currently the following mathematical functions are defined: ``max``, ``min``, ``abs``, ``sin``, ``cos``, +``tan``, ``exp``, ``log``, ``ln``, ``pow``. + .. index:: mupp-scripting The Scripting Interface @@ -78,11 +103,14 @@ or web-based interaction which requests figures. A script is invoked by the comm selects collection ````, where ```` is either the *number* of the collections, or its *name*, *e.g.* select YBCO-40nm-T5K-FC150mT-Escan.db. -**addX