make documentation for release 2.0.2

This commit is contained in:
2019-02-10 14:39:57 +01:00
parent 3235d52212
commit 9a81493a1a
85 changed files with 1821 additions and 22953 deletions

View File

@@ -3,7 +3,8 @@
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>PEARL Procedures: Introduction</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
@@ -14,14 +15,10 @@
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
@@ -32,7 +29,7 @@
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">PEARL Procedures
&#160;<span id="projectnumber">rev-distro-2.0.0-0-gfda49c3-dirty</span>
&#160;<span id="projectnumber">rev-distro-2.0.2-0-g3235d52</span>
</div>
<div id="projectbrief">Igor procedures for the analysis of PEARL data</div>
</td>
@@ -41,35 +38,19 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li class="current"><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li><a href="modules.html"><span>Packages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
@@ -104,6 +85,11 @@ $(document).ready(function(){initNavTree('index.html','');});
<div class="title">Introduction </div> </div>
</div><!--header-->
<div class="contents">
<div class="toc"><h3>Table of Contents</h3>
<ul><li class="level1"><a href="#sec_install">Installation</a></li>
<li class="level1"><a href="#sec_license">License Information</a></li>
</ul>
</div>
<div class="textblock"><h1><a class="anchor" id="sec_intro"></a>
Introduction</h1>
<p>PEARL Procedures is a suite of Igor Pro procedures developed for data acquisition and data processing at the PEARL beamline at the Swiss Light Source.</p>
@@ -112,7 +98,7 @@ Installation</h1>
<p>PEARL Procedures should be installed according to the regular Igor Pro guidelines. Please read the Igor help <code>About Igor Pro User Files</code> for details.</p>
<ul>
<li>Make a <code>pearl-procs</code> directory in your private or shared <code>User Procedures</code> folder, and copy the PEARL Procedures distribution there.</li>
<li>Create shortcuts of the <code><a class="el" href="pearl-arpes_8ipf.html" title="data acquisition and analysis package for ARPES at PEARL. ">pearl-arpes.ipf</a></code> and <code><a class="el" href="pearl-menu_8ipf.html">pearl-menu.ipf</a></code> files, and move them to the <code>Igor Procedures</code> folder next to your <code>User Procedures</code> folder.</li>
<li>Create shortcuts of the <code><a class="el" href="pearl-arpes_8ipf.html">pearl-arpes.ipf</a></code> and <code><a class="el" href="pearl-menu_8ipf.html">pearl-menu.ipf</a></code> files, and move them to the <code>Igor Procedures</code> folder next to your <code>User Procedures</code> folder.</li>
<li>Find the <code>HDF5.XOP</code> extension in the <code>Igor Pro Folder</code> under <code>More Extensions/File Loaders</code>, create a shortcut, and move the shortcut to the <code>Igor Extensions</code> folder next to your <code>User Procedures</code> folder.</li>
<li>Find the <code>HDF5 Help.ihf</code> next to <code>HDF5.XOP</code>, create a shortcut, and move the shortcut to the <code>Igor Help Files</code> folder next to your <code>User Procedures</code> folder.</li>
</ul>
@@ -120,7 +106,7 @@ Installation</h1>
License Information</h1>
<p>An open distribution of PEARL Procedures is available under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a> at <a href="https://git.psi.ch/pearl-public/igor-procs">https://git.psi.ch/pearl-public/igor-procs</a>. Users of PEARL Procedures are requested to coordinate and share the development of the code with the original author. Please read and respect the respective license agreements.</p>
<dl class="section author"><dt>Author</dt><dd>Matthias Muntwiler, <a href="#" onclick="location.href='mai'+'lto:'+'mat'+'th'+'ias'+'.m'+'unt'+'wi'+'ler'+'@p'+'si.'+'ch'; return false;">matth<span style="display: none;">.nosp@m.</span>ias.<span style="display: none;">.nosp@m.</span>muntw<span style="display: none;">.nosp@m.</span>iler<span style="display: none;">.nosp@m.</span>@psi.<span style="display: none;">.nosp@m.</span>ch</a> </dd></dl>
<dl class="section version"><dt>Version</dt><dd>This documentation is compiled from version rev-distro-2.0.0-0-gfda49c3-dirty. </dd></dl>
<dl class="section version"><dt>Version</dt><dd>This documentation is compiled from version rev-distro-2.0.2-0-g3235d52. </dd></dl>
<dl class="section copyright"><dt>Copyright</dt><dd>2009-2016 by <a href="http://www.psi.ch">Paul Scherrer Institut</a> </dd>
<dd>
Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a> </dd></dl>
@@ -129,9 +115,9 @@ Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache L
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated on Tue Mar 13 2018 12:43:01 for PEARL Procedures by
<li class="footer">Generated on Sun Feb 10 2019 14:39:17 for PEARL Procedures by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
</ul>
</div>
</body>