new user distribution of PEARL procedures

pearl/pearl-preparation.ipf

@@ -0,0 +1,73 @@
+#pragma rtGlobals=3		// Use modern global access method and strict wave access.
+#pragma IgorVersion = 6.1
+#pragma ModuleName = PearlPreparation
+#pragma version = 1.04
+#include "pearl-area-display" // 2D and 3D data visualization
+#include "pearl-area-profiles" // data processing for multi-dimensional datasets
+#include "pearl-elog"
+#if exists("pvOpen")
+#include "pearl-epics" // EPICS access under Igor
+#include "pearl-anneal" // automated sample annealing
+#endif
+
+// author: matthias.muntwiler@psi.ch
+// Copyright (c) 2015 Paul Scherrer Institut
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+//   you may not use this file except in compliance with the License.
+//   You may obtain a copy of the License at
+//   http://www.apache.org/licenses/LICENSE-2.0
+
+/// @file
+/// @brief PEARL sample preparation package
+///
+/// this procedure defines the PEARL sample preparation package
+/// the main purpose of this file is to load the necessary dependent procedures
+/// (see the include statements at the top)
+///
+/// @pre
+/// * on-line process control functionality requires the EPICS XOP to be loaded
+///
+/// @author matthias muntwiler, matthias.muntwiler@psi.ch
+///
+/// @copyright 2015 Paul Scherrer Institut @n
+/// Licensed under the Apache License, Version 2.0 (the "License"); @n
+///   you may not use this file except in compliance with the License. @n
+///   You may obtain a copy of the License at
+///   http://www.apache.org/licenses/LICENSE-2.0
+
+/// @namespace PearlPreparation
+/// @brief PEARL sample preparation package
+///
+/// PearlPreparation is declared in @ref pearl-preparation.ipf.
+///
+
+/// @defgroup PreparationPackage Sample preparation package
+/// @brief PEARL sample preparation package
+///
+/// The purpose of a package is to load a bunch of dependent procedure files.
+/// The sample preparation package loads the following files.
+///
+/// * pearl-area-import.ipf
+/// * pearl-area-display.ipf
+/// * pearl-area-profiles.ipf
+/// * pearl-elog.ipf
+/// * pearl-anneal.ipf
+///
+/// The following files are loaded if the EPICS.XOP is present:
+///
+/// * pearl-epics.ipf
+///
+
+/// initializes package data once when the procedure is first loaded
+static function AfterCompiledHook()
+
+	dfref savefolder = GetDataFolderDFR()
+
+	return 0
+end
+
+function UnloadPearlPreparationPackage()
+	execute /p/q/z "DELETEINCLUDE \"pearl-preparation\""
+	execute /p/q/z "COMPILEPROCEDURES "
+end