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

updated the docu

Browse Source
This commit is contained in:
suter_a
2015-08-16 11:45:58 +02:00
parent b113a94ee9
commit 05430b8745
13 changed files with 431 additions and 278 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
doc/html/user/MUSR/Msr2Data.html
View File

@@ -1,6 +1,6 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US">
<!-- Mirrored from intranet.psi.ch/MUSR/Msr2Data?cover=print by HTTrack Website Copier/3.x [XR&CO'2010], Fri, 29 May 2015 18:02:07 GMT -->
<!-- Mirrored from intranet.psi.ch/MUSR/Msr2Data?cover=print by HTTrack Website Copier/3.x [XR&CO'2010], Sun, 16 Aug 2015 09:27:41 GMT -->
<!-- Added by HTTrack --><meta http-equiv="content-type" content="text/html;charset=iso-8859-1"><!-- /Added by HTTrack -->
<head>
<link rel="stylesheet" href="../pub/System/HeadlinesPlugin/style.css" type="text/css" media="all" />
@@ -8,7 +8,7 @@
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<link rel="icon" href="../pub/Main/WebPreferences/favicon.ico" type="image/x-icon" />
<link rel="shortcut icon" href="../pub/Main/WebPreferences/favicon.ico" type="image/x-icon" />
<link rel="alternate" href="https://intranet.psi.ch/wiki/bin/edit/MUSR/Msr2Data?t=1432922467" type="application/x-wiki" title="edit Msr2Data" />
<link rel="alternate" href="https://intranet.psi.ch/wiki/bin/edit/MUSR/Msr2Data?t=1439717204" type="application/x-wiki" title="edit Msr2Data" />
<meta name="TEXT_NUM_TOPICS" content="Number of topics:" />
<meta name="TEXT_MODIFY_SEARCH" content="Modify search" />
<meta name="robots" content="noindex" /><link rel="alternate" type="application/rss+xml" title="RSS Feed" href="WebRsshtml.html" />
@@ -160,7 +160,7 @@ Notes
Apart from numerous <a href="#OptionalParameters" class="foswikiCurrentTopicLink">optional parameters</a> that might be set or not, in principle there are four different ways of calling <code>msr2data</code>. These differ in how the list of runs which should be processed is supplied: <dl>
<dt> msr2data &lt;run&gt; &lt;extension&gt; [optional parameters] </dt><dd> A single run number.
</dd> <dt> msr2data &lt;firstRunNo&gt; &lt;lastRunNo&gt; &lt;extension&gt; [optional parameters] </dt><dd> An interval of run numbers is specified through the first and the last run number. The condition <strong>&lt;firstRunNo&gt; &lt; &lt;lastRunNo&gt;</strong> is <em>not</em> necessary.
</dd> <dt> msr2data \[&lt;run1&gt; &lt;run2&gt; ... &lt;runN&gt; \] &lt;extension&gt; [optional parameters] </dt><dd> A space separated list of run numbers can be enclosed in <strong>[</strong> and <strong>]</strong>. Every run that should be processed has to be specified explicitly by its run number.
</dd> <dt> msr2data \[ &lt;runList&gt; \] &lt;extension&gt; [optional parameters] </dt><dd> Where &lt;runList&gt; is one or a combination of the following:(i) <strong>&lt;run0&gt;, &lt;run1&gt;, &lt;run2&gt;, ... &lt;runN&gt;</strong> : run numbers, e.g. 123 124, (ii) <strong>&lt;run0&gt;-&lt;runN&gt;</strong> : a range, e.g. 123-125 -&gt; 123 124 125, (iii) <strong>&lt;run0&gt;:&lt;runN&gt;:&lt;step&gt;</strong> : a sequence, e.g. 123:127:2 -&gt; 123 125 127. &lt;step&gt; has to be a <strong>positive</strong> integer. A &lt;runList&gt; can also combine (i)-(iii), e.g. 123 128-130 133, etc.
</dd> <dt> msr2data &lt;runListFileName&gt; &lt;extension&gt; [optional parameters] </dt><dd> An ASCII file containing a list of run numbers and optional external parameters is passed to <code>msr2data</code>. For the structure of the ASCII file see <a href="#RunListStructure" class="foswikiCurrentTopicLink">below</a>.
</dd></dl>
<p></p>
@@ -168,6 +168,7 @@ All four basic types of calling <code>msr2data</code> contain the <em>mandatory<
<pre class="bash">msr2data 8472 &#95;tf&#95;h13</pre> generates the <strong>DB</strong> file <code><b>out.db</b></code> (can be changed by using <a href="#OptionalParameters" class="foswikiCurrentTopicLink">the -o option</a>) from <code><b>8472_tf_h13.msr</b></code>.
<pre class="bash">msr2data 8472 8474 &#95;tf&#95;h13</pre> generates the <strong>DB</strong> file <code><b>out.db</b></code> (can be changed by using <a href="#OptionalParameters" class="foswikiCurrentTopicLink">the -o option</a>) from <code><b>8472_tf_h13.msr</b></code>, <code><b>8473_tf_h13.msr</b></code>, and <code><b>8474_tf_h13.msr</b></code>.
<pre class="bash">msr2data &#91;8472 8470] &#95;tf&#95;h13</pre> generates the <strong>DB</strong> file <code><b>out.db</b></code> (can be changed by using <a href="#OptionalParameters" class="foswikiCurrentTopicLink">the -o option</a>) from <code><b>8472_tf_h13.msr</b></code> and <code><b>8470_tf_h13.msr</b></code>.
<pre class="bash">msr2data &#91;8470:8474:2] &#95;tf&#95;h13</pre> generates the <strong>DB</strong> file <code><b>out.db</b></code> (can be changed by using <a href="#OptionalParameters" class="foswikiCurrentTopicLink">the -o option</a>) from <code><b>8470_tf_h13.msr</b></code>, <code><b>8472_tf_h13.msr</b></code>, and <code><b>8474_tf_h13.msr</b></code>.
<pre class="bash">msr2data run.list &#95;tf&#95;h13</pre> generates the <strong>DB</strong> file <code><b>out.db</b></code> (can be changed by using <a href="#OptionalParameters" class="foswikiCurrentTopicLink">the -o option</a>) from all runs listed in the ASCII file <code><b>run.list</b></code> in the working directory. In this file it is also possible to include external parameters which should be put in the resulting <strong>DB</strong> file. The structure of the <code><b>run.list</b></code> is the following:
<a name="RunListStructure"></a>
<pre>
@@ -214,9 +215,9 @@ msr2data 8400 8460 &#95;tf&#95;h13 -oABC.db fit-8472
</pre>
Using <code><b>8472_tf_h13.msr</b></code> as first template, <code>msr2data</code> generates subsequent msr input files <code><b>8400_tf_h13.msr</b></code> through <code><b>8460_tf_h13.msr</b></code>, calls <code>musrfit</code> to perform a fit of these files and collects the results of the fits together with the <strong>DB</strong> header in the new file <code><b>ABC.db</b></code>. Additionally, some information about external parameters like the temperature will be passed to <code><b>ABC.db</b></code> if it is present in the data files.
<pre class="bash">
msr2data &#91;8500 8505] &#95;zf fit-8472 noheader nosummary -o DEF.db
msr2data &#91;8500 8502-8504 8507] &#95;zf fit-8472 noheader nosummary -o DEF.db
</pre>
Using <code><b>8472_zf.msr</b></code> as first template, <code>msr2data</code> generates subsequent msr input files <code><b>8500_zf.msr</b></code> and <code><b>8505_zf.msr</b></code>, calls <code>musrfit</code> to perform a fit of these files and collects the results of the fits in the file <code><b>DEF.db</b></code> without writing the <strong>DB</strong> file header or attempting to read additional information from the data files.
Using <code><b>8472_zf.msr</b></code> as first template, <code>msr2data</code> generates subsequent msr input files <code><b>8500_zf.msr</b></code>, <code><b>8502_zf.msr</b></code>, <code><b>8503_zf.msr</b></code>, <code><b>8504_zf.msr</b></code> and <code><b>8507_zf.msr</b></code>, calls <code>musrfit</code> to perform a fit of these files and collects the results of the fits in the file <code><b>DEF.db</b></code> without writing the <strong>DB</strong> file header or attempting to read additional information from the data files.
<pre class="bash">
msr2data 8595 8585 &#34;&#34; noheader fit-8472! -oGHI.dat data nosummary -k
</pre>
@@ -337,7 +338,7 @@ msr2data 8471 8470 -OneRunFit&#95;example -o OneRunFits.db
<a name="BugTracking"></a>
<h1><a name="A_7_Bugtracking"></a> 7 Bugtracking </h1>
<p></p>
For reporting bugs or requesting new features and improvements please use the <a href="https://tracker.intranet.psi.ch/jira/browse/MUSR" target="_top">PSI Tracker</a> or send an e-mail to A. Suter.
For reporting bugs or requesting new features and improvements please use the <a href="https://bitbucket.org/muonspin/musrfit/issues?status=new&amp;status=open" target="_top">Bitbucket Issues</a>, <a href="https://tracker.psi.ch/jira/browse/MUSR" target="_top">PSI Tracker</a> or send an e-mail to A. Suter.
<p></p>
-- <a href="http://www.fsf.org/register_form?referrer=8369" target="_top">BMW</a> &amp; <a href="http://lmu.web.psi.ch/lem/group.html" target="_top">AS</a> </div>
<div class="foswikiContentFooter"></div><!-- -->
@@ -351,7 +352,7 @@ For reporting bugs or requesting new features and improvements please use the <a
<!-- -->
<!-- --><!-- -->
<!-- -->
<!-- TAB --><div id='jqTab3625' class="attachments jqAjaxTab jqTab {url: 'https://intranet.psi.ch/wiki/bin/rest/RenderPlugin/template?name=metadata;expand=attachments;topic=MUSR.Msr2Data;render=on;1432922467'}">
<!-- TAB --><div id='jqTab533' class="attachments jqAjaxTab jqTab {url: 'https://intranet.psi.ch/wiki/bin/rest/RenderPlugin/template?name=metadata;expand=attachments;topic=MUSR.Msr2Data;render=on;1439717204'}">
<h2 class='jqTabLabel'>Attachments <span class='foswikiAttachmentsCount'>(1)</span></h2>
<div class='jqTabContents' >
<div class='foswikiFormSteps foswikiAttachmentsProcess'><span class='jqAjaxLoader'>&nbsp;</span></div>
@@ -373,9 +374,9 @@ For reporting bugs or requesting new features and improvements please use the <a
<div class="foswikiFormSteps">
<a name="topic-actions"></a>
<div class="patternTopicActions foswikiFormStep">
<span class="patternActionButtons"><span><a href='https://intranet.psi.ch/wiki/bin/edit/MUSR/Msr2Data?t=1432922467' rel='nofollow' title='Edit this topic text' accesskey='e'><span class='foswikiAccessKey'>E</span>dit</a></span><span class='foswikiSeparator'>&nbsp;|&nbsp;</span><span class="foswikiRequiresChangePermission"><a href='https://intranet.psi.ch/wiki/bin/attach/MUSR/Msr2Data' rel='nofollow' title='Attach an image or document to this topic' accesskey='a'><span class='foswikiAccessKey'>A</span>ttach</a></span><span class='foswikiSeparator'>&nbsp;|&nbsp;</span><span><a href='Msr2Datac99a.html?cover=print;cover=print' rel='nofollow' title='Printable version of this topic' accesskey='p'><span class='foswikiAccessKey'>P</span>rint version</a></span><span class='foswikiSeparator'>&nbsp;|&nbsp;</span><span><a href='https://intranet.psi.ch/print/php/pdf.php?url=MUSR/Msr2Data?cover=print' title='PDF version of this topic'>PDF</a></span><span class='foswikiSeparator'>&nbsp;|&nbsp;</span><span><span class="foswikiRequiresChangePermission"><a href='https://intranet.psi.ch/wiki/bin/oops/MUSR/Msr2Data?template=oopshistory' rel='nofollow' title='View total topic history' accesskey='h'><span class='foswikiAccessKey'>H</span>istory</a></span>: r38&nbsp;<a rel="nofollow" href="https://intranet.psi.ch/wiki/bin/compare/MUSR/Msr2Data?rev1=37;rev2=38">&lt;</a>&nbsp;<a rel="nofollow" href="https://intranet.psi.ch/MUSR/Msr2Data?rev=37">r37</a>&nbsp;<a rel="nofollow" href="https://intranet.psi.ch/wiki/bin/compare/MUSR/Msr2Data?rev1=36;rev2=37">&lt;</a>&nbsp;<a rel="nofollow" href="https://intranet.psi.ch/MUSR/Msr2Data?rev=36">r36</a>&nbsp;<a rel="nofollow" href="https://intranet.psi.ch/wiki/bin/compare/MUSR/Msr2Data?rev1=35;rev2=36">&lt;</a>&nbsp;<a rel="nofollow" href="https://intranet.psi.ch/MUSR/Msr2Data?rev=35">r35</a></span><span class='foswikiSeparator'>&nbsp;|&nbsp;</span><span><a href='https://intranet.psi.ch/MUSR/Msr2Data?template=backlinksweb' rel='nofollow' title='Search the MUSR Web for topics that link to here' accesskey='b'><span class='foswikiAccessKey'>B</span>acklinks</a></span><span class='foswikiSeparator'>&nbsp;|&nbsp;</span><span><a href='https://intranet.psi.ch/MUSR/Msr2Data?raw=on' rel='nofollow' title='View without formatting' accesskey='v'><span class='foswikiAccessKey'>V</span>iew wiki text</a></span><span class='foswikiSeparator'>&nbsp;|&nbsp;</span><span><a href='https://intranet.psi.ch/MUSR/Msr2Data?refresh=on' title='Refresh images and LaTeX charts'>Refresh</a></span><span class='foswikiSeparator'>&nbsp;|&nbsp;</span><span><a href='https://intranet.psi.ch/MUSR/Msr2Data?template=more&amp;maxrev=38&amp;currrev=38' rel='nofollow' title='Delete or rename this topic; set parent topic; view and compare revisions' accesskey='m'><span class='foswikiAccessKey'>M</span>ore topic actions</a></span></span>
<span class="patternActionButtons"><span><a href='https://intranet.psi.ch/wiki/bin/edit/MUSR/Msr2Data?t=1439717204' rel='nofollow' title='Edit this topic text' accesskey='e'><span class='foswikiAccessKey'>E</span>dit</a></span><span class='foswikiSeparator'>&nbsp;|&nbsp;</span><span class="foswikiRequiresChangePermission"><a href='https://intranet.psi.ch/wiki/bin/attach/MUSR/Msr2Data' rel='nofollow' title='Attach an image or document to this topic' accesskey='a'><span class='foswikiAccessKey'>A</span>ttach</a></span><span class='foswikiSeparator'>&nbsp;|&nbsp;</span><span><a href='Msr2Datac99a.html?cover=print;cover=print' rel='nofollow' title='Printable version of this topic' accesskey='p'><span class='foswikiAccessKey'>P</span>rint version</a></span><span class='foswikiSeparator'>&nbsp;|&nbsp;</span><span><a href='https://intranet.psi.ch/print/php/pdf.php?url=MUSR/Msr2Data?cover=print' title='PDF version of this topic'>PDF</a></span><span class='foswikiSeparator'>&nbsp;|&nbsp;</span><span><span class="foswikiRequiresChangePermission"><a href='https://intranet.psi.ch/wiki/bin/oops/MUSR/Msr2Data?template=oopshistory' rel='nofollow' title='View total topic history' accesskey='h'><span class='foswikiAccessKey'>H</span>istory</a></span>: r39&nbsp;<a rel="nofollow" href="https://intranet.psi.ch/wiki/bin/compare/MUSR/Msr2Data?rev1=38;rev2=39">&lt;</a>&nbsp;<a rel="nofollow" href="https://intranet.psi.ch/MUSR/Msr2Data?rev=38">r38</a>&nbsp;<a rel="nofollow" href="https://intranet.psi.ch/wiki/bin/compare/MUSR/Msr2Data?rev1=37;rev2=38">&lt;</a>&nbsp;<a rel="nofollow" href="https://intranet.psi.ch/MUSR/Msr2Data?rev=37">r37</a>&nbsp;<a rel="nofollow" href="https://intranet.psi.ch/wiki/bin/compare/MUSR/Msr2Data?rev1=36;rev2=37">&lt;</a>&nbsp;<a rel="nofollow" href="https://intranet.psi.ch/MUSR/Msr2Data?rev=36">r36</a></span><span class='foswikiSeparator'>&nbsp;|&nbsp;</span><span><a href='https://intranet.psi.ch/MUSR/Msr2Data?template=backlinksweb' rel='nofollow' title='Search the MUSR Web for topics that link to here' accesskey='b'><span class='foswikiAccessKey'>B</span>acklinks</a></span><span class='foswikiSeparator'>&nbsp;|&nbsp;</span><span><a href='https://intranet.psi.ch/MUSR/Msr2Data?raw=on' rel='nofollow' title='View without formatting' accesskey='v'><span class='foswikiAccessKey'>V</span>iew wiki text</a></span><span class='foswikiSeparator'>&nbsp;|&nbsp;</span><span><a href='https://intranet.psi.ch/MUSR/Msr2Data?refresh=on' title='Refresh images and LaTeX charts'>Refresh</a></span><span class='foswikiSeparator'>&nbsp;|&nbsp;</span><span><a href='https://intranet.psi.ch/MUSR/Msr2Data?template=more&amp;maxrev=39&amp;currrev=39' rel='nofollow' title='Delete or rename this topic; set parent topic; view and compare revisions' accesskey='m'><span class='foswikiAccessKey'>M</span>ore topic actions</a></span></span>
</div>
</div></div><div class="patternInfo"><span class="patternRevInfo">Topic revision: r38 - 20 Jul 2011, wojek</span></div>
</div></div><div class="patternInfo"><span class="patternRevInfo">Topic revision: r39 - 16 Aug 2015, <a href="https://intranet.psi.ch/Main/AndreasSuter">AndreasSuter</a></span></div>
</div>
</div><div id="patternSideBar"><div id="patternClearHeaderLeft"></div>
<div id="patternSideBarContents">
@@ -419,7 +420,7 @@ For reporting bugs or requesting new features and improvements please use the <a
</div>
</div>
</div></body>
<!-- Mirrored from intranet.psi.ch/MUSR/Msr2Data?cover=print by HTTrack Website Copier/3.x [XR&CO'2010], Fri, 29 May 2015 18:02:09 GMT -->
<!-- Mirrored from intranet.psi.ch/MUSR/Msr2Data?cover=print by HTTrack Website Copier/3.x [XR&CO'2010], Sun, 16 Aug 2015 09:27:42 GMT -->
<!-- Added by HTTrack --><meta http-equiv="content-type" content="text/html;charset=iso-8859-1"><!-- /Added by HTTrack -->
</html>
<p></p>