new angle-scan processing features, update documentation, bugfixes

new functions:
- voigt_fwhm_lor
- rotate_hemi_scan
- import_tpi_scan
- draw_diffraction_cone

updated functions:
- interpolate_hemi_scan
- display_hemi_scan
- duplicate_hemi_scan

updated documentation:
- installation instructions
- readme

doc/Doxyfile

@@ -758,7 +758,8 @@ WARN_LOGFILE           =
 # spaces.
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  = ../pearl
+INPUT                  = ../pearl \
+                         src
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@@ -778,7 +779,8 @@ INPUT_ENCODING         = CP1252
 # *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,
 # *.qsf, *.as and *.js.
 
-FILE_PATTERNS          = *.ipf
+FILE_PATTERNS          = *.ipf \
+                         *.dox
 
 # The RECURSIVE tag can be used to specify whether or not subdirectories should
 # be searched for input files as well.
@@ -863,7 +865,7 @@ IMAGE_PATH             =
 # code is scanned, but not when the output code is generated. If lines are added
 # or removed, the anchors will not be placed correctly.
 
-INPUT_FILTER           = "gawk -f doxygen-filter-ipf.awk"
+INPUT_FILTER           =
 
 # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
 # basis. Doxygen will compare the file name with each pattern and apply the
@@ -872,7 +874,7 @@ INPUT_FILTER           = "gawk -f doxygen-filter-ipf.awk"
 # filters are used. If the FILTER_PATTERNS tag is empty or if none of the
 # patterns match the file name, INPUT_FILTER is applied.
 
-FILTER_PATTERNS        = 
+FILTER_PATTERNS        = "*.ipf=\"gawk -f doxygen-filter-ipf.awk\""
 
 # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
 # INPUT_FILTER) will also be used to filter the input files that are used for

doc/makefile

@@ -11,6 +11,9 @@ DOX=doxygen
 DOXOPTS=
 LATEX_DIR=latex
 
+REVISION=$(shell git describe --always --tags --dirty --long)
+export REVISION
+
 all: docs
 
 docs: doxygen pdf
@@ -24,4 +27,3 @@ pdf: doxygen
 clean:
 	-rm latex/*
 	-rm html/*
-

doc/src/mainpage.dox

@@ -0,0 +1,27 @@
+/*! @mainpage Introduction
+\section sec_intro Introduction
+
+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.
+
+
+\section sec_install Installation
+
+PEARL Procedures should be installed according to the regular Igor Pro guidelines. Please read the Igor help `About Igor Pro User Files` for details.
+
+- Make a `pearl-procs` directory in your private or shared `User Procedures` folder, and copy the PEARL Procedures distribution there.
+- Create shortcuts of the `pearl-arpes.ipf` and `pearl-menu.ipf` files, and move them to the `Igor Procedures` folder next to your `User Procedures` folder.
+- Find the `HDF5.XOP` extension in the `Igor Pro Folder` under `More Extensions/File Loaders`, create a shortcut, and move the shortcut to the `Igor Extensions` folder next to your `User Procedures` folder.
+- Find the `HDF5 Help.ihf` next to `HDF5.XOP`, create a shortcut, and move the shortcut to the `Igor Help Files` folder next to your `User Procedures` folder.
+
+
+\section sec_license License Information
+
+An open distribution of PEARL Procedures is available under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0) at <https://git.psi.ch/pearl-public/igor-procs>.
+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.
+
+\author    Matthias Muntwiler, <mailto:matthias.muntwiler@psi.ch>
+\version   This documentation is compiled from revision $(REVISION).
+\copyright 2009-2016 by [Paul Scherrer Institut](http://www.psi.ch)
+\copyright Licensed under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0)
+*/