From 58461bf01372e8baeb24bf53909307e9c7696abf Mon Sep 17 00:00:00 2001 From: Andreas Suter Date: Mon, 25 May 2020 16:27:18 +0200 Subject: [PATCH] updated the docu and adopted the ChangLog --- ChangeLog | 5 +++++ doc/html/.buildinfo | 2 +- doc/html/_sources/user-manual.rst.txt | 12 +++++++++--- doc/html/_static/documentation_options.js | 2 +- doc/html/acknowledgement.html | 8 ++++---- doc/html/any2many.html | 8 ++++---- doc/html/bugtracking.html | 8 ++++---- doc/html/cite.html | 8 ++++---- doc/html/genindex.html | 8 ++++---- doc/html/index.html | 8 ++++---- doc/html/msr2data.html | 8 ++++---- doc/html/mupp.html | 8 ++++---- doc/html/musr-root.html | 8 ++++---- doc/html/musredit.html | 8 ++++---- doc/html/search.html | 8 ++++---- doc/html/setup-dks.html | 8 ++++---- doc/html/setup-standard.html | 8 ++++---- doc/html/tutorial.html | 8 ++++---- doc/html/user-libs.html | 8 ++++---- doc/html/user-manual.html | 18 +++++++++++------- 20 files changed, 87 insertions(+), 72 deletions(-) diff --git a/ChangeLog b/ChangeLog index 83f6f199..074bbde2 100644 --- a/ChangeLog +++ b/ChangeLog @@ -12,6 +12,11 @@ or https://bitbucket.org/muonspin/musrfit/commits/all +Release of V1.6.1, 2020/05/25 +============================= + +For asymmetry fits: allow alpha, beta in the RUN block to be functions. + Release of V1.6.0, 2020/05/16 ============================= diff --git a/doc/html/.buildinfo b/doc/html/.buildinfo index 7ac2c58d..b66b59df 100644 --- a/doc/html/.buildinfo +++ b/doc/html/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: 90c2680fff90669033f1bce5f6912272 +config: 2fd2e79340d6214c8fde0515f4f3fbe3 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/doc/html/_sources/user-manual.rst.txt b/doc/html/_sources/user-manual.rst.txt index 3e8e23bc..b20c63dd 100644 --- a/doc/html/_sources/user-manual.rst.txt +++ b/doc/html/_sources/user-manual.rst.txt @@ -775,7 +775,7 @@ The FUNCTIONS Block +++++++++++++++++++ Here some auxiliary functions can be defined. These functions can currently *only* operate on the defined parameters. They can be used in the -:ref:`THEORY block ` and for one specific case in the :ref:`RUN block `. Supported is the use of basic arithmetic: +:ref:`THEORY block ` and for three specific cases in the :ref:`RUN block ` (`norm`, `alpha`, and `beta`). Supported is the use of basic arithmetic: :math:`+` Addition @@ -1064,18 +1064,24 @@ In order to describe the operations needed for fitting and plotting, quite some .. _msr-alpha-beta: **alpha, beta** (fit type 2, 3, 5) - These parameters are used to correct the asymmetry for different detector efficiencies, solid angles and initial asymmetries. They are defined as :math:`\alpha = N_{0,b}/N_{0,f}` and :math:`\beta = A_{0,b}/A_{0,f}`. If the parameters are not specified in the :ref:`RUN block `, for each one the value of 1 is assumed (for fittype 5, alpha is estimated from the ratio of :math:`\sum_i \left( N_{\mathrm{bp}}(i)+N_{\mathrm{bm}}(i) \right)` and :math:`\sum_i \left( N_{\mathrm{fp}}(i)+N_{\mathrm{fm}}(i) \right)`). Example for alpha with fit parameter number 1: + These parameters are used to correct the asymmetry for different detector efficiencies, solid angles and initial asymmetries. They are defined as :math:`\alpha = N_{0,b}/N_{0,f}` and :math:`\beta = A_{0,b}/A_{0,f}`. If the parameters are not specified in the :ref:`RUN block `, for each one the value of 1 is assumed (for fittype 5, alpha is estimated from the ratio of :math:`\sum_i \left( N_{\mathrm{bp}}(i)+N_{\mathrm{bm}}(i) \right)` and :math:`\sum_i \left( N_{\mathrm{fp}}(i)+N_{\mathrm{fm}}(i) \right)`). Both, `alpha` as well as `beta` can be expressed through a function. Example for alpha with fit parameter number 1: :: alpha 1 + Example for an ``alpha`` defined via function number 1: + + :: + + alpha fun1 + .. index:: norm .. _msr-norm: **norm** (fit type 0) Number of the fit parameter that represents the normalization constant :math:`N_0` of the histogram; the value of this parameter is given either per nanosecond or per bin (see :ref:`below `). - It is possible to substitute the parameter number by a function here (and only here in a RUN block), for instance to relate :math:`N_0`\'s of different histograms through an :math:`\alpha` + It is possible to substitute the parameter number by a function, for instance to relate :math:`N_0`\'s of different histograms through an :math:`\alpha` parameter. Example for a ``norm`` defined by fit parameter number 12: :: diff --git a/doc/html/_static/documentation_options.js b/doc/html/_static/documentation_options.js index c5d9c26f..63761070 100644 --- a/doc/html/_static/documentation_options.js +++ b/doc/html/_static/documentation_options.js @@ -1,6 +1,6 @@ var DOCUMENTATION_OPTIONS = { URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), - VERSION: '1.6.0', + VERSION: '1.6.1', LANGUAGE: 'None', COLLAPSE_INDEX: false, FILE_SUFFIX: '.html', diff --git a/doc/html/acknowledgement.html b/doc/html/acknowledgement.html index cfb036e7..ffebb3a1 100644 --- a/doc/html/acknowledgement.html +++ b/doc/html/acknowledgement.html @@ -4,7 +4,7 @@ - Acknowledgements — musrfit 1.6.0 documentation + Acknowledgements — musrfit 1.6.1 documentation @@ -30,7 +30,7 @@
  • previous |
    • -
  • musrfit 1.6.0 documentation »
    • +
  • musrfit 1.6.1 documentation »
    • @@ -100,12 +100,12 @@ extremely competent way to deal with his projects as well as to deal with the ch
  • previous |
    • -
  • musrfit 1.6.0 documentation »
    • +
  • musrfit 1.6.1 documentation »
    • diff --git a/doc/html/any2many.html b/doc/html/any2many.html index bc76f097..ac86b1bd 100644 --- a/doc/html/any2many.html +++ b/doc/html/any2many.html @@ -4,7 +4,7 @@ - any2many - a Universal μSR-file-format converter — musrfit 1.6.0 documentation + any2many - a Universal μSR-file-format converter — musrfit 1.6.1 documentation @@ -30,7 +30,7 @@
  • previous |
    • -
  • musrfit 1.6.0 documentation »
    • +
  • musrfit 1.6.1 documentation »
    • @@ -90,12 +90,12 @@ For a detailed description see previous | -
  • musrfit 1.6.0 documentation »
    • +
  • musrfit 1.6.1 documentation »
    • diff --git a/doc/html/bugtracking.html b/doc/html/bugtracking.html index d0421f76..e13f9a74 100644 --- a/doc/html/bugtracking.html +++ b/doc/html/bugtracking.html @@ -4,7 +4,7 @@ - Bugtracking — musrfit 1.6.0 documentation + Bugtracking — musrfit 1.6.1 documentation @@ -26,7 +26,7 @@
  • previous |
    • -
  • musrfit 1.6.0 documentation »
    • +
  • musrfit 1.6.1 documentation »
    • @@ -81,12 +81,12 @@ or send an e-mail to A. Suter at PSI.

  • previous |
    • -
  • musrfit 1.6.0 documentation »
    • +
  • musrfit 1.6.1 documentation »
    • diff --git a/doc/html/cite.html b/doc/html/cite.html index 4c1e816f..d9161bea 100644 --- a/doc/html/cite.html +++ b/doc/html/cite.html @@ -4,7 +4,7 @@ - How to Cite musrfit? — musrfit 1.6.0 documentation + How to Cite musrfit? — musrfit 1.6.1 documentation @@ -30,7 +30,7 @@
  • previous |
    • -
  • musrfit 1.6.0 documentation »
    • +
  • musrfit 1.6.1 documentation »
    • @@ -102,12 +102,12 @@
  • previous |
    • -
  • musrfit 1.6.0 documentation »
    • +
  • musrfit 1.6.1 documentation »
    • diff --git a/doc/html/genindex.html b/doc/html/genindex.html index e471789c..327beab5 100644 --- a/doc/html/genindex.html +++ b/doc/html/genindex.html @@ -5,7 +5,7 @@ - Index — musrfit 1.6.0 documentation + Index — musrfit 1.6.1 documentation @@ -23,7 +23,7 @@
  • index
    • -
  • musrfit 1.6.0 documentation »
    • +
  • musrfit 1.6.1 documentation »
    • @@ -611,12 +611,12 @@
  • index
    • -
  • musrfit 1.6.0 documentation »
    • +
  • musrfit 1.6.1 documentation »
    • diff --git a/doc/html/index.html b/doc/html/index.html index 03856aa8..d2e26fb2 100644 --- a/doc/html/index.html +++ b/doc/html/index.html @@ -4,7 +4,7 @@ - Welcome to the musrfit documentation! — musrfit 1.6.0 documentation + Welcome to the musrfit documentation! — musrfit 1.6.1 documentation @@ -26,7 +26,7 @@
  • next |
    • -
  • musrfit 1.6.0 documentation »
    • +
  • musrfit 1.6.1 documentation »
    • @@ -168,12 +168,12 @@
  • next |
    • -
  • musrfit 1.6.0 documentation »
    • +
  • musrfit 1.6.1 documentation »
    • diff --git a/doc/html/msr2data.html b/doc/html/msr2data.html index af84f1ff..0e7621e4 100644 --- a/doc/html/msr2data.html +++ b/doc/html/msr2data.html @@ -4,7 +4,7 @@ - msr2data - A Program for Automatically Processing Multiple musrfit msr Files — musrfit 1.6.0 documentation + msr2data - A Program for Automatically Processing Multiple musrfit msr Files — musrfit 1.6.1 documentation @@ -30,7 +30,7 @@
  • previous |
    • -
  • musrfit 1.6.0 documentation »
    • +
  • musrfit 1.6.1 documentation »
    • @@ -418,12 +418,12 @@ fit serves as template for the second and so on. The template field stays empty
  • previous |
    • -
  • musrfit 1.6.0 documentation »
    • +
  • musrfit 1.6.1 documentation »
    • diff --git a/doc/html/mupp.html b/doc/html/mupp.html index 40de7bee..efdeaff2 100644 --- a/doc/html/mupp.html +++ b/doc/html/mupp.html @@ -4,7 +4,7 @@ - mupp - μSR Parameter Plotter — musrfit 1.6.0 documentation + mupp - μSR Parameter Plotter — musrfit 1.6.1 documentation @@ -30,7 +30,7 @@
  • previous |
    • -
  • musrfit 1.6.0 documentation »
    • +
  • musrfit 1.6.1 documentation »
    • @@ -298,12 +298,12 @@ SCRIPT COMMANDS:
  • previous |
    • -
  • musrfit 1.6.0 documentation »
    • +
  • musrfit 1.6.1 documentation »
    • diff --git a/doc/html/musr-root.html b/doc/html/musr-root.html index 85684427..876998cb 100644 --- a/doc/html/musr-root.html +++ b/doc/html/musr-root.html @@ -4,7 +4,7 @@ - MusrRoot - an Extensible Open File Format for μSR — musrfit 1.6.0 documentation + MusrRoot - an Extensible Open File Format for μSR — musrfit 1.6.1 documentation @@ -30,7 +30,7 @@
  • previous |
    • -
  • musrfit 1.6.0 documentation »
    • +
  • musrfit 1.6.1 documentation »
    • @@ -910,12 +910,12 @@ the entry has been added. The last token, previous | -
  • musrfit 1.6.0 documentation »
    • +
  • musrfit 1.6.1 documentation »
    • diff --git a/doc/html/musredit.html b/doc/html/musredit.html index debed612..9352626e 100644 --- a/doc/html/musredit.html +++ b/doc/html/musredit.html @@ -4,7 +4,7 @@ - musredit: the GUI Based Interface to musrfit — musrfit 1.6.0 documentation + musredit: the GUI Based Interface to musrfit — musrfit 1.6.1 documentation @@ -30,7 +30,7 @@
  • previous |
    • -
  • musrfit 1.6.0 documentation »
    • +
  • musrfit 1.6.1 documentation »
    • @@ -531,12 +531,12 @@ the corresponding fit parameter value, except the phases where the step will be
  • previous |
    • -
  • musrfit 1.6.0 documentation »
    • +
  • musrfit 1.6.1 documentation »
    • diff --git a/doc/html/search.html b/doc/html/search.html index d0cd2faa..99c1e1a2 100644 --- a/doc/html/search.html +++ b/doc/html/search.html @@ -4,7 +4,7 @@ - Search — musrfit 1.6.0 documentation + Search — musrfit 1.6.1 documentation @@ -27,7 +27,7 @@
  • index
    • -
  • musrfit 1.6.0 documentation »
    • +
  • musrfit 1.6.1 documentation »
    • @@ -75,12 +75,12 @@
  • index
    • -
  • musrfit 1.6.0 documentation »
    • +
  • musrfit 1.6.1 documentation »
    • diff --git a/doc/html/setup-dks.html b/doc/html/setup-dks.html index c5b25e44..2532f719 100644 --- a/doc/html/setup-dks.html +++ b/doc/html/setup-dks.html @@ -4,7 +4,7 @@ - Setting up musrfit / DKS: High Speed Fitting with GPU’s — musrfit 1.6.0 documentation + Setting up musrfit / DKS: High Speed Fitting with GPU’s — musrfit 1.6.1 documentation @@ -30,7 +30,7 @@
  • previous |
    • -
  • musrfit 1.6.0 documentation »
    • +
  • musrfit 1.6.1 documentation »
    • @@ -309,12 +309,12 @@ The only thing you need previous | -
  • musrfit 1.6.0 documentation »
    • +
  • musrfit 1.6.1 documentation »
    • diff --git a/doc/html/setup-standard.html b/doc/html/setup-standard.html index 5c0f0b16..49a893e2 100644 --- a/doc/html/setup-standard.html +++ b/doc/html/setup-standard.html @@ -4,7 +4,7 @@ - Setting up musrfit on Different Platforms — musrfit 1.6.0 documentation + Setting up musrfit on Different Platforms — musrfit 1.6.1 documentation @@ -30,7 +30,7 @@
  • previous |
    • -
  • musrfit 1.6.0 documentation »
    • +
  • musrfit 1.6.1 documentation »
    • @@ -1293,12 +1293,12 @@ $ musrview test-histo-ROOT-NPP.msr
  • previous |
    • -
  • musrfit 1.6.0 documentation »
    • +
  • musrfit 1.6.1 documentation »
    • diff --git a/doc/html/tutorial.html b/doc/html/tutorial.html index 8414ee1e..889b133a 100644 --- a/doc/html/tutorial.html +++ b/doc/html/tutorial.html @@ -4,7 +4,7 @@ - Tutorial for musrfit — musrfit 1.6.0 documentation + Tutorial for musrfit — musrfit 1.6.1 documentation @@ -30,7 +30,7 @@
  • previous |
    • -
  • musrfit 1.6.0 documentation »
    • +
  • musrfit 1.6.1 documentation »
    • @@ -431,12 +431,12 @@ For a complete description please refer to the manuals of previous | -
  • musrfit 1.6.0 documentation »
    • +
  • musrfit 1.6.1 documentation »
    • diff --git a/doc/html/user-libs.html b/doc/html/user-libs.html index 43df5c10..87003663 100644 --- a/doc/html/user-libs.html +++ b/doc/html/user-libs.html @@ -4,7 +4,7 @@ - Documentation of user libs (user functions) — musrfit 1.6.0 documentation + Documentation of user libs (user functions) — musrfit 1.6.1 documentation @@ -30,7 +30,7 @@
  • previous |
    • -
  • musrfit 1.6.0 documentation »
    • +
  • musrfit 1.6.1 documentation »
    • @@ -647,12 +647,12 @@ K(m)&=\int_0^{\pi/2}\frac{\mathrm d\varphi}{\sqrt{1-m^2\sin^2{\varphi}}},\en
  • previous |
    • -
  • musrfit 1.6.0 documentation »
    • +
  • musrfit 1.6.1 documentation »
    • diff --git a/doc/html/user-manual.html b/doc/html/user-manual.html index 989435e4..25bbb801 100644 --- a/doc/html/user-manual.html +++ b/doc/html/user-manual.html @@ -4,7 +4,7 @@ - User manual — musrfit 1.6.0 documentation + User manual — musrfit 1.6.1 documentation @@ -30,7 +30,7 @@
  • previous |
    • -
  • musrfit 1.6.0 documentation »
    • +
  • musrfit 1.6.1 documentation »
    • @@ -897,7 +897,7 @@ instead of specifying the parameters directly.

    The FUNCTIONS Block

    Here some auxiliary functions can be defined. These functions can currently only operate on the defined parameters. They can be used in the -THEORY block and for one specific case in the RUN block. Supported is the use of basic arithmetic:

    +THEORY block and for three specific cases in the RUN block (norm, alpha, and beta). Supported is the use of basic arithmetic:

    \(+\)

    Addition

    @@ -1169,15 +1169,19 @@ a short digression is needed.

    -
    alpha, beta (fit type 2, 3, 5)

    These parameters are used to correct the asymmetry for different detector efficiencies, solid angles and initial asymmetries. They are defined as \(\alpha = N_{0,b}/N_{0,f}\) and \(\beta = A_{0,b}/A_{0,f}\). If the parameters are not specified in the RUN block, for each one the value of 1 is assumed (for fittype 5, alpha is estimated from the ratio of \(\sum_i \left( N_{\mathrm{bp}}(i)+N_{\mathrm{bm}}(i) \right)\) and \(\sum_i \left( N_{\mathrm{fp}}(i)+N_{\mathrm{fm}}(i) \right)\)). Example for alpha with fit parameter number 1:

    +
    alpha, beta (fit type 2, 3, 5)

    These parameters are used to correct the asymmetry for different detector efficiencies, solid angles and initial asymmetries. They are defined as \(\alpha = N_{0,b}/N_{0,f}\) and \(\beta = A_{0,b}/A_{0,f}\). If the parameters are not specified in the RUN block, for each one the value of 1 is assumed (for fittype 5, alpha is estimated from the ratio of \(\sum_i \left( N_{\mathrm{bp}}(i)+N_{\mathrm{bm}}(i) \right)\) and \(\sum_i \left( N_{\mathrm{fp}}(i)+N_{\mathrm{fm}}(i) \right)\)). Both, alpha as well as beta can be expressed through a function. Example for alpha with fit parameter number 1:

    alpha 1
    +

    Example for an alpha defined via function number 1:

    +
    alpha fun1
+
    +
    norm (fit type 0)

    Number of the fit parameter that represents the normalization constant \(N_0\) of the histogram; the value of this parameter is given either per nanosecond or per bin (see below). -It is possible to substitute the parameter number by a function here (and only here in a RUN block), for instance to relate \(N_0\)’s of different histograms through an \(\alpha\) +It is possible to substitute the parameter number by a function, for instance to relate \(N_0\)’s of different histograms through an \(\alpha\) parameter. Example for a norm defined by fit parameter number 12:

    norm 12
    @@ -2429,12 +2433,12 @@ In case this cannot be ensured, the parallelization can be disabled by –di
  • previous |
    • -
  • musrfit 1.6.0 documentation »
    • +
  • musrfit 1.6.1 documentation »