From 0398a89950d81f58a98d2b0881650b4696d24e52 Mon Sep 17 00:00:00 2001 From: koennecke Date: Thu, 22 Mar 2007 08:52:25 +0000 Subject: [PATCH] - Fixed the SICS MAD documentation --- doc/user/macro.htm | 2 +- doc/user/tasmad.html | 86 +++++++++++-------------------------------- doc/user/tasstore.htm | 15 +++++--- 3 files changed, 32 insertions(+), 71 deletions(-) diff --git a/doc/user/macro.htm b/doc/user/macro.htm index 0b07be0a..cba3c764 100644 --- a/doc/user/macro.htm +++ b/doc/user/macro.htm @@ -7,7 +7,7 @@

SICS has a built in macro facility. This macro facility is aimed at instrument managers and users alike. Instrument managers may provide customised measurement procedures in this language, users may write batch files in this language. The macro language is John Ousterhout's Tool Command Language (TCL). Tcl has control constructs, variables of its own, loop constructs, associative arrays and procedures. Tcl is well documented by several books and online tutorials, therefore no details on Tcl will be given here. All SICS commands are available in the macro language. Some potentially harmful Tcl commands have been deleted from the standard Tcl interpreter. These are: exec, source, puts, vwait, exit,gets and socket. A macro or batch file can be executed with the command:

- fileeval name tries to open the file name and + exe name tries to open the file name and executes the script in this file.

diff --git a/doc/user/tasmad.html b/doc/user/tasmad.html index eadeb988..0b1f5f96 100644 --- a/doc/user/tasmad.html +++ b/doc/user/tasmad.html @@ -40,7 +40,7 @@

Examples
Whenever examples are shown, anything which is actually typed by the user is shown like this. It will generally be shown in lower case. E.g. - 
	scan a1=0 da1=1 np=6
+ 
	sc a1=0 da1=1 np=6
indicates that everything between the s and 6, inclusive, is to be typed by the user.
Optional Arguments
Square brackets, [ ], indicate optional @@ -69,11 +69,6 @@ (A) a sequence of variable names e.g. DM,DA,SS (carry out command given on variables DM, DA, SS) - e.g. ALF1-ALF4 (carry out command given on variables between ALF1 and - ALF4 in storage order; see section V) - e.g. DM,ALF1-ALF4,SS,DA (a combination of the above) Variables separated - by commas need not be typed in their order of storage in the program. - Note : that for this type of syntax (type A) the only acceptable variable separators are ' ' (i.e. a space), ',' and '-' (' ' and ',' are equivalent). @@ -115,13 +110,11 @@ value. LI LIst : Listing of variables and parameters. LE ListEnergies Energies, k and Q values. - LL ListLimits Limits and zeros. - LZ ListZero Limits and zeros. + LL ListLimits Limits and zeros. Same as lz. + LZ ListZero Limits and zeros. Same as ll. LM ListMach Machine parameters. LS ListSample Sample parameters. LT ListTargets Targets and positions. - LD ListDiaphragms Diaphragms. - LP ListPower Power supply values. LO LOg : Controls terminal logging. OF OFf : Turns flipper off. ON ON : Turns flipper on. @@ -129,17 +122,13 @@ PA Pol.An. : Defines a polarization analysis file (default file ext'n is .PAL). PR PRint : Prints one ore more variables or parameters. -RU RUn : Runs a jobfile. SC SCan : Scans a variable with given or previously defined increment, number of points and time interval or monitor count. SE SEt : Sets a parameter value. -SF ScanFast : Scans a variable quickly. +FS ScanFast : Scans a variable quickly. SW SWitch : Sets some switches. -SZ SetZero : Set zero in such a way that value as given - is defined as actual position of variable - (works only for simple variables, i.e. - variables that have a zero). +SZ SetZero : Sets the zero point offset of a variable.

CLEAR

@@ -150,8 +139,7 @@
 	the motors or supplies which have been cleared are listed by THE 
 	Program.
 
-	e.g. 	 CL A1-A3<CR>
-		 CL I3,RA,I4<CR>
+	e.g. 	 CL I3,RA,I4<CR>
 		 CL<CR>
@@ -488,33 +476,6 @@ e.g. PR A1,A5<CR> PR QH-EN,GM<CR> - -

RUN

-
-
-	RU(N) : Runs a jobfile. All commands which may be issued at the terminal
-	may also be included in a job-file which essentially replaces the user 
-	at the terminal.
-	The commands in the job file are executed by running the job file. 
-	Before running the job file a syntax check is done. The file is listed 
-	on the terminal and all scans are checked for limit violations. When 
-	checking is complete, execution is started even if errors have been 
-	reported during the check. To interrupt the sequence type CTRL-C twice 
-	(see interruption section II above). If the RUN command is issued alone,
-	MAD Program asks for a job file name. The default file extension for a 
-	job file is .JOB. The job-file name may also be given on the same line 
-	as the RUN command. Job files can be created as normal OpenVMS files 
-	using one edtir (EDT/TPU/NEDIT).
-	Nesting : Job files may be nested. That is, a job file may contain any 
-	number of RUN commands. The nesting depth should not exceed 3 however.
-	 See also DO.
-
-	e.g. 	 RU MYJOB.HET<CR>	commands from file MYJOB.HET
- 		 RU MYJOB<CR>	commands from file MYJOB.JOB 
-		 RUN<CR> 	gives prompt for job file name
-		JOB-FILE NAME:
-
-

SCAN

@@ -619,7 +580,7 @@
 			sets dM and dA to 3.355
-

SF

+

FS

ScanFast Scans a simple variable quickly. The variable is driven @@ -636,7 +597,7 @@ to be specified directly.
Example:
-    SF A1=6,DA1=1,NP=13,TI=2   --> A1 = 0 to +12 with
+    FS A1=6,DA1=1,NP=13,TI=2   --> A1 = 0 to +12 with
 				    readings every 2 secs.
All of the data is output to a disk file as with the @@ -650,7 +611,7 @@ 
 
 	SZ : (SetZero.) This command sets the zero for a variable such that 
-	its current value is change into a specified value.
+	its current value of the zer point offset is change into the specified value.
 	Obviously this command works only for variables that have a zero.
 	e.g.	 PR A3
 		A3  -45.42
@@ -719,9 +680,9 @@ Example of phonon scan:
    
Sets the title string (up to 72 characters) to be written to the data
    file header.
    
set user ...
-   
Sets the experiment user's name (6 characters).
+   
Sets the experiment user's name.
    
set local ...
-   
Sets the local contact's name (6 characters).
+   
Sets the local contact's name.
    
 
 
@@ -768,15 +729,14 @@ however, corresponds to a transmission minimum for Ki neutrons.
 	l :  Two-axis mode : If you want to work in TWO-AXIS mode, just SEt SA
 	to  0 ! This will change the zero of A5 by 90 and any following drive 
 	of Ki or Kf will drive  the detector to zero and the  analyser 
-	perpendicular to the beam (just check that there is no absorbing cache 
-	[Cd, B4C,...] behind the analyser !). Due to the change of A5 zero the 
+	perpendicular to the beam. Due to the change of A5 zero the 
 	value of A5 will be ZERO (0!) with a analyser orthogonal to the 
 	scatterred beam.
 
-	l :  Constant QM Mode: If you have a powder sample and want to work in 
-	-1 at a given QM ( modulus of Q that you cannot drive), just SEt the 
-	sample lattice parameters (AS, BS, CS ) to 2.p and lattice angles  
-	(AA, BB, CC ) to  90. Any subsequent drive of QH will drive the 
+	l :  Constant QM Mode: If you have a powder sample and want to work at 
+        a given QM ( modulus of Q that you cannot drive), just SEt the 
+	sample lattice parameters (AS, BS, CS ) to 2 PI (6.2832) and lattice angles  
+	(AA, BB, CC ) to  90. Any subsequent drive of QH will drive the 
 	machine to the correct QM value. Use the powder switch to inhibit the 
 	A3 (q) movement.
 
@@ -864,7 +824,6 @@ FX 	=1 for constant Ki;	=2 for constant Kf
 NP 	Number of points in a scan
 TI 	Preset time [seconds] for a COunt or SCan
 MN 	Preset monitor for a COunt or SCan
-TO 	Time-out in for WAit command 		[minutes]
 DTL	lower temperature error allowed  	[Kelvin]
 DTU	upper temperature error allowed 	[Kelvin]
 
@@ -935,14 +894,10 @@ STU	Sample upper translation
 ATL	Anal   lower translation
 ATU	Anal   upper translation
 MGL	Mono   lower goniometer		(Reserved)
-MGU	Mono   upper goniometer
 SGL	Sample lower goniometer
 SGU	Sample upper goniometer
 AGL	Anal   lower goniometer		(Reserved)
-AGU	Anal   upper goniometer
-MSC	Mono   "sample" changer		(TASP only)
-ASC	Anal   "sample" changer		(TASP only)
-CSC	Collimator "sample" changer	(TASP only)
+SRO     Sample sample table ring rotation. 
 
 D1T D1B D1R D1L Diaphragm 1 (top/bottom/right/left)
 D2T D2B D2R D2L Diaphragm 2 (top/bottom/right/left)
@@ -950,7 +905,6 @@ D3T D3B D3R D3L Diaphragm 3 (top/bottom/right/left)
 
 	ILL Instruments:
 	CH 	Monochromator changer position 	[degrees or mm]
-	TM (LM)	Monochromator translation 	[(IN20 : 5mm)]
 	GM	Monochromator goniometer angle 	[1 unit = 4]
 	RM	Monochromator curvature
 	GL	Sample goniometer angle; lower arc 	[1 unit = 4]
@@ -973,11 +927,14 @@ QM	Length of Q 				[ 
 TT (T)	Temperature of sample thermometer 	[K]
 TRT(RT)	Temperature of regulation thermometer 	[K]
 	   (can only be printed out)
+
+

Polarisation Analysis Variables

+
 *I1   -\
 *I2     \
 *I3   	 +--  power supply current values [A]
  .      /
-*I11  -/
+*I6  -/
 
 *HX   -\     Components of Helmholtz fields at sample in Oersteds.
 *HY   	+--  HX is parallel to Q and HY is perpendicular to Q in
@@ -986,6 +943,7 @@ TRT(RT)	Temperature of regulation thermometer 	[K]
 *F1   -\     Status of flippers one and two; these variables take the 
 *F2   -/     values ON or OFF.
+

Increments Variables

 	For all variables A1 through T in the  list of type (iv) variables 
diff --git a/doc/user/tasstore.htm b/doc/user/tasstore.htm
index f35c1e9f..f80278ae 100644
--- a/doc/user/tasstore.htm
+++ b/doc/user/tasstore.htm
@@ -10,24 +10,27 @@ files are formatted in a format compatible to the ILL's triple axis
 data file format. Data files can be found in directories:
 
 
-    /home/INST/data/YYYY
+    /home/INST/data/YYYY/HHH
 
 
 
 on the instrument computer or in
 
 
-    /data/lnslib/data/INST/data/YYYY
+    /afs/psi.ch/project/sinqdata/YYYY/INST/HHH
 
 
 
 on any other LNS unix system. INST is a placeholder for the instrument
-name in capitals, YYYY for the year of data collection. Data files are
+name in capitals, YYYY for the year of data collection. HHH is the thousands 
+directoy. In order to facilitate file handling, data files are grouped into directories 
+containing thousand data files each. Thus files 0-999 will be in the 000 directory, files 
+ 1000-1999 in the 001 directory etc. Data files are
 named according to the SINQ naming convention:
 
-     instRRRRRYYYY.dat
+     instYYYYnTRRRRR.dat
 
 
 with inst being the placeholder for the instrument name in lowercase,
-RRRRR the run number as a five digit number and YYYY again the year of
-data collection. Example: tasp003302002.dat is data collected in run
+RRRRRR the run number as a six digit number and YYYY again the year of
+data collection. Example: tasp2002n000330.dat is data collected in run
 number 330 in 2002.