131 lines
8.2 KiB
HTML
131 lines
8.2 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
|
|
<meta name="generator" content="Doxygen 1.13.2"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>musrfit: musrfit - a framework to analyse muSR data.</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<script type="text/javascript" src="clipboard.js"></script>
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="cookie.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr id="projectrow">
|
|
<td id="projectalign">
|
|
<div id="projectname">musrfit<span id="projectnumber"> 1.9.9</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.13.2 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() { codefold.init(0); });
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() {
|
|
initMenu('',false,false,'search.php','Search',true);
|
|
});
|
|
/* @license-end */
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function(){initNavTree('index.html',''); initResizable(true); });
|
|
/* @license-end */
|
|
</script>
|
|
<div id="doc-content">
|
|
<div><div class="header">
|
|
<div class="headertitle"><div class="title">musrfit - a framework to analyse muSR data. </div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="textblock"><p>This pages here are meant to explain the software structure of the musrfit framework.</p>
|
|
<p>People merely interested in the handling of the programs should check this link:
|
|
<a href="https://lmu.pages.psi.ch/musrfit-docu/">musrfit user manual</a>
|
|
</p>
|
|
<p>People which would like to know how to install the musrfit framework, please check this link:
|
|
<a href="https://lmu.pages.psi.ch/musrfit-docu/setup-standard.html">How to setup musrfit on different platforms</a>
|
|
</p>
|
|
<h1><a class="anchor" id="overview"></a>
|
|
Overview</h1>
|
|
<p>The purpose of the musrfit framework is to provide software to analyze muSR spectra, in a very flexible and sound way. The musrfit framework is free software, published under the General Public License Version 2 or later. It is currently running under Linux, Mac OS X, and (with some more work) under Windows. The musrfit framework heavily relies on the <a href="http://root.cern.ch">ROOT</a> framework from CERN</p>
|
|
<p>The musrfit framework provides the following programs:</p><ul>
|
|
<li><b>musrfit</b>: carries out fits based on a msr-file.</li>
|
|
<li><b>musrview</b>: is used show the data in a graphical representation.</li>
|
|
<li><b>musrFT</b>: is used to show Fourier transforms of data without the need of a theory (raw data Fourier transform).</li>
|
|
<li><b>musrt0</b>: is used to set graphically t0's, background and data ranges off raw histogram data.</li>
|
|
<li><b>msr2data</b>: a program (originally written by Bastian M. Wojek). Its purpose is to process/generate multiple musrfit msr-files with the same parameters and summarize the fitting results either in a TRIUMF DB or a column ASCII file.</li>
|
|
<li><b>msr2msr</b>: old WKM like msr-files can be transformed into musrfit style msr-files with this little program.</li>
|
|
<li>musrgui (obsolete): an editor to handle msr-files, calling musrfit, etc. from within the editor, based on Qt3.x.</li>
|
|
<li><b>musredit</b>: an editor to handle msr-files, calling musrfit, etc. from within a simple text editor, based on Qt5.x (soon being deprecated) or Qt6.x. A technical documentation of musredit can be found <a href="./musredit/html/index.html">here.</a></li>
|
|
<li><b>musrWiz</b> (beta): allows to create an initial msr-file by a step-by-step instruction wizard. A technical documentation of musrWiz can be found <a href="./musrWiz/html/index.html">here.</a></li>
|
|
<li><b>musrStep</b>: allows to efficiently deal with initial step values of msr-files. Especially useful for msr-files dealing with many runs/detectors. A technical documentation of musrStep can be found <a href="./musrStep/html/index.html">here.</a></li>
|
|
<li><b>mupp</b>: is the muSR parameter plotter. It allows to plot values in db- or dat-files (collections). A technical documentation of mupp can be found <a href="./mupp/html/index.html">here.</a></li>
|
|
<li><b>addRun</b>: allows to add runs from the command line</li>
|
|
<li><b>any2many</b>: should be a "universal" muSR data-file-format converter.</li>
|
|
<li><b>dump_header</b>: is a small program to dump the header information of a muSR data file to the standard output.</li>
|
|
<li><b>musrRootValidation</b>: this is a program to validate MusrRoot files.</li>
|
|
<li><b>write_musrRoot_runHeader</b>: Is a little example program showing how to write MusrRoot files.</li>
|
|
</ul>
|
|
<h1><a class="anchor" id="roadmap"></a>
|
|
Road map and missing features</h1>
|
|
<p>The following features should eventually be implemented, but are still missing:</p><ul>
|
|
<li>non-muSR: The plan is to add an option to fit/plot <picture><source srcset="form_0_dark.png" media="(prefers-color-scheme: dark)"/><img class="formulaInl" alt="$f(x_1,\ldots,x_n)$" src="form_0.png"/></picture> versus <picture><source srcset="form_1_dark.png" media="(prefers-color-scheme: dark)"/><img class="formulaInl" alt="$g(x_1,\ldots,x_n)$" src="form_1.png"/></picture>, where <picture><source srcset="form_2_dark.png" media="(prefers-color-scheme: dark)"/><img class="formulaInl" alt="$x_i$" src="form_2.png"/></picture> is a given data set element.</li>
|
|
<li>add an interface to maxent</li>
|
|
</ul>
|
|
<h1><a class="anchor" id="shortComings"></a>
|
|
Short comings of the current musrfit design</h1>
|
|
<p>The musrfit framework has some shortcomings which will shortly discussed here:</p>
|
|
<ol type="1">
|
|
<li>musrfit is not fully thread save do to the current implementation of LF in <a class="el" href="classPTheory.html" title="Theory function evaluator and expression tree manager.">PTheory</a>. Perhaps this part should be redesigned at some point to resolve this problem.</li>
|
|
<li>Currently each msr-file run holds its one theory object. This is not very nice for costly user functions which will need to setup internal things for each run, even though resources could be shared.</li>
|
|
</ol>
|
|
<p>This two points are somewhat contradictory, and currently it is not clear which way to go.</p>
|
|
<h1><a class="anchor" id="bugs"></a>
|
|
How to report bugs</h1>
|
|
<p>Bugs, unexpected features, can be reported directly to me: </p><pre class="fragment">andreas.suter@psi.ch, </pre><p> or entered in the bug-tracking tool at
|
|
<a href="https://bitbucket.org/muonspin/musrfit/issues">bitbucket issue tracker</a>
|
|
</p>
|
|
</div></div><!-- PageDoc -->
|
|
<a href="doxygen_crawl.html"></a>
|
|
</div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.13.2 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|