pearl-public/igor-public
2
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
5d7bd9992fee17ee4bd22cf218b2154bf63b9c89
igor-public/doc/html/index.html
matthias muntwiler 70207096d5
Some checks failed
build and deploy documentation / build-and-deploy (push) Failing after 0s
Details
documentation for 3.1.0
2025-12-22 17:29:05 +01:00

137 lines
7.3 KiB
HTML
Raw Blame History

<!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.9.8"/>
<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>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></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>
<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">PEARL Procedures<span id="projectnumber">&#160;rev-distro-3.1.0-0-gea838b3-dirty</span>
</div>
<div id="projectbrief">Igor procedures for the analysis of PEARL data</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @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&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @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&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('index.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div><div class="header">
<div class="headertitle"><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_intro">Introduction</a></li>
<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>
<h1><a class="anchor" id="sec_install"></a>
Installation</h1>
<p>PEARL Procedures are tested on Igor Pro 8.04, 64-bit. Earlier versions of Igor Pro are not supported.</p>
<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>
</ul>
<p>Igor Pro 9 imports the HDF5 library by default. For earlier versions:</p>
<ul>
<li>Find the <code>HDF5.XOP</code> (<code>HDF5-64.xop</code> for 64-bit) extension in the <code>Igor Pro Folder</code> under <code>More Extensions/File Loaders</code> (<code>More Extensions (64-bit)/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>
<h1><a class="anchor" id="sec_license"></a>
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 class="obfuscator">.nosp@m.</span>ias.<span class="obfuscator">.nosp@m.</span>muntw<span class="obfuscator">.nosp@m.</span>iler<span class="obfuscator">.nosp@m.</span>@psi.<span class="obfuscator">.nosp@m.</span>ch</a> </dd></dl>
<dl class="section version"><dt>Version</dt><dd>This documentation is compiled from version rev-distro-3.1.0-0-gea838b3-dirty. </dd></dl>
<dl class="section copyright"><dt>Copyright</dt><dd>2009-2025 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>
</div></div><!-- PageDoc -->
</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 on Mon Dec 22 2025 17:26:40 for PEARL Procedures by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8 </li>
</ul>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink