GSI
FRS

 

 

SATAN Help

How to install SATAN on WINDOWS    

If you want to use the complete functionality of SATAN, including the analysis of list-mode data and the preparation of user-defined fit functions, you need to compile and link SATAN on your local computer. The necessary steps are described in the following.

SATAN can be installed on WINDOWS95, WINDOWS98, WINDOWS/NT, and WINDOWS2000.    

******************************************************************************************
* The source code of SATAN is freely available for application in research.
* Any commercial use is prohibited. (Copyright Karl-Heinz Schmidt)           
* The code is provided "AS IS", without warranty of any kind. We shall not  
* be liable for any damages arising out of your use of the code.           
******************************************************************************************    

1. Install the PL/I Compiler "IBM VisualAge PL/I Enterprise for Windows".
SATAN has been developed with the IBM VisualAge PL/I Enterprise for Windows Version 2.1,
(C) Copyright IBM Corp., 1998    

2. Copy all subfolders and datasets from user KSCHMIDT$ on WNTfilesv of the GSI WINDOWS/NT fileserver: Q:\FRSTOOLS\TRI\

Users from outside GSI may also download the necessary files and copy them to the following subfolders:
   \FRSTOOLS\TRI\xxx
   \FRSTOOLS\TRI\GINFO\xxx
   \FRSTOOLS\TRI\GTUT\xxx
   \FRSTOOLS\TRI\FIT\xxx
   \FRSTOOLS\TRI\GRAF\xxx
   \FRSTOOLS\TRI\SATAN\xxx
   \FRSTOOLS\TRI\WORKSPACE\ANAL\xxx
   \FRSTOOLS\TRI\WORKSPACE\SAMPLES\xxx
It is highly recommended not to change the folder structure, because several features of SATAN rely on the full file names!

3. Enter the following subdirectories one after the other and enter "COMPALL" each time:
   \FRSTOOLS\TRI\
   \FRSTOOLS\TRI\FIT\
   \FRSTOOLS\TRI\GRAF\
   \FRSTOOLS\TRI\SATAN\
   \FRSTOOLS\WORKSPACE\ANAL\
   

4. Enter the subdirectory \FRSTOOLS\TRI\ and enter "LINK".  (LINK will write the executable to  \COMMANDS\SATAN.EXE  Make the folder \COMMANDS known to all paths by the SET command. See below for details.)  

5. Still in the subdirectory \FRSTOOLS\TRI\ enter "SATAN" to start SATAN. You may prepare a batch file SLINK.BAT to provide a dedicated link procedure for SATAN applications. Details are given below.   

For further detail look also \FRSTOOLS\TRI\README.TXT.

It may be convenient to move executables and batch files in a special directory and to make it known to all paths by the SET command. Details are given in the following section:   

I. GENERAL REMARKS

(In the following it is assumed, that the user files are on drive G: ; if the user files are on another drive, G: has to be replaced by the appropriate symbol. Furthermore, it is assumed that the directory G:\COMMANDS\ is aimed to provide executables and batch files which should be available from any path.)    

Procedure to make the commands in the file G:\COMMANDS known in all directories:
Start -> Settings -> Control panel -> System -> Environment
Enter the path in the following way:
  in the field "Variable": PATH
  in the field "Value": the path(s), eventually divided by ";"
The application of this procedure to the SLINK command is described below.
   

II. SPECIAL COMMANDS  

For a proper use of the different commands please follow these rules:    

SLINK: Prepare the file SLINK.BAT as given in the following:

(Note that the text from ILINK to cppws35.lib is contained in one line!)
   

  @echo off
  rem *******************************************************************************
  rem * The SLINK command can be used from any path, after the following procedure: *
  rem * This SLINK.BAT command file has to be placed in the path G:\COMMMANDS        *  
  rem * The path \COMMANDS has to be added to the PATH variable:                     *
  rem * Start -> Settings -> Control panel -> System -> Environment                  *
  rem * Enter the path in the following way:                                         *
  rem *   in the field "Variable":      "PATH"                                        *
  rem *   in the field "Value":         "G:\COMMANDS"                                 *
  rem *******************************************************************************
  echo.
  echo SATAN Link procedure KHS 1999.
  echo User modules (max. 9, must be fully qualified): %1 %2 %3 %4 %5 %6 %7 %8 %9
  ILINK %1 %2 %3 %4 %5 %6 %7 %8 %9 G:\FRSTOOLS\TRI\GRAF.OBJ G:\FRSTOOLS\TRI\GRAF\*.OBJ   G:\FRSTOOLS\TRI\SATAN\*.OBJ G:\FRSTOOLS\TRI\FIT\*.OBJ /STACK:0x400000,0x4000 ibmws20i.lib  _user32.lib _gdi32.lib cppws35.lib
   

SATAN: Copy or move the SATAN.EXE module directly to G:\COMMANDS

  The default path for input and output is the path from which SATAN is called.

 

HINTS HOW TO HANDLE SATAN UNDER MICROSOFT WINDOWS    

(Due to the flexibility of MSWindows most of the  following solutions are not unique. You might find even better ones. It is assumed that the installation of SATAN is performed according to the procedure described  in HELP INSTALL.)
   

1. CHANGE THE WINDOWS-EXPLORER TO LIST THE FILE QUALIFIER
   For some of the applications below you need to change the qualifier of a file (e.g. pictures.GRF, exec.SCOM, $SATAN.BAT). Changing the qualifier is possible in the WINDOWS-EXPLORER when the qualifiers are listed. This is not the default option. To change this option:

      Start the WINDOWS-EXPLORER
      Chose "VIEW - FOLDER OPTIONS - VIEW"
      Deactivate "Hide file extensions for known file types"

2. HOW TO START SATAN IN A SPECIFIC DIRECTORY
   Use the WINDOWS-EXPLORER to create a dataset $SATAN.TXT. Enter SATAN in the first line. Change the file qualifier from TXT to BAT. Now you can start SATAN by clicking on the $SATAN.BAT file in the WINDOWS-EXPLORER in the actual directory. That means that SATAN uses this folder for input and output as default.

3. EXCECUTE SATAN COMMAND WHEN STARTING SATAN
   Create a dataset $INIT.SCOM and write the commands you want to be executed when starting SATAN. The commands in $INIT.SCOM are executed automatically when SATAN is started. The commans in \COMMANDS\$INIT.SCOM are executed even before, independently of the folder where SATAN is started.

4. EXECUTE SATAN COMMANDS BEFORE LEAVING SATAN
   Create a dataset $EXIT.SCOM and write the command you want to be executed before leaving SATAN. The commands in $EXIT.SCOM are executed automatically before leaving SATAN. The commands in \COMMANDS\$EXIT.SCOM are executed first before leaving SATAN in any folder.

5. PERFORM A SATAN ACTION WITH A DATASET
   WINDOWS/NT allows to move a dataset name from the WINDOWS EXPLORER into the SATAN
command windows by the mouse. SATAN is prepared to perform the appropriate action
automatically, e.g.
picture.GRF -> display the picture
exec.SCOM -> execute the command file
data.DMP -> fetch the data in the DMP file
data.LMD -> read the list-mode data

6. HISTORY OF COMMANDS
   Preceeding commands can be repeated.
WINDOWS/NT: Use the arrows up and down to select a command from the history.
WINDOWS95: Use the "<" and ">" characters as pseudo commands in SATAN to select a command from the history.
See also topic 8.

7. ROLLING BACK IN THE SATAN COMMAND WINDOW
   WINDOWS/NT provides a window buffer which allows to roll back in the SATAN command
window. To define the window buffer, see topic 8.

8. CHANGING THE PROPERTIES OF THE SATAN COMMAND WINDOW
   CLick on the upper bar of the SATAN command window with the right mouse button. Enter the desired options.
Recommended OPTIONS are:

Command Buffer Size 50
Number of Buffers 4
QuickEditMode OFF
InsertModus ON
Recommended LAYOUT is:
Window Buffer width 80
height 400
Window Size width 80
height 25
When leaving the menu, make these changes valid for all windows of this type.

9. DEFINING DEFAULT APPLICATIONS FOR SATAN FOLDERS
   When clicking on the file name in the WINDOWS EXPLORER, the appropriate application should be started automatically. Define the application in the following way:
START -> SETTINGS -> FOLDER OPTIONS -> TYPES
Define the following applications:
File application
*.GRF ->  NOTEPAD EDITOR
*.SCOM  ->  NOTEPAD EDITOR
*.DMP ->  NOTEPAD EDITOR
*.PLI ->  E:\IBMPLIW\Bin\ibmwlx40.exe "%1"
(This language-sensitive editor is installed with the PL/I compiler. Depending on your installation of PL/I, "E:" must be replaced by the appropriate drive letter of your installation. This editor may also be used for other languages like Fortran etc.)

10. For looking up the usage of PL/I follow this link to the VisualAge PL/I Language Reference of IBM .