LMU/musrfit
LMU/musrfit
5
0
Fork 0
Code Issues 6 Pull Requests Actions Packages Projects Releases 3 Activity

updated docu.

Browse Source
This commit is contained in:
suter_a 2023-02-17 15:09:35 +01:00
parent abe47395cd
commit da6eea271d
21 changed files with 285 additions and 107 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/html/.buildinfo
View File

@ -1,4 +1,4 @@
# Sphinx build info version 1 # 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. # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 429dcaf60d751fc64b55c07d7174ea6f config: ea8ddbeaec87fd554dad49f5d0917959
tags: 645f666f9bcd5a90fca523b33c5a78b7 tags: 645f666f9bcd5a90fca523b33c5a78b7

1
doc/html/_static/css/theme.css
View File

File diff suppressed because one or more lines are too long

2
doc/html/_static/documentation_options.js
View File

@ -1,6 +1,6 @@
var DOCUMENTATION_OPTIONS = { var DOCUMENTATION_OPTIONS = {
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
VERSION: '1.8.2', VERSION: '1.9.0',
LANGUAGE: 'None', LANGUAGE: 'None',
COLLAPSE_INDEX: false, COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html', FILE_SUFFIX: '.html',

12
doc/html/acknowledgement.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Acknowledgements &mdash; musrfit 1.8.2 documentation</title> <title>Acknowledgements &mdash; musrfit 1.9.0 documentation</title>
@ -58,6 +58,10 @@
<div class="version">
1.9
</div>
@ -193,8 +197,8 @@ extremely competent way to deal with his projects as well as to deal with the ch
<div role="contentinfo"> <div role="contentinfo">
<p> <p>
&copy; Copyright 2022, Andreas Suter. &copy; Copyright 2023, Andreas Suter.
Last updated on Dec 12, 2022. Last updated on Feb 17, 2023.
</p> </p>
</div> </div>
@ -216,7 +220,7 @@ extremely competent way to deal with his projects as well as to deal with the ch
<script type="text/javascript"> <script type="text/javascript">
var DOCUMENTATION_OPTIONS = { var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./', URL_ROOT:'./',
VERSION:'1.8.2', VERSION:'1.9.0',
LANGUAGE:'None', LANGUAGE:'None',
COLLAPSE_INDEX:false, COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html', FILE_SUFFIX:'.html',

12
doc/html/any2many.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>any2many - a Universal μSR-file-format converter &mdash; musrfit 1.8.2 documentation</title> <title>any2many - a Universal μSR-file-format converter &mdash; musrfit 1.9.0 documentation</title>
@ -58,6 +58,10 @@
<div class="version">
1.9
</div>
@ -183,8 +187,8 @@ For a detailed description see <a class="reference internal" href="user-manual.h
<div role="contentinfo"> <div role="contentinfo">
<p> <p>
&copy; Copyright 2022, Andreas Suter. &copy; Copyright 2023, Andreas Suter.
Last updated on Dec 12, 2022. Last updated on Feb 17, 2023.
</p> </p>
</div> </div>
@ -206,7 +210,7 @@ For a detailed description see <a class="reference internal" href="user-manual.h
<script type="text/javascript"> <script type="text/javascript">
var DOCUMENTATION_OPTIONS = { var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./', URL_ROOT:'./',
VERSION:'1.8.2', VERSION:'1.9.0',
LANGUAGE:'None', LANGUAGE:'None',
COLLAPSE_INDEX:false, COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html', FILE_SUFFIX:'.html',

12
doc/html/bugtracking.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Bugtracking &mdash; musrfit 1.8.2 documentation</title> <title>Bugtracking &mdash; musrfit 1.9.0 documentation</title>
@ -57,6 +57,10 @@
<div class="version">
1.9
</div>
@ -181,8 +185,8 @@ or send an e-mail to A. Suter at PSI.</p>
<div role="contentinfo"> <div role="contentinfo">
<p> <p>
&copy; Copyright 2022, Andreas Suter. &copy; Copyright 2023, Andreas Suter.
Last updated on Dec 12, 2022. Last updated on Feb 17, 2023.
</p> </p>
</div> </div>
@ -204,7 +208,7 @@ or send an e-mail to A. Suter at PSI.</p>
<script type="text/javascript"> <script type="text/javascript">
var DOCUMENTATION_OPTIONS = { var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./', URL_ROOT:'./',
VERSION:'1.8.2', VERSION:'1.9.0',
LANGUAGE:'None', LANGUAGE:'None',
COLLAPSE_INDEX:false, COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html', FILE_SUFFIX:'.html',

12
doc/html/cite.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>How to Cite musrfit? &mdash; musrfit 1.8.2 documentation</title> <title>How to Cite musrfit? &mdash; musrfit 1.9.0 documentation</title>
@ -58,6 +58,10 @@
<div class="version">
1.9
</div>
@ -195,8 +199,8 @@
<div role="contentinfo"> <div role="contentinfo">
<p> <p>
&copy; Copyright 2022, Andreas Suter. &copy; Copyright 2023, Andreas Suter.
Last updated on Dec 12, 2022. Last updated on Feb 17, 2023.
</p> </p>
</div> </div>
@ -218,7 +222,7 @@
<script type="text/javascript"> <script type="text/javascript">
var DOCUMENTATION_OPTIONS = { var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./', URL_ROOT:'./',
VERSION:'1.8.2', VERSION:'1.9.0',
LANGUAGE:'None', LANGUAGE:'None',
COLLAPSE_INDEX:false, COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html', FILE_SUFFIX:'.html',

54
doc/html/genindex.html
View File

@ -9,7 +9,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Index &mdash; musrfit 1.8.2 documentation</title> <title>Index &mdash; musrfit 1.9.0 documentation</title>
@ -57,6 +57,10 @@
<div class="version">
1.9
</div>
@ -235,7 +239,7 @@
</li> </li>
<li><a href="user-manual.html#index-74">bnmr-asymmetry-fit</a> <li><a href="user-manual.html#index-74">bnmr-asymmetry-fit</a>
</li> </li>
<li><a href="user-libs.html#index-14">BNMR-libs</a> <li><a href="user-libs.html#index-16">BNMR-libs</a>
</li> </li>
<li><a href="setup-standard.html#index-2">boost-c++</a> <li><a href="setup-standard.html#index-2">boost-c++</a>
</li> </li>
@ -262,6 +266,8 @@
<li><a href="user-manual.html#index-33">data-asymmetry</a> <li><a href="user-manual.html#index-33">data-asymmetry</a>
</li> </li>
<li><a href="user-manual.html#index-32">data-single-histo</a> <li><a href="user-manual.html#index-32">data-single-histo</a>
</li>
<li><a href="user-libs.html#index-15">DepthProf-lib</a>
</li> </li>
<li><a href="setup-dks.html#index-0">dks</a> <li><a href="setup-dks.html#index-0">dks</a>
</li> </li>
@ -285,7 +291,7 @@
<h2 id="E">E</h2> <h2 id="E">E</h2>
<table style="width: 100%" class="indextable genindextable"><tr> <table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul> <td style="width: 33%; vertical-align: top;"><ul>
<li><a href="user-libs.html#index-17">ExpRlx</a> <li><a href="user-libs.html#index-19">ExpRlx</a>
</li> </li>
</ul></td> </ul></td>
</tr></table> </tr></table>
@ -357,11 +363,11 @@
<h2 id="I">I</h2> <h2 id="I">I</h2>
<table style="width: 100%" class="indextable genindextable"><tr> <table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul> <td style="width: 33%; vertical-align: top;"><ul>
<li><a href="user-libs.html#index-21">Ianiso</a> <li><a href="user-libs.html#index-23">Ianiso</a>
</li> </li>
</ul></td> </ul></td>
<td style="width: 33%; vertical-align: top;"><ul> <td style="width: 33%; vertical-align: top;"><ul>
<li><a href="user-libs.html#index-20">Iax</a> <li><a href="user-libs.html#index-22">Iax</a>
</li> </li>
</ul></td> </ul></td>
</tr></table> </tr></table>
@ -369,11 +375,11 @@
<h2 id="L">L</h2> <h2 id="L">L</h2>
<table style="width: 100%" class="indextable genindextable"><tr> <table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul> <td style="width: 33%; vertical-align: top;"><ul>
<li><a href="user-libs.html#index-15">libBNMR</a> <li><a href="user-libs.html#index-17">libBNMR</a>
</li> </li>
<li><a href="user-libs.html#index-2">libFitPofB</a> <li><a href="user-libs.html#index-2">libFitPofB</a>
</li> </li>
<li><a href="user-libs.html#index-19">libLineProfile</a> <li><a href="user-libs.html#index-21">libLineProfile</a>
</li> </li>
<li><a href="setup-standard.html#index-6">libxml2</a> <li><a href="setup-standard.html#index-6">libxml2</a>
</li> </li>
@ -381,15 +387,15 @@
</li> </li>
</ul></td> </ul></td>
<td style="width: 33%; vertical-align: top;"><ul> <td style="width: 33%; vertical-align: top;"><ul>
<li><a href="user-libs.html#index-22">LineGauss</a> <li><a href="user-libs.html#index-24">LineGauss</a>
</li> </li>
<li><a href="user-libs.html#index-24">LineLaplace</a> <li><a href="user-libs.html#index-26">LineLaplace</a>
</li> </li>
<li><a href="user-libs.html#index-23">LineLorentzian</a> <li><a href="user-libs.html#index-25">LineLorentzian</a>
</li> </li>
<li><a href="user-libs.html#index-25">LineSkewLorentzian</a> <li><a href="user-libs.html#index-27">LineSkewLorentzian</a>
</li> </li>
<li><a href="user-libs.html#index-26">LineSkewLorentzian2</a> <li><a href="user-libs.html#index-28">LineSkewLorentzian2</a>
</li> </li>
</ul></td> </ul></td>
</tr></table> </tr></table>
@ -547,13 +553,15 @@
</li> </li>
<li><a href="setup-standard.html#index-25">nexus-build-homebrew</a> <li><a href="setup-standard.html#index-25">nexus-build-homebrew</a>
</li> </li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="setup-standard.html#index-15">nexus-build-linux</a> <li><a href="setup-standard.html#index-15">nexus-build-linux</a>
</li> </li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="setup-standard.html#index-22">nexus-build-macports</a> <li><a href="setup-standard.html#index-22">nexus-build-macports</a>
</li> </li>
<li><a href="user-manual.html#index-75">non-musr-fit</a> <li><a href="user-manual.html#index-75">non-musr-fit</a>
</li>
<li><a href="user-libs.html#index-14">nonlocal-libs</a>
</li> </li>
<li><a href="user-manual.html#index-23">norm</a> <li><a href="user-manual.html#index-23">norm</a>
</li> </li>
@ -573,15 +581,15 @@
<td style="width: 33%; vertical-align: top;"><ul> <td style="width: 33%; vertical-align: top;"><ul>
<li><a href="user-manual.html#index-40">packing</a> <li><a href="user-manual.html#index-40">packing</a>
</li> </li>
<li><a href="user-libs.html#index-30">PowderLineAsymGss</a> <li><a href="user-libs.html#index-32">PowderLineAsymGss</a>
</li> </li>
</ul></td> </ul></td>
<td style="width: 33%; vertical-align: top;"><ul> <td style="width: 33%; vertical-align: top;"><ul>
<li><a href="user-libs.html#index-29">PowderLineAsymLor</a> <li><a href="user-libs.html#index-31">PowderLineAsymLor</a>
</li> </li>
<li><a href="user-libs.html#index-28">PowderLineAxialGss</a> <li><a href="user-libs.html#index-30">PowderLineAxialGss</a>
</li> </li>
<li><a href="user-libs.html#index-27">PowderLineAxialLor</a> <li><a href="user-libs.html#index-29">PowderLineAxialLor</a>
</li> </li>
</ul></td> </ul></td>
</tr></table> </tr></table>
@ -617,7 +625,7 @@
<td style="width: 33%; vertical-align: top;"><ul> <td style="width: 33%; vertical-align: top;"><ul>
<li><a href="setup-standard.html#index-0">setup</a> <li><a href="setup-standard.html#index-0">setup</a>
</li> </li>
<li><a href="user-libs.html#index-18">SExpRlx</a> <li><a href="user-libs.html#index-20">SExpRlx</a>
</li> </li>
<li><a href="user-manual.html#index-69">single-histogram-fit</a> <li><a href="user-manual.html#index-69">single-histogram-fit</a>
</li> </li>
@ -625,7 +633,7 @@
<td style="width: 33%; vertical-align: top;"><ul> <td style="width: 33%; vertical-align: top;"><ul>
<li><a href="user-manual.html#index-70">single-histogram-rrf-fit</a> <li><a href="user-manual.html#index-70">single-histogram-rrf-fit</a>
</li> </li>
<li><a href="user-libs.html#index-16">SLR</a> <li><a href="user-libs.html#index-18">SLR</a>
</li> </li>
<li><a href="setup-standard.html#index-1">supported-operating-systems</a> <li><a href="setup-standard.html#index-1">supported-operating-systems</a>
</li> </li>
@ -712,8 +720,8 @@
<div role="contentinfo"> <div role="contentinfo">
<p> <p>
&copy; Copyright 2022, Andreas Suter. &copy; Copyright 2023, Andreas Suter.
Last updated on Dec 12, 2022. Last updated on Feb 17, 2023.
</p> </p>
</div> </div>
@ -735,7 +743,7 @@
<script type="text/javascript"> <script type="text/javascript">
var DOCUMENTATION_OPTIONS = { var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./', URL_ROOT:'./',
VERSION:'1.8.2', VERSION:'1.9.0',
LANGUAGE:'None', LANGUAGE:'None',
COLLAPSE_INDEX:false, COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html', FILE_SUFFIX:'.html',

13
doc/html/index.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Welcome to the musrfit documentation! &mdash; musrfit 1.8.2 documentation</title> <title>Welcome to the musrfit documentation! &mdash; musrfit 1.9.0 documentation</title>
@ -57,6 +57,10 @@
<div class="version">
1.9
</div>
@ -178,6 +182,7 @@
<li class="toctree-l1"><a class="reference internal" href="user-libs.html">Documentation of user libs (user functions)</a><ul> <li class="toctree-l1"><a class="reference internal" href="user-libs.html">Documentation of user libs (user functions)</a><ul>
<li class="toctree-l2"><a class="reference internal" href="user-libs.html#meissner-profiles-vortex-lattice-related-functions-bmw-libs">Meissner-Profiles / Vortex-Lattice related functions (BMW libs)</a></li> <li class="toctree-l2"><a class="reference internal" href="user-libs.html#meissner-profiles-vortex-lattice-related-functions-bmw-libs">Meissner-Profiles / Vortex-Lattice related functions (BMW libs)</a></li>
<li class="toctree-l2"><a class="reference internal" href="user-libs.html#nonlocal-superconductivity-related-meissner-screening-functions-as-libs">Nonlocal superconductivity related Meissner screening functions (AS libs)</a></li> <li class="toctree-l2"><a class="reference internal" href="user-libs.html#nonlocal-superconductivity-related-meissner-screening-functions-as-libs">Nonlocal superconductivity related Meissner screening functions (AS libs)</a></li>
<li class="toctree-l2"><a class="reference internal" href="user-libs.html#depth-resolved-information-as-libs">Depth resolved information (AS libs)</a></li>
<li class="toctree-l2"><a class="reference internal" href="user-libs.html#functions-to-analyze-bgr-nmr-data-bnmr-libs">Functions to analyze β-NMR data (BNMR libs)</a></li> <li class="toctree-l2"><a class="reference internal" href="user-libs.html#functions-to-analyze-bgr-nmr-data-bnmr-libs">Functions to analyze β-NMR data (BNMR libs)</a></li>
</ul> </ul>
</li> </li>
@ -262,8 +267,8 @@
<div role="contentinfo"> <div role="contentinfo">
<p> <p>
&copy; Copyright 2022, Andreas Suter. &copy; Copyright 2023, Andreas Suter.
Last updated on Dec 12, 2022. Last updated on Feb 17, 2023.
</p> </p>
</div> </div>
@ -285,7 +290,7 @@
<script type="text/javascript"> <script type="text/javascript">
var DOCUMENTATION_OPTIONS = { var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./', URL_ROOT:'./',
VERSION:'1.8.2', VERSION:'1.9.0',
LANGUAGE:'None', LANGUAGE:'None',
COLLAPSE_INDEX:false, COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html', FILE_SUFFIX:'.html',

12
doc/html/msr2data.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>msr2data - A Program for Automatically Processing Multiple musrfit msr Files &mdash; musrfit 1.8.2 documentation</title> <title>msr2data - A Program for Automatically Processing Multiple musrfit msr Files &mdash; musrfit 1.9.0 documentation</title>
@ -58,6 +58,10 @@
<div class="version">
1.9
</div>
@ -510,8 +514,8 @@ fit serves as template for the second and so on. The template field stays empty
<div role="contentinfo"> <div role="contentinfo">
<p> <p>
&copy; Copyright 2022, Andreas Suter. &copy; Copyright 2023, Andreas Suter.
Last updated on Dec 12, 2022. Last updated on Feb 17, 2023.
</p> </p>
</div> </div>
@ -533,7 +537,7 @@ fit serves as template for the second and so on. The template field stays empty
<script type="text/javascript"> <script type="text/javascript">
var DOCUMENTATION_OPTIONS = { var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./', URL_ROOT:'./',
VERSION:'1.8.2', VERSION:'1.9.0',
LANGUAGE:'None', LANGUAGE:'None',
COLLAPSE_INDEX:false, COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html', FILE_SUFFIX:'.html',

12
doc/html/mupp.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>mupp - μSR Parameter Plotter &mdash; musrfit 1.8.2 documentation</title> <title>mupp - μSR Parameter Plotter &mdash; musrfit 1.9.0 documentation</title>
@ -58,6 +58,10 @@
<div class="version">
1.9
</div>
@ -400,8 +404,8 @@ SCRIPT COMMANDS:
<div role="contentinfo"> <div role="contentinfo">
<p> <p>
&copy; Copyright 2022, Andreas Suter. &copy; Copyright 2023, Andreas Suter.
Last updated on Dec 12, 2022. Last updated on Feb 17, 2023.
</p> </p>
</div> </div>
@ -423,7 +427,7 @@ SCRIPT COMMANDS:
<script type="text/javascript"> <script type="text/javascript">
var DOCUMENTATION_OPTIONS = { var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./', URL_ROOT:'./',
VERSION:'1.8.2', VERSION:'1.9.0',
LANGUAGE:'None', LANGUAGE:'None',
COLLAPSE_INDEX:false, COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html', FILE_SUFFIX:'.html',

12
doc/html/musr-root.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>MusrRoot - an Extensible Open File Format for μSR &mdash; musrfit 1.8.2 documentation</title> <title>MusrRoot - an Extensible Open File Format for μSR &mdash; musrfit 1.9.0 documentation</title>
@ -58,6 +58,10 @@
<div class="version">
1.9
</div>
@ -999,8 +1003,8 @@ the entry has been added. The last token, <code class="docutils literal notransl
<div role="contentinfo"> <div role="contentinfo">
<p> <p>
&copy; Copyright 2022, Andreas Suter. &copy; Copyright 2023, Andreas Suter.
Last updated on Dec 12, 2022. Last updated on Feb 17, 2023.
</p> </p>
</div> </div>
@ -1022,7 +1026,7 @@ the entry has been added. The last token, <code class="docutils literal notransl
<script type="text/javascript"> <script type="text/javascript">
var DOCUMENTATION_OPTIONS = { var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./', URL_ROOT:'./',
VERSION:'1.8.2', VERSION:'1.9.0',
LANGUAGE:'None', LANGUAGE:'None',
COLLAPSE_INDEX:false, COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html', FILE_SUFFIX:'.html',

12
doc/html/musredit.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>musredit: the GUI Based Interface to musrfit &mdash; musrfit 1.8.2 documentation</title> <title>musredit: the GUI Based Interface to musrfit &mdash; musrfit 1.9.0 documentation</title>
@ -58,6 +58,10 @@
<div class="version">
1.9
</div>
@ -626,8 +630,8 @@ the corresponding fit parameter value, except the phases where the step will be
<div role="contentinfo"> <div role="contentinfo">
<p> <p>
&copy; Copyright 2022, Andreas Suter. &copy; Copyright 2023, Andreas Suter.
Last updated on Dec 12, 2022. Last updated on Feb 17, 2023.
</p> </p>
</div> </div>
@ -649,7 +653,7 @@ the corresponding fit parameter value, except the phases where the step will be
<script type="text/javascript"> <script type="text/javascript">
var DOCUMENTATION_OPTIONS = { var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./', URL_ROOT:'./',
VERSION:'1.8.2', VERSION:'1.9.0',
LANGUAGE:'None', LANGUAGE:'None',
COLLAPSE_INDEX:false, COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html', FILE_SUFFIX:'.html',

BIN
doc/html/objects.inv
View File

Binary file not shown.

12
doc/html/search.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Search &mdash; musrfit 1.8.2 documentation</title> <title>Search &mdash; musrfit 1.9.0 documentation</title>
@ -56,6 +56,10 @@
<div class="version">
1.9
</div>
@ -177,8 +181,8 @@
<div role="contentinfo"> <div role="contentinfo">
<p> <p>
&copy; Copyright 2022, Andreas Suter. &copy; Copyright 2023, Andreas Suter.
Last updated on Dec 12, 2022. Last updated on Feb 17, 2023.
</p> </p>
</div> </div>
@ -200,7 +204,7 @@
<script type="text/javascript"> <script type="text/javascript">
var DOCUMENTATION_OPTIONS = { var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./', URL_ROOT:'./',
VERSION:'1.8.2', VERSION:'1.9.0',
LANGUAGE:'None', LANGUAGE:'None',
COLLAPSE_INDEX:false, COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html', FILE_SUFFIX:'.html',

2
doc/html/searchindex.js
View File

File diff suppressed because one or more lines are too long

12
doc/html/setup-dks.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Setting up musrfit / DKS: High Speed Fitting with GPU’s &mdash; musrfit 1.8.2 documentation</title> <title>Setting up musrfit / DKS: High Speed Fitting with GPU’s &mdash; musrfit 1.9.0 documentation</title>
@ -58,6 +58,10 @@
<div class="version">
1.9
</div>
@ -400,8 +404,8 @@ The only thing you need <code class="docutils literal notranslate"><span class="
<div role="contentinfo"> <div role="contentinfo">
<p> <p>
&copy; Copyright 2022, Andreas Suter. &copy; Copyright 2023, Andreas Suter.
Last updated on Dec 12, 2022. Last updated on Feb 17, 2023.
</p> </p>
</div> </div>
@ -423,7 +427,7 @@ The only thing you need <code class="docutils literal notranslate"><span class="
<script type="text/javascript"> <script type="text/javascript">
var DOCUMENTATION_OPTIONS = { var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./', URL_ROOT:'./',
VERSION:'1.8.2', VERSION:'1.9.0',
LANGUAGE:'None', LANGUAGE:'None',
COLLAPSE_INDEX:false, COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html', FILE_SUFFIX:'.html',

12
doc/html/setup-standard.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Setting up musrfit on Different Platforms &mdash; musrfit 1.8.2 documentation</title> <title>Setting up musrfit on Different Platforms &mdash; musrfit 1.9.0 documentation</title>
@ -58,6 +58,10 @@
<div class="version">
1.9
</div>
@ -1087,8 +1091,8 @@ $ musrview test-histo-ROOT-NPP.msr
<div role="contentinfo"> <div role="contentinfo">
<p> <p>
&copy; Copyright 2022, Andreas Suter. &copy; Copyright 2023, Andreas Suter.
Last updated on Dec 12, 2022. Last updated on Feb 17, 2023.
</p> </p>
</div> </div>
@ -1110,7 +1114,7 @@ $ musrview test-histo-ROOT-NPP.msr
<script type="text/javascript"> <script type="text/javascript">
var DOCUMENTATION_OPTIONS = { var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./', URL_ROOT:'./',
VERSION:'1.8.2', VERSION:'1.9.0',
LANGUAGE:'None', LANGUAGE:'None',
COLLAPSE_INDEX:false, COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html', FILE_SUFFIX:'.html',

12
doc/html/tutorial.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Tutorial for musrfit &mdash; musrfit 1.8.2 documentation</title> <title>Tutorial for musrfit &mdash; musrfit 1.9.0 documentation</title>
@ -58,6 +58,10 @@
<div class="version">
1.9
</div>
@ -519,8 +523,8 @@ For a complete description please refer to the manuals of <a class="reference in
<div role="contentinfo"> <div role="contentinfo">
<p> <p>
&copy; Copyright 2022, Andreas Suter. &copy; Copyright 2023, Andreas Suter.
Last updated on Dec 12, 2022. Last updated on Feb 17, 2023.
</p> </p>
</div> </div>
@ -542,7 +546,7 @@ For a complete description please refer to the manuals of <a class="reference in
<script type="text/javascript"> <script type="text/javascript">
var DOCUMENTATION_OPTIONS = { var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./', URL_ROOT:'./',
VERSION:'1.8.2', VERSION:'1.9.0',
LANGUAGE:'None', LANGUAGE:'None',
COLLAPSE_INDEX:false, COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html', FILE_SUFFIX:'.html',

160
doc/html/user-libs.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Documentation of user libs (user functions) &mdash; musrfit 1.8.2 documentation</title> <title>Documentation of user libs (user functions) &mdash; musrfit 1.9.0 documentation</title>
@ -58,6 +58,10 @@
<div class="version">
1.9
</div>
@ -95,6 +99,7 @@
</ul> </ul>
</li> </li>
<li class="toctree-l2"><a class="reference internal" href="#nonlocal-superconductivity-related-meissner-screening-functions-as-libs">Nonlocal superconductivity related Meissner screening functions (AS libs)</a></li> <li class="toctree-l2"><a class="reference internal" href="#nonlocal-superconductivity-related-meissner-screening-functions-as-libs">Nonlocal superconductivity related Meissner screening functions (AS libs)</a></li>
<li class="toctree-l2"><a class="reference internal" href="#depth-resolved-information-as-libs">Depth resolved information (AS libs)</a></li>
<li class="toctree-l2"><a class="reference internal" href="#functions-to-analyze-bgr-nmr-data-bnmr-libs">Functions to analyze β-NMR data (BNMR libs)</a><ul> <li class="toctree-l2"><a class="reference internal" href="#functions-to-analyze-bgr-nmr-data-bnmr-libs">Functions to analyze β-NMR data (BNMR libs)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#libbnmr">libBNMR</a><ul> <li class="toctree-l3"><a class="reference internal" href="#libbnmr">libBNMR</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#functions">Functions</a></li> <li class="toctree-l4"><a class="reference internal" href="#functions">Functions</a></li>
@ -498,11 +503,120 @@ The expected name of the <code class="docutils literal notranslate"><span class=
</div> </div>
</div> </div>
<div class="section" id="nonlocal-superconductivity-related-meissner-screening-functions-as-libs"> <div class="section" id="nonlocal-superconductivity-related-meissner-screening-functions-as-libs">
<h2>Nonlocal superconductivity related Meissner screening functions (AS libs)<a class="headerlink" href="#nonlocal-superconductivity-related-meissner-screening-functions-as-libs" title="Permalink to this headline"></a></h2> <span id="nonlocal-libs"></span><span id="index-14"></span><h2>Nonlocal superconductivity related Meissner screening functions (AS libs)<a class="headerlink" href="#nonlocal-superconductivity-related-meissner-screening-functions-as-libs" title="Permalink to this headline"></a></h2>
<p>To be written yet …</p> <p>This library allows to calculate the magnetic field profile <span class="math notranslate nohighlight">\(B(z)\)</span> for nonlocal superconductors.
For details see <a class="reference external" href="http://dx.doi.org/10.1103/PhysRevLett.95.197201">A. Suter, et al., PRB 72, 024506 (2005)</a>, and references therein.</p>
<p>The provided function calculates the muon spin polarization</p>
<div class="math notranslate nohighlight">
\[P(t, E) = \int n(z, E)\, \cos(\gamma_\mu B(z) t + \phi) \, dz,\]</div>
<p>where <span class="math notranslate nohighlight">\(B(z)\)</span> is calculated in the limit of specular reflection.
The corresponding user function is called as</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">userFcn</span> <span class="n">libPNL_PippardFitter</span> <span class="n">PNL_PippardFitter</span> <span class="mi">1</span> <span class="mi">2</span> <span class="mi">3</span> <span class="mi">4</span> <span class="mi">5</span> <span class="mi">6</span> <span class="mi">7</span> <span class="mi">8</span> <span class="mi">9</span>
</pre></div>
</div>
<p>with the parameters</p>
<ol class="arabic simple">
<li>implantation energy in (keV).</li>
<li>reduced temperature <span class="math notranslate nohighlight">\(t=T/T_c\)</span>.</li>
<li>thickness in (nm).</li>
<li>electron mean path, <span class="math notranslate nohighlight">\(\ell\)</span> in (nm).</li>
<li>superconducting coherence length, <span class="math notranslate nohighlight">\(\xi\)</span> in (nm).</li>
<li>London penetration length, <span class="math notranslate nohighlight">\(\lambda_{\rm L}\)</span> in (nm).</li>
<li>external magnetic field strength in (G).</li>
<li>the effective detector phase, <span class="math notranslate nohighlight">\(\varphi\)</span> in <span class="math notranslate nohighlight">\((^\circ)\)</span>.</li>
<li>a “dead layer” thickness in (nm).</li>
</ol>
<p>Typically this function needs to be multiplied by a Gaussian in order to take into account: nuclear dipole broadening, partial trapped flux, etc.</p>
<p>In order to find the muon stopping profile, <span class="math notranslate nohighlight">\(n(z,E)\)</span>, needed for the calculation, the library needs to find the corresponding trimsp
rge-files (muon stoppping profiles). For this the library reads at start-up the following xml-file (example):</p>
<div class="highlight-xml notranslate"><div class="highlight"><pre><span></span><span class="cp">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;</span>
<span class="nt">&lt;nonlocal</span> <span class="na">xmlns=</span><span class="s">&quot;http://nemu.web.psi.ch/musrfit/nonlocal&quot;</span><span class="nt">&gt;</span>
<span class="nt">&lt;comment&gt;</span>
nonlocal_startup.xml
<span class="nt">&lt;/comment&gt;</span>
<span class="nt">&lt;nonlocal_par&gt;</span>
<span class="nt">&lt;fourier_points&gt;</span>262144<span class="nt">&lt;/fourier_points&gt;</span>
<span class="nt">&lt;/nonlocal_par&gt;</span>
<span class="nt">&lt;trim_sp&gt;</span>
<span class="nt">&lt;data_path&gt;</span>./profiles/<span class="nt">&lt;/data_path&gt;</span>
<span class="nt">&lt;rge_fln_pre&gt;</span>Sn_E<span class="nt">&lt;/rge_fln_pre&gt;</span>
<span class="nt">&lt;energy_list&gt;</span>
<span class="nt">&lt;energy&gt;</span>1000<span class="nt">&lt;/energy&gt;</span>
<span class="nt">&lt;energy&gt;</span>2000<span class="nt">&lt;/energy&gt;</span>
<span class="nt">&lt;energy&gt;</span>4000<span class="nt">&lt;/energy&gt;</span>
<span class="nt">&lt;energy&gt;</span>6000<span class="nt">&lt;/energy&gt;</span>
<span class="nt">&lt;energy&gt;</span>8000<span class="nt">&lt;/energy&gt;</span>
<span class="nt">&lt;energy&gt;</span>10000<span class="nt">&lt;/energy&gt;</span>
<span class="nt">&lt;energy&gt;</span>12000<span class="nt">&lt;/energy&gt;</span>
<span class="nt">&lt;energy&gt;</span>14100<span class="nt">&lt;/energy&gt;</span>
<span class="nt">&lt;energy&gt;</span>18000<span class="nt">&lt;/energy&gt;</span>
<span class="nt">&lt;energy&gt;</span>22000<span class="nt">&lt;/energy&gt;</span>
<span class="nt">&lt;energy&gt;</span>25000<span class="nt">&lt;/energy&gt;</span>
<span class="nt">&lt;energy&gt;</span>27300<span class="nt">&lt;/energy&gt;</span>
<span class="nt">&lt;/energy_list&gt;</span>
<span class="nt">&lt;/trim_sp&gt;</span>
<span class="nt">&lt;/nonlocal&gt;</span>
</pre></div>
</div>
<p>Here the number of Fourier points needed in the calculation can be defined (<code class="docutils literal notranslate"><span class="pre">fourier_points</span></code>). The <code class="docutils literal notranslate"><span class="pre">trim_sp</span></code> section
contains all the information needed to load the proper muon stopping profiles. <code class="docutils literal notranslate"><span class="pre">data_path</span></code> is the path to the needed rge-files.
<code class="docutils literal notranslate"><span class="pre">rge_fln_pre</span></code> is the rge-file prefix, and <code class="docutils literal notranslate"><span class="pre">energy</span></code> are all the energy tags. E.g. <code class="docutils literal notranslate"><span class="pre">./profile/Sn_E1000.rge</span></code> would be the first
muon stopping profile for an energy of <span class="math notranslate nohighlight">\(E=1000\)</span> (eV).</p>
<p>The name of the xml-file has to be <code class="docutils literal notranslate"><span class="pre">nonlocal_startup.xml</span></code> and needs to be placed in the directory where the analysis takes place, i.e.
in the directory of all the msr-files.</p>
</div>
<div class="section" id="depth-resolved-information-as-libs">
<span id="depthprof-lib"></span><span id="index-15"></span><h2>Depth resolved information (AS libs)<a class="headerlink" href="#depth-resolved-information-as-libs" title="Permalink to this headline"></a></h2>
<p>A method to extract depth-resolved information from the implantation energy dependence of the experimental parameters in a low-energy
muon spin spectroscopy experiment. For details see <a class="reference external" href="https://doi.org/10.1063/1.5126529">A. F. A. Simões, et al. Review of Scientific Instruments. 2020; 91(2): 023906 (7 pp.)</a>.</p>
<p>If you have a layered material (e.g. <span class="math notranslate nohighlight">\(N\)</span> layers), properties like the asymmetry might depend on the layer in which the muons are stopped.
For instance there might be different probabilities for muonium formation depending on the material, charge transfer layers, etc.</p>
<p>Since the muon stopping distribution, <span class="math notranslate nohighlight">\(n(z)\)</span>, has some finite range, these properties will be smeared out. For the following we define
the stopping probability, <span class="math notranslate nohighlight">\(p_{i}(E)\)</span> for a finite slice <span class="math notranslate nohighlight">\(i\)</span>, ranging from <span class="math notranslate nohighlight">\(z \in [a, b]\)</span> as</p>
<div class="math notranslate nohighlight">
\[p_{i}(E) = \int_a^b n(z,E) \, dz\]</div>
<p>Furthermore it is assumes that there is a sharp transition between the layers of the property of interest, e.g. the diamagnetic fraction, <span class="math notranslate nohighlight">\(f_i\)</span>.
Hence the measured property as function of energy is</p>
<div class="math notranslate nohighlight">
\[f(E) = \sum_{i=1}^N p_{i}(E) \cdot f_i.\]</div>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">Currently it is recommended to read in the data in ASCII or DAT format as a non-μSR fit <a class="reference internal" href="user-manual.html#non-musr-fit"><span class="std std-ref">(fit type 8)</span></a>.</p>
</div>
<p>The user library for the depth profile analysis looks for a <strong>3 layer material</strong>, assuming one is looking for the diamagnetic fraction, like</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1">###############################################################</span>
<span class="n">FITPARAMETER</span>
<span class="c1"># Nr. Name Value Step Pos_Error Boundaries</span>
<span class="mi">1</span> <span class="n">f1</span> <span class="mf">0.54540</span> <span class="mf">0.00072</span> <span class="n">none</span> <span class="mi">0</span> <span class="mi">1</span>
<span class="mi">2</span> <span class="n">f2</span> <span class="mf">0.23957</span> <span class="mf">0.00048</span> <span class="n">none</span>
<span class="mi">3</span> <span class="n">f3</span> <span class="mf">0.05615</span> <span class="mf">0.00047</span> <span class="n">none</span> <span class="mi">0</span> <span class="mi">1</span>
<span class="mi">4</span> <span class="n">x1</span> <span class="mf">63.5000</span> <span class="mf">0.0014</span> <span class="n">none</span>
<span class="mi">5</span> <span class="n">x2</span> <span class="mf">101.5001</span> <span class="mf">0.0044</span> <span class="n">none</span>
<span class="c1">###############################################################</span>
<span class="n">THEORY</span>
<span class="n">userFcn</span> <span class="n">libPDepthProfile</span> <span class="n">PDepthProfile</span> <span class="mi">1</span> <span class="mi">2</span> <span class="mi">3</span> <span class="mi">4</span> <span class="mi">5</span>
</pre></div>
</div>
<p>Here, <span class="math notranslate nohighlight">\(f1\)</span> is the diamagnetic fraction of the first layer, etc. <span class="math notranslate nohighlight">\(x1\)</span> is the thickness of the first layer, etc.</p>
<p>In order to find the muon stopping profile, <span class="math notranslate nohighlight">\(n(z,E)\)</span>, needed for the calculation, the library needs to find the corresponding trimsp
rge-files (muon stoppping profiles). For this the library reads at start-up the following xml-file (example):</p>
<div class="highlight-xml notranslate"><div class="highlight"><pre><span></span><span class="cp">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;</span>
<span class="nt">&lt;depthProf</span> <span class="na">xmlns=</span><span class="s">&quot;http://nemu.web.psi.ch/musrfit/depthProf&quot;</span><span class="nt">&gt;</span>
<span class="nt">&lt;comment&gt;</span>
TrimSp information
<span class="nt">&lt;/comment&gt;</span>
<span class="nt">&lt;trim_sp&gt;</span>
<span class="nt">&lt;data_path&gt;</span>./TRIMSP/<span class="nt">&lt;/data_path&gt;</span>
<span class="nt">&lt;rge_fln_pre&gt;</span>SiO2_70nm2.0_30nm2.2_SiC_E<span class="nt">&lt;/rge_fln_pre&gt;</span>
<span class="nt">&lt;energy_vect</span> <span class="na">start=</span><span class="s">&quot;1000&quot;</span> <span class="na">stop=</span><span class="s">&quot;22000&quot;</span> <span class="na">step=</span><span class="s">&quot;1000&quot;</span><span class="nt">/&gt;</span>
<span class="nt">&lt;/trim_sp&gt;</span>
<span class="nt">&lt;/depthProf&gt;</span>
</pre></div>
</div>
</div> </div>
<div class="section" id="functions-to-analyze-bgr-nmr-data-bnmr-libs"> <div class="section" id="functions-to-analyze-bgr-nmr-data-bnmr-libs">
<span id="bnmr-libs"></span><span id="index-14"></span><h2>Functions to analyze β-NMR data (BNMR libs)<a class="headerlink" href="#functions-to-analyze-bgr-nmr-data-bnmr-libs" title="Permalink to this headline"></a></h2> <span id="bnmr-libs"></span><span id="index-16"></span><h2>Functions to analyze β-NMR data (BNMR libs)<a class="headerlink" href="#functions-to-analyze-bgr-nmr-data-bnmr-libs" title="Permalink to this headline"></a></h2>
<p>This is a collection of <code class="docutils literal notranslate"><span class="pre">C++</span></code> classes using the <code class="docutils literal notranslate"><span class="pre">musrfit</span></code> <a class="reference internal" href="user-manual.html#id38"><span class="std std-ref">user-functions</span></a> <p>This is a collection of <code class="docutils literal notranslate"><span class="pre">C++</span></code> classes using the <code class="docutils literal notranslate"><span class="pre">musrfit</span></code> <a class="reference internal" href="user-manual.html#id38"><span class="std std-ref">user-functions</span></a>
interface in order to facilitate the usage in conjunction with <code class="docutils literal notranslate"><span class="pre">musrfit</span></code>. It consists of two libraries:</p> interface in order to facilitate the usage in conjunction with <code class="docutils literal notranslate"><span class="pre">musrfit</span></code>. It consists of two libraries:</p>
<ul class="simple"> <ul class="simple">
@ -514,11 +628,11 @@ interface in order to facilitate the usage in conjunction with <code class="docu
<p class="last">Currently it is recommended to read in the data in ASCII format as a non-μSR fit <a class="reference internal" href="user-manual.html#non-musr-fit"><span class="std std-ref">(fit type 8)</span></a>.</p> <p class="last">Currently it is recommended to read in the data in ASCII format as a non-μSR fit <a class="reference internal" href="user-manual.html#non-musr-fit"><span class="std std-ref">(fit type 8)</span></a>.</p>
</div> </div>
<div class="section" id="libbnmr"> <div class="section" id="libbnmr">
<span id="index-15"></span><h3>libBNMR<a class="headerlink" href="#libbnmr" title="Permalink to this headline"></a></h3> <span id="index-17"></span><h3>libBNMR<a class="headerlink" href="#libbnmr" title="Permalink to this headline"></a></h3>
<p>In β-NMR the SLR is usually measured by implanting a pulse of <span class="math notranslate nohighlight">\(^8\)</span>Li with a length <span class="math notranslate nohighlight">\(t_0\)</span> into the sample. <p>In β-NMR the SLR is usually measured by implanting a pulse of <span class="math notranslate nohighlight">\(^8\)</span>Li with a length <span class="math notranslate nohighlight">\(t_0\)</span> into the sample.
The asymmetry is measured both during the pulse and afterwards. For a a general spin relaxation function <span class="math notranslate nohighlight">\(f(t)\)</span> the time evolution of the asymmetry is then given by [<a class="reference external" href="http://dx.doi.org/10.1103/PhysRevLett.96.147601">Z. Salman, et al., PRL 96, 147601 (2006)</a>]:</p> The asymmetry is measured both during the pulse and afterwards. For a a general spin relaxation function <span class="math notranslate nohighlight">\(f(t)\)</span> the time evolution of the asymmetry is then given by [<a class="reference external" href="http://dx.doi.org/10.1103/PhysRevLett.96.147601">Z. Salman, et al., PRL 96, 147601 (2006)</a>]:</p>
<div class="math notranslate nohighlight" id="slr"> <div class="math notranslate nohighlight" id="slr">
<span id="index-16"></span>\[\begin{split}P(t) = \left\{\begin{matrix} <span id="index-18"></span>\[\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' } &amp; t\leq t_0\\[6pt] \frac{\int_0^t e^{-(t-t')/\tau_{\mathrm{Li}}}f(t-t')dt'}{\int_0^t e^{-t'/\tau_{\mathrm{Li}}}dt' } &amp; 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'} &amp; t&gt; t_0, \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'} &amp; t&gt; t_0,
\end{matrix}\right.\end{split}\]</div> \end{matrix}\right.\end{split}\]</div>
@ -526,7 +640,7 @@ The asymmetry is measured both during the pulse and afterwards. For a a general
<div class="section" id="functions"> <div class="section" id="functions">
<h4>Functions<a class="headerlink" href="#functions" title="Permalink to this headline"></a></h4> <h4>Functions<a class="headerlink" href="#functions" title="Permalink to this headline"></a></h4>
<p>The <code class="docutils literal notranslate"><span class="pre">libBNMR</span></code> library currently contains the following functions:</p> <p>The <code class="docutils literal notranslate"><span class="pre">libBNMR</span></code> library currently contains the following functions:</p>
<p id="index-17"><strong>Exponential relaxation</strong></p> <p id="index-19"><strong>Exponential relaxation</strong></p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">userFcn</span> <span class="n">libBNMR</span> <span class="n">ExpRlx</span> <span class="mi">1</span> <span class="mi">2</span> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">userFcn</span> <span class="n">libBNMR</span> <span class="n">ExpRlx</span> <span class="mi">1</span> <span class="mi">2</span>
</pre></div> </pre></div>
</div> </div>
@ -536,7 +650,7 @@ The asymmetry is measured both during the pulse and afterwards. For a a general
<li>relaxation rate <span class="math notranslate nohighlight">\(\lambda\)</span> (s<span class="math notranslate nohighlight">\(^{-1}\)</span>)</li> <li>relaxation rate <span class="math notranslate nohighlight">\(\lambda\)</span> (s<span class="math notranslate nohighlight">\(^{-1}\)</span>)</li>
</ol> </ol>
<p>This function implements <span class="math notranslate nohighlight">\(f(t)=e^{-\lambda t}\)</span>.</p> <p>This function implements <span class="math notranslate nohighlight">\(f(t)=e^{-\lambda t}\)</span>.</p>
<p id="index-18"><strong>Stretched exponential relaxation</strong></p> <p id="index-20"><strong>Stretched exponential relaxation</strong></p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">userFcn</span> <span class="n">libBNMR</span> <span class="n">SExpRlx</span> <span class="mi">1</span> <span class="mi">2</span> <span class="mi">3</span> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">userFcn</span> <span class="n">libBNMR</span> <span class="n">SExpRlx</span> <span class="mi">1</span> <span class="mi">2</span> <span class="mi">3</span>
</pre></div> </pre></div>
</div> </div>
@ -550,19 +664,19 @@ The asymmetry is measured both during the pulse and afterwards. For a a general
</div> </div>
</div> </div>
<div class="section" id="liblineprofile"> <div class="section" id="liblineprofile">
<span id="index-19"></span><h3>libLineProfile<a class="headerlink" href="#liblineprofile" title="Permalink to this headline"></a></h3> <span id="index-21"></span><h3>libLineProfile<a class="headerlink" href="#liblineprofile" title="Permalink to this headline"></a></h3>
<p>In addition to some simple line shapes <code class="docutils literal notranslate"><span class="pre">libLineProfile</span></code> contains functions to fit chemical shift anisotropies in the powder average. <p>In addition to some simple line shapes <code class="docutils literal notranslate"><span class="pre">libLineProfile</span></code> contains functions to fit chemical shift anisotropies in the powder average.
Their functional form can be found in <a class="reference external" href="http://dx.doi.org/10.1007/978-3-642-68756-3_2">M. Mehring, Principles of High Resolution NMR in Solids (Springer 1983)</a>.</p> Their functional form can be found in <a class="reference external" href="http://dx.doi.org/10.1007/978-3-642-68756-3_2">M. Mehring, Principles of High Resolution NMR in Solids (Springer 1983)</a>.</p>
<p>For an axially symmetric interaction it is given by:</p> <p>For an axially symmetric interaction it is given by:</p>
<div class="math notranslate nohighlight" id="iax"> <div class="math notranslate nohighlight" id="iax">
<span id="index-20"></span>\[\begin{split}I_{\mathrm ax}(f)=\left\{\begin{matrix} \frac{1}{2\sqrt{(f_\parallel-f_\perp)(f-f_\perp)}}&amp; f\in(f_\perp,f_\parallel)\cup(f_\parallel,f_\perp)\\[6pt] 0 &amp; \text{otherwise}\end{matrix} \right.\end{split}\]</div> <span id="index-22"></span>\[\begin{split}I_{\mathrm ax}(f)=\left\{\begin{matrix} \frac{1}{2\sqrt{(f_\parallel-f_\perp)(f-f_\perp)}}&amp; f\in(f_\perp,f_\parallel)\cup(f_\parallel,f_\perp)\\[6pt] 0 &amp; \text{otherwise}\end{matrix} \right.\end{split}\]</div>
<p>where <span class="math notranslate nohighlight">\(f_\parallel\)</span> and <span class="math notranslate nohighlight">\(f_\perp\)</span> are the frequencies that would be observed if the field is oriented paralell or perpendicular to the symmetry axis, respectively.</p> <p>where <span class="math notranslate nohighlight">\(f_\parallel\)</span> and <span class="math notranslate nohighlight">\(f_\perp\)</span> are the frequencies that would be observed if the field is oriented paralell or perpendicular to the symmetry axis, respectively.</p>
<div class="line-block"> <div class="line-block">
<div class="line">In case of a completely anisotropic interaction, the powder average can be described by the frequencies along the three principle axis <span class="math notranslate nohighlight">\(f_1,f_2,f_3\)</span>.</div> <div class="line">In case of a completely anisotropic interaction, the powder average can be described by the frequencies along the three principle axis <span class="math notranslate nohighlight">\(f_1,f_2,f_3\)</span>.</div>
<div class="line">Assume without loss of generality that <span class="math notranslate nohighlight">\(f_1&lt;f_2&lt;f_3\)</span>, then</div> <div class="line">Assume without loss of generality that <span class="math notranslate nohighlight">\(f_1&lt;f_2&lt;f_3\)</span>, then</div>
</div> </div>
<div class="math notranslate nohighlight" id="ianiso"> <div class="math notranslate nohighlight" id="ianiso">
<span id="index-21"></span>\[\begin{split}I(f)&amp;=\left\{\begin{matrix} <span id="index-23"></span>\[\begin{split}I(f)&amp;=\left\{\begin{matrix}
\frac{K(m)}{\pi\sqrt{(f-f_1)(f_3-f_2)}},&amp; f_3\geq f&gt;f_2 \\[9pt] \frac{K(m)}{\pi\sqrt{(f-f_1)(f_3-f_2)}},&amp; f_3\geq f&gt;f_2 \\[9pt]
\frac{K(m)}{\pi\sqrt{(f_3-f)(f_2-f_1)}},&amp; f_2&gt;f\geq f_1\\[9pt] \frac{K(m)}{\pi\sqrt{(f_3-f)(f_2-f_1)}},&amp; f_2&gt;f\geq f_1\\[9pt]
0 &amp; \text{otherwise} 0 &amp; \text{otherwise}
@ -578,7 +692,7 @@ K(m)&amp;=\int_0^{\pi/2}\frac{\mathrm d\varphi}{\sqrt{1-m^2\sin^2{\varphi}}},\en
<div class="section" id="id1"> <div class="section" id="id1">
<h4>Functions<a class="headerlink" href="#id1" title="Permalink to this headline"></a></h4> <h4>Functions<a class="headerlink" href="#id1" title="Permalink to this headline"></a></h4>
<p>The <code class="docutils literal notranslate"><span class="pre">libLineProfile</span></code> library currently contains the following functions:</p> <p>The <code class="docutils literal notranslate"><span class="pre">libLineProfile</span></code> library currently contains the following functions:</p>
<p id="index-22"><strong>Gaussian</strong></p> <p id="index-24"><strong>Gaussian</strong></p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">userFcn</span> <span class="n">libLineProfile</span> <span class="n">LineGauss</span> <span class="mi">1</span> <span class="mi">2</span> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">userFcn</span> <span class="n">libLineProfile</span> <span class="n">LineGauss</span> <span class="mi">1</span> <span class="mi">2</span>
</pre></div> </pre></div>
</div> </div>
@ -593,7 +707,7 @@ K(m)&amp;=\int_0^{\pi/2}\frac{\mathrm d\varphi}{\sqrt{1-m^2\sin^2{\varphi}}},\en
</div> </div>
<div class="math notranslate nohighlight"> <div class="math notranslate nohighlight">
\[A(f)=e^{-\frac{4\ln 2 (f-f_0)^2}{ \sigma^2}}\]</div> \[A(f)=e^{-\frac{4\ln 2 (f-f_0)^2}{ \sigma^2}}\]</div>
<p id="index-23"><strong>Lorentzian</strong></p> <p id="index-25"><strong>Lorentzian</strong></p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">userFcn</span> <span class="n">libLineProfile</span> <span class="n">LineLorentzian</span> <span class="mi">1</span> <span class="mi">2</span> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">userFcn</span> <span class="n">libLineProfile</span> <span class="n">LineLorentzian</span> <span class="mi">1</span> <span class="mi">2</span>
</pre></div> </pre></div>
</div> </div>
@ -608,7 +722,7 @@ K(m)&amp;=\int_0^{\pi/2}\frac{\mathrm d\varphi}{\sqrt{1-m^2\sin^2{\varphi}}},\en
</div> </div>
<div class="math notranslate nohighlight"> <div class="math notranslate nohighlight">
\[A(f)= \frac{w^2}{4(f-f_0)^2+w^2}\]</div> \[A(f)= \frac{w^2}{4(f-f_0)^2+w^2}\]</div>
<p id="index-24"><strong>Laplacian</strong></p> <p id="index-26"><strong>Laplacian</strong></p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">userFcn</span> <span class="n">libLineProfile</span> <span class="n">LineLaplace</span> <span class="mi">1</span> <span class="mi">2</span> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">userFcn</span> <span class="n">libLineProfile</span> <span class="n">LineLaplace</span> <span class="mi">1</span> <span class="mi">2</span>
</pre></div> </pre></div>
</div> </div>
@ -623,7 +737,7 @@ K(m)&amp;=\int_0^{\pi/2}\frac{\mathrm d\varphi}{\sqrt{1-m^2\sin^2{\varphi}}},\en
</div> </div>
<div class="math notranslate nohighlight"> <div class="math notranslate nohighlight">
\[A(f)=e^{-2\ln 2 \left|\frac{f-f_0}{w}\right|}\]</div> \[A(f)=e^{-2\ln 2 \left|\frac{f-f_0}{w}\right|}\]</div>
<p id="index-25"><strong>Skewed Lorentzian</strong></p> <p id="index-27"><strong>Skewed Lorentzian</strong></p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">userFcn</span> <span class="n">libLineProfile</span> <span class="n">LineSkewLorentzian</span> <span class="mi">1</span> <span class="mi">2</span> <span class="mi">3</span> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">userFcn</span> <span class="n">libLineProfile</span> <span class="n">LineSkewLorentzian</span> <span class="mi">1</span> <span class="mi">2</span> <span class="mi">3</span>
</pre></div> </pre></div>
</div> </div>
@ -639,7 +753,7 @@ K(m)&amp;=\int_0^{\pi/2}\frac{\mathrm d\varphi}{\sqrt{1-m^2\sin^2{\varphi}}},\en
</div> </div>
<div class="math notranslate nohighlight"> <div class="math notranslate nohighlight">
\[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)}}\]</div> \[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)}}\]</div>
<p id="index-26"><strong>Skewed Lorentzian 2</strong></p> <p id="index-28"><strong>Skewed Lorentzian 2</strong></p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">userFcn</span> <span class="n">libLineProfile</span> <span class="n">LineSkewLorentzian2</span> <span class="mi">1</span> <span class="mi">2</span> <span class="mi">3</span> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">userFcn</span> <span class="n">libLineProfile</span> <span class="n">LineSkewLorentzian2</span> <span class="mi">1</span> <span class="mi">2</span> <span class="mi">3</span>
</pre></div> </pre></div>
</div> </div>
@ -655,7 +769,7 @@ K(m)&amp;=\int_0^{\pi/2}\frac{\mathrm d\varphi}{\sqrt{1-m^2\sin^2{\varphi}}},\en
</div> </div>
<div class="math notranslate nohighlight"> <div class="math notranslate nohighlight">
\[\begin{split}A(f)= \left\{\begin{matrix}\frac{{w_1}^2}{4{(f-f_0)}^2+{w_1}^2},&amp;f\leq f_0\\[9pt] \frac{{w_2}^2}{4{(f-f_0)}^2+{w_2}^2},&amp;f&gt;f_0\end{matrix}\right.\end{split}\]</div> \[\begin{split}A(f)= \left\{\begin{matrix}\frac{{w_1}^2}{4{(f-f_0)}^2+{w_1}^2},&amp;f\leq f_0\\[9pt] \frac{{w_2}^2}{4{(f-f_0)}^2+{w_2}^2},&amp;f&gt;f_0\end{matrix}\right.\end{split}\]</div>
<p id="index-27"><strong>Powder average of an axially symmetric interaction convoluted with a Lorentzian</strong></p> <p id="index-29"><strong>Powder average of an axially symmetric interaction convoluted with a Lorentzian</strong></p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">userFcn</span> <span class="n">libLineProfile</span> <span class="n">PowderLineAxialLor</span> <span class="mi">1</span> <span class="mi">2</span> <span class="mi">3</span> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">userFcn</span> <span class="n">libLineProfile</span> <span class="n">PowderLineAxialLor</span> <span class="mi">1</span> <span class="mi">2</span> <span class="mi">3</span>
</pre></div> </pre></div>
</div> </div>
@ -672,7 +786,7 @@ K(m)&amp;=\int_0^{\pi/2}\frac{\mathrm d\varphi}{\sqrt{1-m^2\sin^2{\varphi}}},\en
<div class="math notranslate nohighlight"> <div class="math notranslate nohighlight">
\[A(f)= I_{\mathrm ax}(f)\circledast\left( \frac{w^2}{4f^2+w^2} \right)\]</div> \[A(f)= I_{\mathrm ax}(f)\circledast\left( \frac{w^2}{4f^2+w^2} \right)\]</div>
<p>with <span class="math notranslate nohighlight">\(I_{\mathrm ax}(f)\)</span> defined <a class="reference internal" href="#iax"><span class="std std-ref">above</span></a>.</p> <p>with <span class="math notranslate nohighlight">\(I_{\mathrm ax}(f)\)</span> defined <a class="reference internal" href="#iax"><span class="std std-ref">above</span></a>.</p>
<p id="index-28"><strong>Powder average of an axially symmetric interaction convoluted with a Gaussian</strong></p> <p id="index-30"><strong>Powder average of an axially symmetric interaction convoluted with a Gaussian</strong></p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">userFcn</span> <span class="n">libLineProfile</span> <span class="n">PowderLineAxialGss</span> <span class="mi">1</span> <span class="mi">2</span> <span class="mi">3</span> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">userFcn</span> <span class="n">libLineProfile</span> <span class="n">PowderLineAxialGss</span> <span class="mi">1</span> <span class="mi">2</span> <span class="mi">3</span>
</pre></div> </pre></div>
</div> </div>
@ -689,7 +803,7 @@ K(m)&amp;=\int_0^{\pi/2}\frac{\mathrm d\varphi}{\sqrt{1-m^2\sin^2{\varphi}}},\en
<div class="math notranslate nohighlight"> <div class="math notranslate nohighlight">
\[A(f)= I_{\mathrm ax}(f)\circledast\left( e^{-\frac{4\ln 2 (f-f_0)^2}{ \sigma^2}} \right)\]</div> \[A(f)= I_{\mathrm ax}(f)\circledast\left( e^{-\frac{4\ln 2 (f-f_0)^2}{ \sigma^2}} \right)\]</div>
<p>with <span class="math notranslate nohighlight">\(I_{\mathrm ax}(f)\)</span> defined <a class="reference internal" href="#iax"><span class="std std-ref">above</span></a>.</p> <p>with <span class="math notranslate nohighlight">\(I_{\mathrm ax}(f)\)</span> defined <a class="reference internal" href="#iax"><span class="std std-ref">above</span></a>.</p>
<p id="index-29"><strong>Powder average of an anisotropic interaction convoluted with a Lorentzian</strong></p> <p id="index-31"><strong>Powder average of an anisotropic interaction convoluted with a Lorentzian</strong></p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">userFcn</span> <span class="n">libLineProfile</span> <span class="n">PowderLineAsymLor</span> <span class="mi">1</span> <span class="mi">2</span> <span class="mi">3</span> <span class="mi">4</span> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">userFcn</span> <span class="n">libLineProfile</span> <span class="n">PowderLineAsymLor</span> <span class="mi">1</span> <span class="mi">2</span> <span class="mi">3</span> <span class="mi">4</span>
</pre></div> </pre></div>
</div> </div>
@ -707,7 +821,7 @@ K(m)&amp;=\int_0^{\pi/2}\frac{\mathrm d\varphi}{\sqrt{1-m^2\sin^2{\varphi}}},\en
<div class="math notranslate nohighlight"> <div class="math notranslate nohighlight">
\[A(f)= I(f)\circledast\left( \frac{w^2}{4f^2+w^2} \right)\]</div> \[A(f)= I(f)\circledast\left( \frac{w^2}{4f^2+w^2} \right)\]</div>
<p>with <span class="math notranslate nohighlight">\(I(f)\)</span> defined <a class="reference internal" href="#ianiso"><span class="std std-ref">above</span></a>. Note that <span class="math notranslate nohighlight">\(f_1&lt;f_2&lt;f_3\)</span> is not required by the code.</p> <p>with <span class="math notranslate nohighlight">\(I(f)\)</span> defined <a class="reference internal" href="#ianiso"><span class="std std-ref">above</span></a>. Note that <span class="math notranslate nohighlight">\(f_1&lt;f_2&lt;f_3\)</span> is not required by the code.</p>
<p id="index-30"><strong>Powder average of an anisotropic interaction convoluted with a Gaussian</strong></p> <p id="index-32"><strong>Powder average of an anisotropic interaction convoluted with a Gaussian</strong></p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">userFcn</span> <span class="n">libLineProfile</span> <span class="n">PowderLineAsymGss</span> <span class="mi">1</span> <span class="mi">2</span> <span class="mi">3</span> <span class="mi">4</span> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">userFcn</span> <span class="n">libLineProfile</span> <span class="n">PowderLineAsymGss</span> <span class="mi">1</span> <span class="mi">2</span> <span class="mi">3</span> <span class="mi">4</span>
</pre></div> </pre></div>
</div> </div>
@ -750,8 +864,8 @@ K(m)&amp;=\int_0^{\pi/2}\frac{\mathrm d\varphi}{\sqrt{1-m^2\sin^2{\varphi}}},\en
<div role="contentinfo"> <div role="contentinfo">
<p> <p>
&copy; Copyright 2022, Andreas Suter. &copy; Copyright 2023, Andreas Suter.
Last updated on Dec 12, 2022. Last updated on Feb 17, 2023.
</p> </p>
</div> </div>
@ -773,7 +887,7 @@ K(m)&amp;=\int_0^{\pi/2}\frac{\mathrm d\varphi}{\sqrt{1-m^2\sin^2{\varphi}}},\en
<script type="text/javascript"> <script type="text/javascript">
var DOCUMENTATION_OPTIONS = { var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./', URL_ROOT:'./',
VERSION:'1.8.2', VERSION:'1.9.0',
LANGUAGE:'None', LANGUAGE:'None',
COLLAPSE_INDEX:false, COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html', FILE_SUFFIX:'.html',

12
doc/html/user-manual.html
View File

@ -8,7 +8,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>User manual &mdash; musrfit 1.8.2 documentation</title> <title>User manual &mdash; musrfit 1.9.0 documentation</title>
@ -58,6 +58,10 @@
<div class="version">
1.9
</div>
@ -2866,8 +2870,8 @@ The syntax here is attribute driven</li>
<div role="contentinfo"> <div role="contentinfo">
<p> <p>
&copy; Copyright 2022, Andreas Suter. &copy; Copyright 2023, Andreas Suter.
Last updated on Dec 12, 2022. Last updated on Feb 17, 2023.
</p> </p>
</div> </div>
@ -2889,7 +2893,7 @@ The syntax here is attribute driven</li>
<script type="text/javascript"> <script type="text/javascript">
var DOCUMENTATION_OPTIONS = { var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./', URL_ROOT:'./',
VERSION:'1.8.2', VERSION:'1.9.0',
LANGUAGE:'None', LANGUAGE:'None',
COLLAPSE_INDEX:false, COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html', FILE_SUFFIX:'.html',