From 4a6885f55b06466b9cdee030c7394ff409ff4f93 Mon Sep 17 00:00:00 2001 From: Andreas Suter Date: Tue, 23 Apr 2024 10:50:11 +0200 Subject: [PATCH] update of the documentation. --- doc/html/.buildinfo | 2 +- doc/html/_static/alert_info_32.png | Bin 1128 -> 0 bytes doc/html/_static/alert_warning_32.png | Bin 944 -> 0 bytes doc/html/_static/bg-page.png | Bin 82 -> 0 bytes doc/html/_static/bullet_orange.png | Bin 165 -> 0 bytes doc/html/_static/documentation_options.js | 2 +- doc/html/_static/haiku.css | 376 ---------------------- doc/html/_static/style.css | 5 + doc/html/acknowledgement.html | 10 +- doc/html/any2many.html | 10 +- doc/html/bugtracking.html | 10 +- doc/html/cite.html | 10 +- doc/html/file-formats.html | 10 +- doc/html/genindex.html | 50 +-- doc/html/index.html | 11 +- doc/html/msr2data.html | 10 +- doc/html/mupp.html | 10 +- doc/html/musr-root.html | 10 +- doc/html/musredit.html | 10 +- doc/html/objects.inv | Bin 2473 -> 2506 bytes doc/html/search.html | 10 +- doc/html/searchindex.js | 2 +- doc/html/setup-dks.html | 10 +- doc/html/setup-standard.html | 36 ++- doc/html/tutorial.html | 10 +- doc/html/user-libs.html | 55 ++-- doc/html/user-manual.html | 10 +- 27 files changed, 171 insertions(+), 498 deletions(-) delete mode 100644 doc/html/_static/alert_info_32.png delete mode 100644 doc/html/_static/alert_warning_32.png delete mode 100644 doc/html/_static/bg-page.png delete mode 100644 doc/html/_static/bullet_orange.png delete mode 100644 doc/html/_static/haiku.css create mode 100644 doc/html/_static/style.css diff --git a/doc/html/.buildinfo b/doc/html/.buildinfo index 3b6b56a0..04bdaa84 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: b18a215470778ea2da02b3cad4d0e07c +config: 28c8d31b3d0d7429fcebb7bd0074bdd3 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/doc/html/_static/alert_info_32.png b/doc/html/_static/alert_info_32.png deleted file mode 100644 index ea4d1baf7001be1d988ca82c2ac4d65803589915..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 1128 zcmV-u1eg1XP)bXT=W25&P)Zz^Neb|z!nwr$(CZQHhO+cV9xXHqYj${6+j$uBp} zd*1&v@rL6gx+gc@yEAOrVS#!kbOhN0QdGb)uN3KiOponP&j0mud1HAyO@vAF($_3_c|3!sUe*@Q5)ms1qbkr)uoE6klqqnOwjuT8Asf)krtm2u^-{tN zkd6cp+i5D^q-{hdXilA^UZx4`CY)IWx)Y|8X90F1$vB$GeOmc>nsQgElX^M$ z^mYV+_JnEfSp^MXN)Sor68_ah#tk~x1Yfoz33MP#SIOte7vZN;AI1`>M3~`(9Thy$ zN7}iUS0rpC0ql_S2;&^{SM0@NV=mDN)ONqs>booND9t6Glq6DYCY(tGAmJNEbdG1f zk#Q_G?jh6FUq)ZLI)rf~0pY7mIOB-ayNCn}sI7!QfUnkd+6HlS8pSYk*CG|m_TU8Hx|1C)g?J58Cxv^8UBD@W0mdrW`hM+|hkPk()VXC&xB zpo4Ukz5)sF{0&&z>bksQ6ivxTGzA~fY2L?P-7~G$jn|BxzlqfPGv5m7znk0th_DApD610$n$VWl(-(WXez*UOH>m(2{SS~) zVGHoNv@uR*W^cWY1xG|t>ksyy%k4ki4Y&W!(o+V>n6L#n;;%Z0B_`Zq$;ojnIwn@@ zfBfv*PwR(Y0nj1j2hb21FQAl^g3rk<|4Kmey8@C*zQ=Pzf9E(B92>{d)8bfcf&!Fy zu7CgakpBD1aKg+ctX_u%u>jUc8!03O-=Ki}g^;1GA4gj|mZ@7sGvCk{w|{s2>K_r; z-Tu2vf5OZooa022vpSCvK7}#W2;iC&d<%IHGRI81?zH93(^h`2|EzBRsjr3fzksj@ zi3AGZoKc8#LB1UXz_$#L>G{6{ssiS!NjH?H@TFk?kr3H-h7!eb+{!7o+pW-TgfrCs^@(i64XXz9@N2l0DCMbB3 zuDH?(40YN}umx=CArHDb4@226Q5o zzCS)ldg`Gm)P=h1|Gz ziRc8~iSyqA+Mqy5a9bcf3gYiV^f_2Qkhbq$COhmVD9r#t7y`;if?A1dD1mH;mNCfK z#{dWjOF(0aeM%m(XmCLr0ECAi)ERI=8Dt5AFXLhZi0Z%v?9@vuV16y->0iY_NCMjR zC`%N40R>=JArt|n{8GFA<;|!Swmq~>=-NV6^l^P8Heqc-d-Uwod!zTT?S`rl1nkZ? zc>l{nT9(U&M@Rz76R>N)63PPQ-tYuG34`7Jx?})^MTpA41)_I8HiT)jVy3$QvgnUq z8UXAj6arEmrN9L?yW@!ww{CmP$DDu57zU3|kjr^9U?sdvSq!H>9tF5CNP%P@51t_3O2Kx{aiK$d5aEwS~Kz~SQQSFNmP9qS8fV2-D?D4~Cor?pcmrf;8 zxyoPfgckxSU^D)nI4~8M1r+{Qz&?Duaw`GYS23URrTTmPV^#wW0rmrC15+ISJ@X%Y zeGZFPK zX)DkTkx66baKe*xwOj%p0?WJk5VayeBer}buoT!6SciYlPr#I*zMlKg!~71im+`Yt Sk$V3C0000gKEEmrS eJg4#epawewOK?KyydX0*kYZ0)KbLh*2~7alO%#{_ diff --git a/doc/html/_static/bullet_orange.png b/doc/html/_static/bullet_orange.png deleted file mode 100644 index 1cb8097ce9b7592811e6ca10397ffe913e62503a..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 165 zcmeAS@N?(olHy`uVBq!ia0vp^Y#_|R1SIpWoc_7Rc)|DFwIFq!ZFK(e?s Q2WT&Yr>mdKI;Vst0IY{fhyVZp diff --git a/doc/html/_static/documentation_options.js b/doc/html/_static/documentation_options.js index 8b1a8bbc..7185641f 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.9.1', + VERSION: '1.9.3', LANGUAGE: 'None', COLLAPSE_INDEX: false, FILE_SUFFIX: '.html', diff --git a/doc/html/_static/haiku.css b/doc/html/_static/haiku.css deleted file mode 100644 index 75af2a5c..00000000 --- a/doc/html/_static/haiku.css +++ /dev/null @@ -1,376 +0,0 @@ -/* - * haiku.css_t - * ~~~~~~~~~~~ - * - * Sphinx stylesheet -- haiku theme. - * - * Adapted from http://haiku-os.org/docs/Haiku-doc.css. - * Original copyright message: - * - * Copyright 2008-2009, Haiku. All rights reserved. - * Distributed under the terms of the MIT License. - * - * Authors: - * Francois Revol - * Stephan Assmus - * Braden Ewing - * Humdinger - * - * :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS. - * :license: BSD, see LICENSE for details. - * - */ - -@import url("basic.css"); - -html { - margin: 0px; - padding: 0px; - background: #FFF url(bg-page.png) top left repeat-x; -} - -body { - line-height: 1.5; - margin: auto; - padding: 0px; - font-family: "DejaVu Sans", Arial, Helvetica, sans-serif; - min-width: 59em; - max-width: 70em; - color: #333333; -} - -div.footer { - padding: 8px; - font-size: 11px; - text-align: center; - letter-spacing: 0.5px; -} - -/* link colors and text decoration */ - -a:link { - font-weight: bold; - text-decoration: none; - color: #dc3c01; -} - -a:visited { - font-weight: bold; - text-decoration: none; - color: #892601; -} - -a:hover, a:active { - text-decoration: underline; - color: #ff4500; -} - -/* Some headers act as anchors, don't give them a hover effect */ - -h1 a:hover, a:active { - text-decoration: none; - color: #0c3762; -} - -h2 a:hover, a:active { - text-decoration: none; - color: #0c3762; -} - -h3 a:hover, a:active { - text-decoration: none; - color: #0c3762; -} - -h4 a:hover, a:active { - text-decoration: none; - color: #0c3762; -} - -a.headerlink { - color: #a7ce38; - padding-left: 5px; -} - -a.headerlink:hover { - color: #a7ce38; -} - -/* basic text elements */ - -div.content { - margin-top: 20px; - margin-left: 40px; - margin-right: 40px; - margin-bottom: 50px; - font-size: 0.9em; -} - -/* heading and navigation */ - -div.header { - position: relative; - left: 0px; - top: 0px; - height: 85px; - /* background: #eeeeee; */ - padding: 0 40px; -} -div.header h1 { - font-size: 1.6em; - font-weight: normal; - letter-spacing: 1px; - color: #0c3762; - border: 0; - margin: 0; - padding-top: 15px; -} -div.header h1 a { - font-weight: normal; - color: #0c3762; -} -div.header h2 { - font-size: 1.3em; - font-weight: normal; - letter-spacing: 1px; - text-transform: uppercase; - color: #aaa; - border: 0; - margin-top: -3px; - padding: 0; -} - -div.header img.rightlogo { - float: right; -} - - -div.title { - font-size: 1.3em; - font-weight: bold; - color: #0c3762; - border-bottom: dotted thin #e0e0e0; - margin-bottom: 25px; -} -div.topnav { - /* background: #e0e0e0; */ -} -div.topnav p { - margin-top: 0; - margin-left: 40px; - margin-right: 40px; - margin-bottom: 0px; - text-align: right; - font-size: 0.8em; -} -div.bottomnav { - background: #eeeeee; -} -div.bottomnav p { - margin-right: 40px; - text-align: right; - font-size: 0.8em; -} - -a.uplink { - font-weight: normal; -} - - -/* contents box */ - -table.index { - margin: 0px 0px 30px 30px; - padding: 1px; - border-width: 1px; - border-style: dotted; - border-color: #e0e0e0; -} -table.index tr.heading { - background-color: #e0e0e0; - text-align: center; - font-weight: bold; - font-size: 1.1em; -} -table.index tr.index { - background-color: #eeeeee; -} -table.index td { - padding: 5px 20px; -} - -table.index a:link, table.index a:visited { - font-weight: normal; - text-decoration: none; - color: #dc3c01; -} -table.index a:hover, table.index a:active { - text-decoration: underline; - color: #ff4500; -} - - -/* Haiku User Guide styles and layout */ - -/* Rounded corner boxes */ -/* Common declarations */ -div.admonition { - -webkit-border-radius: 10px; - -khtml-border-radius: 10px; - -moz-border-radius: 10px; - border-radius: 10px; - border-style: dotted; - border-width: thin; - border-color: #dcdcdc; - padding: 10px 15px 10px 15px; - margin-bottom: 15px; - margin-top: 15px; -} -div.note { - padding: 10px 15px 10px 80px; - background: #e4ffde url(alert_info_32.png) 15px 15px no-repeat; - min-height: 42px; -} -div.warning { - padding: 10px 15px 10px 80px; - background: #fffbc6 url(alert_warning_32.png) 15px 15px no-repeat; - min-height: 42px; -} -div.seealso { - background: #e4ffde; -} - -/* More layout and styles */ -h1 { - font-size: 1.3em; - font-weight: bold; - color: #0c3762; - border-bottom: dotted thin #e0e0e0; - margin-top: 30px; -} - -h2 { - font-size: 1.2em; - font-weight: normal; - color: #0c3762; - border-bottom: dotted thin #e0e0e0; - margin-top: 30px; -} - -h3 { - font-size: 1.1em; - font-weight: normal; - color: #0c3762; - margin-top: 30px; -} - -h4 { - font-size: 1.0em; - font-weight: normal; - color: #0c3762; - margin-top: 30px; -} - -p { - text-align: justify; -} - -p.last { - margin-bottom: 0; -} - -ol { - padding-left: 20px; -} - -ul { - padding-left: 5px; - margin-top: 3px; -} - -li { - line-height: 1.3; -} - -div.content ul > li { - -moz-background-clip:border; - -moz-background-inline-policy:continuous; - -moz-background-origin:padding; - background: transparent url(bullet_orange.png) no-repeat scroll left 0.45em; - list-style-image: none; - list-style-type: none; - padding: 0 0 0 1.666em; - margin-bottom: 3px; -} - -td { - vertical-align: top; -} - -code { - background-color: #e2e2e2; - font-size: 1.0em; - font-family: monospace; -} - -pre { - border-color: #0c3762; - border-style: dotted; - border-width: thin; - margin: 0 0 12px 0; - padding: 0.8em; - background-color: #f0f0f0; -} - -hr { - border-top: 1px solid #ccc; - border-bottom: 0; - border-right: 0; - border-left: 0; - margin-bottom: 10px; - margin-top: 20px; -} - -/* printer only pretty stuff */ -@media print { - .noprint { - display: none; - } - /* for acronyms we want their definitions inlined at print time */ - acronym[title]:after { - font-size: small; - content: " (" attr(title) ")"; - font-style: italic; - } - /* and not have mozilla dotted underline */ - acronym { - border: none; - } - div.topnav, div.bottomnav, div.header, table.index { - display: none; - } - div.content { - margin: 0px; - padding: 0px; - } - html { - background: #FFF; - } -} - -.viewcode-back { - font-family: "DejaVu Sans", Arial, Helvetica, sans-serif; -} - -div.viewcode-block:target { - background-color: #f4debf; - border-top: 1px solid #ac9; - border-bottom: 1px solid #ac9; - margin: -1px -10px; - padding: 0 12px; -} - -/* math display */ -div.math p { - text-align: center; -} \ No newline at end of file diff --git a/doc/html/_static/style.css b/doc/html/_static/style.css new file mode 100644 index 00000000..f868c15f --- /dev/null +++ b/doc/html/_static/style.css @@ -0,0 +1,5 @@ +/* dynamic content width, see https://stackoverflow.com/questions/23211695/modifying-content-width-of-the-sphinx-theme-read-the-docs */ + +.wy-nav-content { + max-width: none; +} diff --git a/doc/html/acknowledgement.html b/doc/html/acknowledgement.html index 826949fa..38c3c2be 100644 --- a/doc/html/acknowledgement.html +++ b/doc/html/acknowledgement.html @@ -8,7 +8,7 @@ - Acknowledgements — musrfit 1.9.1 documentation + Acknowledgements — musrfit 1.9.3 documentation @@ -30,7 +30,9 @@ - + + + @@ -199,7 +201,7 @@ extremely competent way to deal with his projects as well as to deal with the ch

© Copyright 2023, Andreas Suter. - Last updated on Aug 17, 2023. + Last updated on Apr 23, 2024.

@@ -221,7 +223,7 @@ extremely competent way to deal with his projects as well as to deal with the ch @@ -189,7 +191,7 @@ For a detailed description see

© Copyright 2023, Andreas Suter. - Last updated on Aug 17, 2023. + Last updated on Apr 23, 2024.

@@ -211,7 +213,7 @@ For a detailed description see
var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'1.9.1', + VERSION:'1.9.3', LANGUAGE:'None', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', diff --git a/doc/html/bugtracking.html b/doc/html/bugtracking.html index 55dac380..b10b6328 100644 --- a/doc/html/bugtracking.html +++ b/doc/html/bugtracking.html @@ -8,7 +8,7 @@ - Bugtracking — musrfit 1.9.1 documentation + Bugtracking — musrfit 1.9.3 documentation @@ -29,7 +29,9 @@ - + + + @@ -187,7 +189,7 @@ or send an e-mail to A. Suter at PSI.

© Copyright 2023, Andreas Suter. - Last updated on Aug 17, 2023. + Last updated on Apr 23, 2024.

@@ -209,7 +211,7 @@ or send an e-mail to A. Suter at PSI.

@@ -201,7 +203,7 @@

© Copyright 2023, Andreas Suter. - Last updated on Aug 17, 2023. + Last updated on Apr 23, 2024.

@@ -223,7 +225,7 @@ @@ -501,7 +503,7 @@ Between detectors, there will be an empty line.

© Copyright 2023, Andreas Suter. - Last updated on Aug 24, 2023. + Last updated on Apr 23, 2024.

@@ -523,7 +525,7 @@ Between detectors, there will be an empty line.

@@ -243,7 +245,7 @@
  • bnmr-asymmetry-fit
  • -
  • BNMR-libs +
  • BNMR-libs
  • boost-c++
  • @@ -275,7 +277,7 @@
  • db-file-format
  • -
  • DepthProf-lib +
  • DepthProf-lib
  • dks
  • @@ -299,7 +301,7 @@

    E

    @@ -345,6 +347,8 @@

    G

    @@ -373,11 +377,11 @@

    I

    @@ -385,11 +389,11 @@

    L

    @@ -577,7 +581,7 @@
  • non-musr-fit
  • -
  • nonlocal-libs +
  • nonlocal-libs
  • norm
  • @@ -597,15 +601,15 @@
      -
    • PowderLineAxialGss +
    • PowderLineAxialGss
    • -
    • PowderLineAxialLor +
    • PowderLineAxialLor
    • psi-bin-file-format
    • @@ -645,7 +649,7 @@
      • setup
      • -
      • SExpRlx +
      • SExpRlx
      • single-histogram-fit
      • @@ -653,7 +657,7 @@
        • single-histogram-rrf-fit
        • -
        • SLR +
        • SLR
        • supported-operating-systems
        • @@ -749,7 +753,7 @@

          © Copyright 2023, Andreas Suter. - Last updated on Aug 24, 2023. + Last updated on Apr 23, 2024.

          @@ -771,7 +775,7 @@ @@ -182,6 +184,7 @@
        • Documentation of user libs (user functions)
          • Meissner-Profiles / Vortex-Lattice related functions (BMW libs)
          • +
          • Supeconducting Gap-Integrals to calculate \(1/\lambda^2\) vs \(T\)
          • Nonlocal superconductivity related Meissner screening functions (AS libs)
          • Depth resolved information (AS libs)
          • Functions to analyze β-NMR data (BNMR libs)
          • @@ -282,7 +285,7 @@

            © Copyright 2023, Andreas Suter. - Last updated on Aug 24, 2023. + Last updated on Apr 23, 2024.

            @@ -304,7 +307,7 @@ @@ -516,7 +518,7 @@ fit serves as template for the second and so on. The template field stays empty

            © Copyright 2023, Andreas Suter. - Last updated on Aug 17, 2023. + Last updated on Apr 23, 2024.

            @@ -538,7 +540,7 @@ fit serves as template for the second and so on. The template field stays empty @@ -406,7 +408,7 @@ SCRIPT COMMANDS:

            © Copyright 2023, Andreas Suter. - Last updated on Aug 17, 2023. + Last updated on Apr 23, 2024.

            @@ -428,7 +430,7 @@ SCRIPT COMMANDS: @@ -1005,7 +1007,7 @@ the entry has been added. The last token,

            © Copyright 2023, Andreas Suter. - Last updated on Aug 17, 2023. + Last updated on Apr 23, 2024.

            @@ -1027,7 +1029,7 @@ the entry has been added. The last token, var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'1.9.1', + VERSION:'1.9.3', LANGUAGE:'None', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', diff --git a/doc/html/musredit.html b/doc/html/musredit.html index 90729582..30763e1d 100644 --- a/doc/html/musredit.html +++ b/doc/html/musredit.html @@ -8,7 +8,7 @@ - musredit: the GUI Based Interface to musrfit — musrfit 1.9.1 documentation + musredit: the GUI Based Interface to musrfit — musrfit 1.9.3 documentation @@ -30,7 +30,9 @@ - + + + @@ -632,7 +634,7 @@ the corresponding fit parameter value, except the phases where the step will be

            © Copyright 2023, Andreas Suter. - Last updated on Aug 17, 2023. + Last updated on Apr 23, 2024.

            @@ -654,7 +656,7 @@ the corresponding fit parameter value, except the phases where the step will be @@ -183,7 +185,7 @@

            © Copyright 2023, Andreas Suter. - Last updated on Aug 24, 2023. + Last updated on Apr 23, 2024.

            @@ -205,7 +207,7 @@ @@ -406,7 +408,7 @@ The only thing you need

            © Copyright 2023, Andreas Suter. - Last updated on Aug 17, 2023. + Last updated on Apr 23, 2024.

            @@ -428,7 +430,7 @@ The only thing you need var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'1.9.1', + VERSION:'1.9.3', LANGUAGE:'None', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', diff --git a/doc/html/setup-standard.html b/doc/html/setup-standard.html index be5918a4..12b27cd8 100644 --- a/doc/html/setup-standard.html +++ b/doc/html/setup-standard.html @@ -8,7 +8,7 @@ - Setting up musrfit on Different Platforms — musrfit 1.9.1 documentation + Setting up musrfit on Different Platforms — musrfit 1.9.3 documentation @@ -30,7 +30,9 @@ - + + + @@ -404,7 +406,7 @@ $ # now ROOT is ready to be configured. Below you will find the $ # since we are using cmake build now, first we will need to create the build directory. $ mkdir root_build $ cd root_build -$ cmake ../ -Dgminimal=ON -Dasimage=ON -Dmathmore=On -Dminuit2=ON -Dxml=ON -DCMAKE_INSTALL_PREFIX=../root_exec +$ cmake ../ -Dgminimal=1 -Dasimage=1 -Dmathmore=1 -Dxml=1 -DCMAKE_INSTALL_PREFIX=../root_exec $ # next will be the make called via cmake. If running on a multicore CPU you can speed up tremendously by $ # calling it with the option -j <number>, where <number> is the number of threads which you want to give, $ # e.g. cmake --build ./ --clean-first -- -j8 @@ -583,8 +585,8 @@ directories like ..

            Mac OS X / macOS

            Note

            -

            macOS 13 alias Ventura: musrfit is ready for Ventura on Intel and M1 (Apple Silicon) based macs, both running natively. -The DKS version of musrfit for macOS Ventura is ready as well.

            +

            macOS 14 alias Sonoma: musrfit is ready for Sonoma on Intel and Apple Silicon based macs, both running natively. +The DKS version of musrfit for macOS Sonoma is ready as well.

            Note

            @@ -655,10 +657,10 @@ add a new line pointing to your local copy, e.g.

            Then the MacPorts system should be set up and can be used to install additional software.

            The installation of the software mentioned above is then done in the terminal:

            -
            $ sudo port -v install pkgconfig autoconf automake libtool cmake fftw-3 fftw-3-single gsl boost libxml2 qt5 qt5-qtsvg
            +
            $ sudo port -v install pkgconfig autoconf automake libtool cmake fftw-3 fftw-3-single gsl boost libxml2 qt6 qt6-qtsvg
             
            -

            With Qt5, musredit will be installed. If it happens that you used musrgui in the past, +

            With Qt6, musredit will be installed. If it happens that you used musrgui in the past, please change over to musredit since there will be no further development for musrgui anymore!

            Installation of NeXus requirements (optional)

            @@ -720,7 +722,7 @@ $ # now ROOT is ready to be configured. Below you will find the $ # We will use the cmake out-of-source approach here. $ mkdir root_build $ cd root_build -$ cmake ../ -Dgminimal=1 -Dasimage=1 -Dmathmore=1 -Dminuit2=1 -Dxml=1 -Dopengl=1 -Dbuiltin_glew=1 -DCMAKE_INSTALL_PREFIX=$HOME/Applications/root/root_exec +$ cmake ../ -Dgminimal=1 -Dasimage=1 -Dmathmore=1 -Dxml=1 -Dopengl=1 -Dbuiltin_glew=1 -Ddataframe=1 -DCMAKE_INSTALL_PREFIX=$HOME/Applications/root/root_exec $ # next will be the make. If running on a multicore CPU you can speed up tremendously by calling $ # make with the option -j <number>, where <number> is the number of threads which you want to give, $ # e.g. make -j8 @@ -756,11 +758,11 @@ into the file ~/.Ma

            For Mac OS X ≥ 10.8:

            -

            One needs to add some system variables in ~/.profile:

            +

            One needs to add some system variables in ~/.zprofile:

            export ROOTSYS=$HOME/Applications/root/root_exec
             export MUSRFITPATH=$ROOTSYS/bin
             export PATH=$ROOTSYS/bin:$QTDIR/bin:$PATH
            -export DYLD_LIBRARY_PATH=$ROOTSYS/lib:$DYLD_LIBRARY_PATH
            +export DYLD_LIBRARY_PATH=$ROOTSYS/lib:/usr/local/lib:$DYLD_LIBRARY_PATH
             
             launchctl setenv ROOTSYS $ROOTSYS
             launchctl setenv MUSRFITPATH $MUSRFITPATH
            @@ -768,7 +770,7 @@ launchctl setenv PATH $PATH
             launchctl setenv DYLD_LIBRARY_PATH $DYLD_LIBRARY_PATH
             
            -

            After this you will need to “execute” .profile or .zprofile before proceeding:

            +

            After this you will need to “execute” .zprofile or .profile before proceeding:

            $ source $HOME/.profile
             
            @@ -872,7 +874,7 @@ $ # now ROOT is ready to be configured. Below you will find the $ # We will use the cmake out-of-source approach here. $ mkdir root_build $ cd root_build -$ cmake ../ -Dgminimal=1 -Dasimage=1 -Dmathmore=1 -Dminuit2=1 -Dxml=1 -Dopengl=1 -Dbuiltin_glew=1 -DCMAKE_INSTALL_PREFIX=$HOME/Applications/root/root_exec +$ cmake ../ -Dgminimal=1 -Dasimage=1 -Dmathmore=1 -Dxml=1 -Dopengl=1 -Dbuiltin_glew=1 -Ddataframe=1 -DCMAKE_INSTALL_PREFIX=$HOME/Applications/root/root_exec $ # next will be the make. If running on a multicore CPU you can speed up tremendously by calling $ # make with the option -j <number>, where <number> is the number of threads which you want to give, $ # e.g. make -j8 @@ -908,12 +910,12 @@ into the file ~/.Ma

            For Mac OS X ≥ 10.8:

            -

            One needs to add some system variables in ~/.profile:

            +

            One needs to add some system variables in ~/.zprofile:

            If ROOT has been installed via Homebrew:

            export ROOTSYS=/usr/local
             export MUSRFITPATH=$ROOTSYS/bin
             export PATH=$ROOTSYS/bin:$QTDIR/bin:$PATH
            -export DYLD_LIBRARY_PATH=$ROOTSYS/lib/root:$DYLD_LIBRARY_PATH
            +export DYLD_LIBRARY_PATH=$ROOTSYS/lib/root:/usr/local/lib:$DYLD_LIBRARY_PATH
             
             launchctl setenv ROOTSYS $ROOTSYS
             launchctl setenv MUSRFITPATH $MUSRFITPATH
            @@ -925,7 +927,7 @@ launchctl setenv DYLD_LIBRARY_PATH $DYLD_LIBRARY_PATH
             
            export ROOTSYS=$HOME/Applications/root/root_exec
             export MUSRFITPATH=$ROOTSYS/bin
             export PATH=$ROOTSYS/bin:$QTDIR/bin:$PATH
            -export LD_LIBRARY_PATH=$ROOTSYS/lib:$LD_LIBRARY_PATH
            +export LD_LIBRARY_PATH=$ROOTSYS/lib:/usr/local/lib:$LD_LIBRARY_PATH
             
             launchctl setenv ROOTSYS $ROOTSYS
             launchctl setenv MUSRFITPATH $MUSRFITPATH
            @@ -1093,7 +1095,7 @@ $ musrview test-histo-ROOT-NPP.msr
               

            © Copyright 2023, Andreas Suter. - Last updated on Aug 17, 2023. + Last updated on Apr 23, 2024.

            @@ -1115,7 +1117,7 @@ $ musrview test-histo-ROOT-NPP.msr @@ -525,7 +527,7 @@ For a complete description please refer to the manuals of

            © Copyright 2023, Andreas Suter. - Last updated on Aug 17, 2023. + Last updated on Apr 23, 2024.

            @@ -547,7 +549,7 @@ For a complete description please refer to the manuals of var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', - VERSION:'1.9.1', + VERSION:'1.9.3', LANGUAGE:'None', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', diff --git a/doc/html/user-libs.html b/doc/html/user-libs.html index aa66177e..f692724a 100644 --- a/doc/html/user-libs.html +++ b/doc/html/user-libs.html @@ -8,7 +8,7 @@ - Documentation of user libs (user functions) — musrfit 1.9.1 documentation + Documentation of user libs (user functions) — musrfit 1.9.3 documentation @@ -30,7 +30,9 @@ - + + + @@ -98,6 +100,7 @@
        • +
        • Supeconducting Gap-Integrals to calculate \(1/\lambda^2\) vs \(T\)
        • Nonlocal superconductivity related Meissner screening functions (AS libs)
        • Depth resolved information (AS libs)
        • Functions to analyze β-NMR data (BNMR libs)
            @@ -503,8 +506,14 @@ The expected name of the +
            +

            Supeconducting Gap-Integrals to calculate \(1/\lambda^2\) vs \(T\)

            +

            The details about the various superconducting gap-integrals are found in the +pdf-file GapIntegrals.pdf which can be found in the musrfit source under +<musrfit-dir>/src/external/libGapIntegrals/.

            +
            -

            Functions to analyze β-NMR data (BNMR libs)

            +

            Functions to analyze β-NMR data (BNMR libs)

            This is a collection of C++ classes using the musrfit user-functions interface in order to facilitate the usage in conjunction with musrfit. It consists of two libraries:

              @@ -629,11 +638,11 @@ interface in order to facilitate the usage in conjunction with Currently it is recommended to read in the data in ASCII format as a non-μSR fit (fit type 8).

            -

            libBNMR

            +

            libBNMR

            In β-NMR the SLR is usually measured by implanting a pulse of \(^8\)Li with a length \(t_0\) into the sample. The asymmetry is measured both during the pulse and afterwards. For a a general spin relaxation function \(f(t)\) the time evolution of the asymmetry is then given by [Z. Salman, et al., PRL 96, 147601 (2006)]:

            -\[\begin{split}P(t) = \left\{\begin{matrix} +\[\begin{split}P(t) = \left\{\begin{matrix} \frac{\int_0^t e^{-(t-t')/\tau_{\mathrm{Li}}}f(t-t')dt'}{\int_0^t e^{-t'/\tau_{\mathrm{Li}}}dt' } & t\leq t_0\\[6pt] \frac{\int_0^{t_0}e^{-(t_0-t')/\tau_{\mathrm{Li}}}f(t-t')dt'}{\int_0^{t_0}e^{-t'/\tau_{\mathrm{Li}}}dt'} & t> t_0, \end{matrix}\right.\end{split}\]
            @@ -641,7 +650,7 @@ The asymmetry is measured both during the pulse and afterwards. For a a general

            Functions

            The libBNMR library currently contains the following functions:

            -

            Exponential relaxation

            +

            Exponential relaxation

            userFcn libBNMR ExpRlx 1 2
             
            @@ -651,7 +660,7 @@ The asymmetry is measured both during the pulse and afterwards. For a a general
          • relaxation rate \(\lambda\) (s\(^{-1}\))
          • This function implements \(f(t)=e^{-\lambda t}\).

            -

            Stretched exponential relaxation

            +

            Stretched exponential relaxation

            userFcn libBNMR SExpRlx 1 2 3
             
            @@ -665,19 +674,19 @@ The asymmetry is measured both during the pulse and afterwards. For a a general
            -

            libLineProfile

            +

            libLineProfile

            In addition to some simple line shapes libLineProfile contains functions to fit chemical shift anisotropies in the powder average. Their functional form can be found in M. Mehring, Principles of High Resolution NMR in Solids (Springer 1983).

            For an axially symmetric interaction it is given by:

            -\[\begin{split}I_{\mathrm ax}(f)=\left\{\begin{matrix} \frac{1}{2\sqrt{(f_\parallel-f_\perp)(f-f_\perp)}}& f\in(f_\perp,f_\parallel)\cup(f_\parallel,f_\perp)\\[6pt] 0 & \text{otherwise}\end{matrix} \right.\end{split}\]
            +\[\begin{split}I_{\mathrm ax}(f)=\left\{\begin{matrix} \frac{1}{2\sqrt{(f_\parallel-f_\perp)(f-f_\perp)}}& f\in(f_\perp,f_\parallel)\cup(f_\parallel,f_\perp)\\[6pt] 0 & \text{otherwise}\end{matrix} \right.\end{split}\]

            where \(f_\parallel\) and \(f_\perp\) are the frequencies that would be observed if the field is oriented paralell or perpendicular to the symmetry axis, respectively.

            In case of a completely anisotropic interaction, the powder average can be described by the frequencies along the three principle axis \(f_1,f_2,f_3\).
            Assume without loss of generality that \(f_1<f_2<f_3\), then
            -\[\begin{split}I(f)&=\left\{\begin{matrix} +\[\begin{split}I(f)&=\left\{\begin{matrix} \frac{K(m)}{\pi\sqrt{(f-f_1)(f_3-f_2)}},& f_3\geq f>f_2 \\[9pt] \frac{K(m)}{\pi\sqrt{(f_3-f)(f_2-f_1)}},& f_2>f\geq f_1\\[9pt] 0 & \text{otherwise} @@ -693,7 +702,7 @@ K(m)&=\int_0^{\pi/2}\frac{\mathrm d\varphi}{\sqrt{1-m^2\sin^2{\varphi}}},\en

            Functions

            The libLineProfile library currently contains the following functions:

            -

            Gaussian

            +

            Gaussian

            userFcn  libLineProfile LineGauss 1 2
             
            @@ -708,7 +717,7 @@ K(m)&=\int_0^{\pi/2}\frac{\mathrm d\varphi}{\sqrt{1-m^2\sin^2{\varphi}}},\en
            \[A(f)=e^{-\frac{4\ln 2 (f-f_0)^2}{ \sigma^2}}\]
            -

            Lorentzian

            +

            Lorentzian

            userFcn  libLineProfile LineLorentzian 1 2
             
            @@ -723,7 +732,7 @@ K(m)&=\int_0^{\pi/2}\frac{\mathrm d\varphi}{\sqrt{1-m^2\sin^2{\varphi}}},\en
            \[A(f)= \frac{w^2}{4(f-f_0)^2+w^2}\]
            -

            Laplacian

            +

            Laplacian

            userFcn  libLineProfile LineLaplace 1 2
             
            @@ -738,7 +747,7 @@ K(m)&=\int_0^{\pi/2}\frac{\mathrm d\varphi}{\sqrt{1-m^2\sin^2{\varphi}}},\en
            \[A(f)=e^{-2\ln 2 \left|\frac{f-f_0}{w}\right|}\]
            -

            Skewed Lorentzian

            +

            Skewed Lorentzian

            userFcn  libLineProfile LineSkewLorentzian 1 2 3
             
            @@ -754,7 +763,7 @@ K(m)&=\int_0^{\pi/2}\frac{\mathrm d\varphi}{\sqrt{1-m^2\sin^2{\varphi}}},\en
            \[A(f)= \frac{w w_a}{4(f-f_0)^2+w_a^2}, \quad w_a=\frac{2w}{1+e^{a(f-f_0)}}\]
            -

            Skewed Lorentzian 2

            +

            Skewed Lorentzian 2

            userFcn  libLineProfile LineSkewLorentzian2 1 2 3
             
            @@ -770,7 +779,7 @@ K(m)&=\int_0^{\pi/2}\frac{\mathrm d\varphi}{\sqrt{1-m^2\sin^2{\varphi}}},\en
            \[\begin{split}A(f)= \left\{\begin{matrix}\frac{{w_1}^2}{4{(f-f_0)}^2+{w_1}^2},&f\leq f_0\\[9pt] \frac{{w_2}^2}{4{(f-f_0)}^2+{w_2}^2},&f>f_0\end{matrix}\right.\end{split}\]
            -

            Powder average of an axially symmetric interaction convoluted with a Lorentzian

            +

            Powder average of an axially symmetric interaction convoluted with a Lorentzian

            userFcn  libLineProfile PowderLineAxialLor 1 2 3
             
            @@ -787,7 +796,7 @@ K(m)&=\int_0^{\pi/2}\frac{\mathrm d\varphi}{\sqrt{1-m^2\sin^2{\varphi}}},\en
            \[A(f)= I_{\mathrm ax}(f)\circledast\left( \frac{w^2}{4f^2+w^2} \right)\]

            with \(I_{\mathrm ax}(f)\) defined above.

            -

            Powder average of an axially symmetric interaction convoluted with a Gaussian

            +

            Powder average of an axially symmetric interaction convoluted with a Gaussian

            userFcn  libLineProfile PowderLineAxialGss 1 2 3
             
            @@ -804,7 +813,7 @@ K(m)&=\int_0^{\pi/2}\frac{\mathrm d\varphi}{\sqrt{1-m^2\sin^2{\varphi}}},\en
            \[A(f)= I_{\mathrm ax}(f)\circledast\left( e^{-\frac{4\ln 2 (f-f_0)^2}{ \sigma^2}} \right)\]

            with \(I_{\mathrm ax}(f)\) defined above.

            -

            Powder average of an anisotropic interaction convoluted with a Lorentzian

            +

            Powder average of an anisotropic interaction convoluted with a Lorentzian

            userFcn  libLineProfile PowderLineAsymLor 1 2 3 4
             
            @@ -822,7 +831,7 @@ K(m)&=\int_0^{\pi/2}\frac{\mathrm d\varphi}{\sqrt{1-m^2\sin^2{\varphi}}},\en
            \[A(f)= I(f)\circledast\left( \frac{w^2}{4f^2+w^2} \right)\]

            with \(I(f)\) defined above. Note that \(f_1<f_2<f_3\) is not required by the code.

            -

            Powder average of an anisotropic interaction convoluted with a Gaussian

            +

            Powder average of an anisotropic interaction convoluted with a Gaussian

            userFcn  libLineProfile PowderLineAsymGss 1 2 3 4
             
            @@ -866,7 +875,7 @@ K(m)&=\int_0^{\pi/2}\frac{\mathrm d\varphi}{\sqrt{1-m^2\sin^2{\varphi}}},\en

            © Copyright 2023, Andreas Suter. - Last updated on Aug 17, 2023. + Last updated on Apr 23, 2024.

            @@ -888,7 +897,7 @@ K(m)&=\int_0^{\pi/2}\frac{\mathrm d\varphi}{\sqrt{1-m^2\sin^2{\varphi}}},\en @@ -2872,7 +2874,7 @@ The syntax here is attribute driven

            © Copyright 2023, Andreas Suter. - Last updated on Aug 17, 2023. + Last updated on Apr 23, 2024.

            @@ -2894,7 +2896,7 @@ The syntax here is attribute driven