README.md

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.


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` (`HDF5-64.xop` for Igor 7 64-bit) extension in the `Igor Pro Folder` under `More Extensions/File Loaders` (`More Extensions (64-bit)/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.

PEARL Procedures are tested on Igor 8.04, 64-bit.
Please make sure to use the latest release version.

While most of the code remains compatible with Igor 6.37, it is not tested and not supported.
Importing recent PShell data files may requires Igor 8 due to changes in the HDF5 library.
Igor 7 contains some bugs which affect PEARL Procedures and should not be used.

As long as no Igor 8 specific features are used (long object names), the produced experiment files remain compatible with Igor 6.


License
=======

The source code 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>.
Please read and respect the respective license agreements.
Please acknowledge the use of the code and share your extensions with the original author.

Author
------

Matthias Muntwiler, <mailto:matthias.muntwiler@psi.ch>

Copyright
---------

Copyright 2009-2021 by [Paul Scherrer Institut](http://www.psi.ch)


Release Notes
=============

## rev-distro-2.2.0

- Updates, bugfixes and performance improvements in angle scan processing.

## rev-distro-2.1.0

- Check compatibility of major features with Igor 8.
- pshell-import does not apply a detector sensitivity scaling any more. The returned intensities have arbitrary units.

## rev-distro-2.0.3

- The interpolate_hemi_scan function now requires a projection argument unless stereographic projection is desired.

## rev-distro-2.0.0

- The interface of data reduction functions has changed to make data reduction more efficient in multi-peak fits. The supplied reduction functions and dialogs have been refactored. If you want to use your own reduction functions written for pre-2.0, you have to adapt them to the new interface.
new angle-scan processing features, update documentation, bugfixes 2016-03-30 12:02:57 +02:00			`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.`


			`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.
updates: igor 7, map projections, hemi cuts, longitudinal section 2016-10-14 16:56:20 +02:00			- Find the `HDF5.XOP` (`HDF5-64.xop` for Igor 7 64-bit) extension in the `Igor Pro Folder` under `More Extensions/File Loaders` (`More Extensions (64-bit)/File Loaders`), create a shortcut, and move the shortcut to the `Igor Extensions` folder next to your `User Procedures` folder.
new angle-scan processing features, update documentation, bugfixes 2016-03-30 12:02:57 +02:00			- 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.

code changes for release 2.2.0 2021-09-09 12:45:39 +02:00			`PEARL Procedures are tested on Igor 8.04, 64-bit.`
distro release 2.1.1 2020-06-09 12:31:05 +02:00			`Please make sure to use the latest release version.`
code changes for release 2.2.0 2021-09-09 12:45:39 +02:00
			`While most of the code remains compatible with Igor 6.37, it is not tested and not supported.`
			`Importing recent PShell data files may requires Igor 8 due to changes in the HDF5 library.`
			`Igor 7 contains some bugs which affect PEARL Procedures and should not be used.`

distro release 2.1.1 2020-06-09 12:31:05 +02:00			`As long as no Igor 8 specific features are used (long object names), the produced experiment files remain compatible with Igor 6.`
README.md: add release notes 2016-06-06 16:04:56 +02:00
new angle-scan processing features, update documentation, bugfixes 2016-03-30 12:02:57 +02:00
			`License`
			`=======`

			`The source code 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>.`
			`Please read and respect the respective license agreements.`
minor bug fixes in angle-scan import and documentation 2018-03-13 12:43:29 +01:00			`Please acknowledge the use of the code and share your extensions with the original author.`
new angle-scan processing features, update documentation, bugfixes 2016-03-30 12:02:57 +02:00
			`Author`
			`------`

			`Matthias Muntwiler, <mailto:matthias.muntwiler@psi.ch>`

			`Copyright`
			`---------`

code changes for release 2.2.0 2021-09-09 12:45:39 +02:00			`Copyright 2009-2021 by [Paul Scherrer Institut](http://www.psi.ch)`
new angle-scan processing features, update documentation, bugfixes 2016-03-30 12:02:57 +02:00
README.md: add release notes 2016-06-06 16:04:56 +02:00
			`Release Notes`
README.md: fix heading levels 2016-06-06 16:07:19 +02:00			`=============`
README.md: add release notes 2016-06-06 16:04:56 +02:00
code changes for release 2.2.0 2021-09-09 12:45:39 +02:00			`## rev-distro-2.2.0`

			`- Updates, bugfixes and performance improvements in angle scan processing.`

igor 8 compatibility 2019-08-14 17:56:14 +02:00			`## rev-distro-2.1.0`

			`- Check compatibility of major features with Igor 8.`
			`- pshell-import does not apply a detector sensitivity scaling any more. The returned intensities have arbitrary units.`

bug fixes in angle scan processing and documentation 2019-02-28 18:55:29 +01:00			`## rev-distro-2.0.3`

			`- The interpolate_hemi_scan function now requires a projection argument unless stereographic projection is desired.`

new features: data reduction, angle scan panel 2018-02-06 11:39:57 +01:00			`## rev-distro-2.0.0`

			`- The interface of data reduction functions has changed to make data reduction more efficient in multi-peak fits. The supplied reduction functions and dialogs have been refactored. If you want to use your own reduction functions written for pre-2.0, you have to adapt them to the new interface.`