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

fixed some minor typos in the docu.

Browse Source
This commit is contained in:
suter_a 2019-11-11 12:57:06 +01:00
parent 9d9fb6b663
commit b1b71658f6
9 changed files with 35 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
doc/html/_sources/setup-standard.txt
View File

@ -770,6 +770,11 @@ and ``C:\cygwin\bin\bash.exe`` so that they are executed with administrator priv
Mac OS X / macOS Mac OS X / macOS
---------------- ----------------
.. warning::
2019-10-10: macOS 10.15 Catalina: ``macport``/``fink``/``homebrew`` and hence ``musrfit`` are not yet ready for
this version of macOS. Likely to be ready by end of November 2019.
.. _MacPorts: https://www.macports.org/ .. _MacPorts: https://www.macports.org/
.. _Fink: http://www.finkproject.org/ .. _Fink: http://www.finkproject.org/
@ -779,6 +784,12 @@ or `Fink`_ — which provides open-source software is employed to fulfill the b
In the following, both possibilities (using MacPorts or Fink) are described but it is emphasized here that In the following, both possibilities (using MacPorts or Fink) are described but it is emphasized here that
it should be followed only *one* of the possible routes . it should be followed only *one* of the possible routes .
.. warning::
If you decide to upgrade your macOS, e.g. from ``High Sierra`` to ``Mojave``, you will typically need to
unistall ``musrfit``, ``ROOT``, and `MacPorts`_ / `Fink`_ first, do the upgrade of the macOS and start the
installation of `MacPorts`_ / `Fink`_ , ``ROOT``, and ``musrfit`` from scratch!
.. index:: macports .. index:: macports
Requirements (MacPorts) Requirements (MacPorts)

2
doc/html/_sources/user-manual.txt
View File

@ -632,7 +632,7 @@ name abbr. parameters mathematica
const c const(1) const const c const(1) const
asymmetry a A(1) :math:`A` asymmetry a A(1) :math:`A`
simplExpo se :math:`\lambda (\mu \mathrm{s}^{-1})` :math:`\exp(-\lambda t)` simplExpo se :math:`\lambda (\mu \mathrm{s}^{-1})` :math:`\exp(-\lambda t)`
generExpo ge :math:`\lambda (\mu \mathrm{s}^{-1}) \beta(1)` :math:`\exp\left[(-\lambda t)^\beta\right]` generExpo ge :math:`\lambda (\mu \mathrm{s}^{-1}) \beta(1)` :math:`\exp\left[-(\lambda t)^\beta\right]`
simpleGss sg :math:`\sigma (\mu \mathrm{s}^{-1})` :math:`\exp\left[-\frac{1}{2} (\sigma t)^2\right]` simpleGss sg :math:`\sigma (\mu \mathrm{s}^{-1})` :math:`\exp\left[-\frac{1}{2} (\sigma t)^2\right]`
statGssKT stg :math:`\sigma (\mu \mathrm{s}^{-1})` :math:`\frac{1}{3} + \frac{2}{3} \left[ 1 - (\sigma t)^2\right] \exp\left[-\frac{1}{2} (\sigma t)^2\right]` statGssKT stg :math:`\sigma (\mu \mathrm{s}^{-1})` :math:`\frac{1}{3} + \frac{2}{3} \left[ 1 - (\sigma t)^2\right] \exp\left[-\frac{1}{2} (\sigma t)^2\right]`
statGssKTLF sgktlf :math:`\nu` (MHz), \ :math:`G_{\rm G}^{\rm LF}(t) = 1-\frac{2\sigma^2}{(2\pi\nu)^2} \left[ 1-\exp\left(- \frac{1}{2}\sigma^2t^2\right)\cos(2\pi\nu t)\right]` [#n1]_ statGssKTLF sgktlf :math:`\nu` (MHz), \ :math:`G_{\rm G}^{\rm LF}(t) = 1-\frac{2\sigma^2}{(2\pi\nu)^2} \left[ 1-\exp\left(- \frac{1}{2}\sigma^2t^2\right)\cos(2\pi\nu t)\right]` [#n1]_

4
doc/html/genindex.html
View File

@ -979,8 +979,8 @@
</div> </div>
<div class="footer"> <div class="footer">
&copy; Copyright 2019, Andreas Suter. &copy; Copyright 2019, Andreas Suter.
Last updated on Sep 10, 2019. Last updated on Nov 11, 2019.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3. Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
</div> </div>
</body> </body>
</html> </html>

4
doc/html/index.html
View File

@ -185,8 +185,8 @@
</div> </div>
<div class="footer"> <div class="footer">
&copy; Copyright 2019, Andreas Suter. &copy; Copyright 2019, Andreas Suter.
Last updated on Sep 10, 2019. Last updated on Nov 11, 2019.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3. Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
</div> </div>
</body> </body>
</html> </html>

BIN
doc/html/objects.inv
View File

Binary file not shown.

4
doc/html/search.html
View File

@ -94,8 +94,8 @@
</div> </div>
<div class="footer"> <div class="footer">
&copy; Copyright 2019, Andreas Suter. &copy; Copyright 2019, Andreas Suter.
Last updated on Sep 10, 2019. Last updated on Nov 11, 2019.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3. Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
</div> </div>
</body> </body>
</html> </html>

2
doc/html/searchindex.js
View File

File diff suppressed because one or more lines are too long

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

@ -684,11 +684,22 @@ and <tt class="docutils literal"><span class="pre">C:\cygwin\bin\bash.exe</span>
</div> </div>
<div class="section" id="mac-os-x-macos"> <div class="section" id="mac-os-x-macos">
<h2>Mac OS X / macOS<a class="headerlink" href="#mac-os-x-macos" title="Permalink to this headline"></a></h2> <h2>Mac OS X / macOS<a class="headerlink" href="#mac-os-x-macos" title="Permalink to this headline"></a></h2>
<div class="admonition warning">
<p class="first admonition-title">Warning</p>
<p class="last">2019-10-10: macOS 10.15 Catalina: <tt class="docutils literal"><span class="pre">macport</span></tt>/<tt class="docutils literal"><span class="pre">fink</span></tt>/<tt class="docutils literal"><span class="pre">homebrew</span></tt> and hence <tt class="docutils literal"><span class="pre">musrfit</span></tt> are not yet ready for
this version of macOS. Likely to be ready by end of November 2019.</p>
</div>
<p>With Mac OS X / macOS the situation is up to some extent similar like on MS Windows but still different since <p>With Mac OS X / macOS the situation is up to some extent similar like on MS Windows but still different since
Mac OS X is a UNIX system. The similarity is that also on OS X a helping framework — either <a class="reference external" href="https://www.macports.org/">MacPorts</a> Mac OS X is a UNIX system. The similarity is that also on OS X a helping framework — either <a class="reference external" href="https://www.macports.org/">MacPorts</a>
or <a class="reference external" href="http://www.finkproject.org/">Fink</a> — which provides open-source software is employed to fulfill the basic software requirements of <tt class="docutils literal"><span class="pre">musrfit</span></tt>. or <a class="reference external" href="http://www.finkproject.org/">Fink</a> — which provides open-source software is employed to fulfill the basic software requirements of <tt class="docutils literal"><span class="pre">musrfit</span></tt>.
In the following, both possibilities (using MacPorts or Fink) are described but it is emphasized here that In the following, both possibilities (using MacPorts or Fink) are described but it is emphasized here that
it should be followed only <em>one</em> of the possible routes .</p> it should be followed only <em>one</em> of the possible routes .</p>
<div class="admonition warning">
<p class="first admonition-title">Warning</p>
<p class="last">If you decide to upgrade your macOS, e.g. from <tt class="docutils literal"><span class="pre">High</span> <span class="pre">Sierra</span></tt> to <tt class="docutils literal"><span class="pre">Mojave</span></tt>, you will typically need to
unistall <tt class="docutils literal"><span class="pre">musrfit</span></tt>, <tt class="docutils literal"><span class="pre">ROOT</span></tt>, and <a class="reference external" href="https://www.macports.org/">MacPorts</a> / <a class="reference external" href="http://www.finkproject.org/">Fink</a> first, do the upgrade of the macOS and start the
installation of <a class="reference external" href="https://www.macports.org/">MacPorts</a> / <a class="reference external" href="http://www.finkproject.org/">Fink</a> , <tt class="docutils literal"><span class="pre">ROOT</span></tt>, and <tt class="docutils literal"><span class="pre">musrfit</span></tt> from scratch!</p>
</div>
<div class="section" id="requirements-macports"> <div class="section" id="requirements-macports">
<span id="index-27"></span><h3>Requirements (MacPorts)<a class="headerlink" href="#requirements-macports" title="Permalink to this headline"></a></h3> <span id="index-27"></span><h3>Requirements (MacPorts)<a class="headerlink" href="#requirements-macports" title="Permalink to this headline"></a></h3>
<p>Before proceeding with the usage of the <tt class="docutils literal"><span class="pre">MacPorts</span></tt> system first a few useful tools provided by Apple together <p>Before proceeding with the usage of the <tt class="docutils literal"><span class="pre">MacPorts</span></tt> system first a few useful tools provided by Apple together
@ -1285,8 +1296,8 @@ $ musrview test-histo-ROOT-NPP.msr
</div> </div>
<div class="footer"> <div class="footer">
&copy; Copyright 2019, Andreas Suter. &copy; Copyright 2019, Andreas Suter.
Last updated on Sep 10, 2019. Last updated on Oct 10, 2019.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3. Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
</div> </div>
</body> </body>
</html> </html>

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

@ -616,7 +616,7 @@ in case a <span class="math">\(\chi^2\)</span> single-histogram fit is done, als
<tr class="row-odd"><td>generExpo</td> <tr class="row-odd"><td>generExpo</td>
<td>ge</td> <td>ge</td>
<td><span class="math">\(\lambda (\mu \mathrm{s}^{-1}) \beta(1)\)</span></td> <td><span class="math">\(\lambda (\mu \mathrm{s}^{-1}) \beta(1)\)</span></td>
<td><span class="math">\(\exp\left[(-\lambda t)^\beta\right]\)</span></td> <td><span class="math">\(\exp\left[-(\lambda t)^\beta\right]\)</span></td>
<td>&nbsp;</td> <td>&nbsp;</td>
</tr> </tr>
<tr class="row-even"><td>simpleGss</td> <tr class="row-even"><td>simpleGss</td>
@ -2294,8 +2294,8 @@ In case this cannot be ensured, the parallelization can be disabled by <em>&#821
</div> </div>
<div class="footer"> <div class="footer">
&copy; Copyright 2019, Andreas Suter. &copy; Copyright 2019, Andreas Suter.
Last updated on Sep 10, 2019. Last updated on Nov 11, 2019.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3. Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
</div> </div>
</body> </body>
</html> </html>