From 868b36b36bf950fea3029533640f2b8e7da3abb4 Mon Sep 17 00:00:00 2001 From: koennecke Date: Fri, 17 Apr 2009 12:52:30 +0000 Subject: [PATCH] *** empty log message *** --- doc/user/sansdocbook.xml | 688 +++++++++++++++++++++++---------------- 1 file changed, 403 insertions(+), 285 deletions(-) diff --git a/doc/user/sansdocbook.xml b/doc/user/sansdocbook.xml index 9f02cdc6..dfa4329f 100644 --- a/doc/user/sansdocbook.xml +++ b/doc/user/sansdocbook.xml @@ -38,15 +38,33 @@ Switzerland + + + + Dr + Ronny + Vavrin + +
+ + Paul Scherrer Institute PSI + LNS, Laboratory for Neutron Scattering + + Villigen + 5232 + Switzerland +
+ + 20.April 2007 + Abstract - This manual describes how to set up the small angle neutron scattering instrument at - the SINQ spallation source at PSI and gives a short remainder of important command. - This document can be downloaded - http://sans.web.psi.ch/SANSDoc/SANSDoc.ps.gz - as a gzipped postscript file. + This manual describes how to set up the small angle neutron scattering (SANS) instrument at + the SINQ spallation source at PSI and gives a short reminder of important commands. + This document can be + downloaded as a pdf file. @@ -163,41 +181,6 @@ Executing a macro - - - - FileEval <file> - - - - executes the script in the file <file> (needs absolute path). - - - - - - - BatchRoot [<path>] - - - - defines directory for script files executed by BatchRun. - - - - - - - Batchrun <filename> - - - - executes script file <filename> - located in directory defined by BatchRoot. - - - - exe BatchPath [<path>] @@ -216,8 +199,8 @@ executes script file <filename> - located in directory defined by exe BatchPath. Compared to - BatchRun, this command allows enhanced batch control through + located in directory defined by exe BatchPath. This command + allows enhanced batch control through the SICSBatchEditor. @@ -225,12 +208,36 @@ - Clientput <text> + ClientPut <text> writes <text> - to client. + to the client in which this command was written. + + + + + + + BroadCast <text> + + + + writes <text> + to all clients. + + + + + + + in a terminal window: sanscheck <filename> + + + + checks the batchfile <filename> + for errors and calculates the total of Monis to be measured. @@ -1366,106 +1373,6 @@ -
- Sample holder for electro magnet - - - - - - mz - - - - motor for vertical movement (z). - - - - - - - mom - - - - motor for rotation around vertical axis (omega). - - - - - - - msh [z=<val1>] [omega=<val2>] - - - - is a special SANS command for controlling both axes of the magnet sample holder together. - - - - - - -
-
- Haake temperature controller - - - - - - inihaakearray eimer lnsa10 4000 1 - - - - - evfactory new temperature tcl eimer - - - - initialisation sequence. - - - - - - - temperature - - - - is a valid sample environment device if initialised as above. - - - - - - - temperature list - - - - overview of the temperature controller parameters. Use 'emon unregister temperature' - to avoid out of range error messages. - - - - - - - temperature sensor <val> - - - - selects the controlling sensor. <val> can be - intern or extern. - - - - - - -
Bruker electro magnet @@ -1569,6 +1476,104 @@
+
+ Sample holder for electro magnet + + + + + + mz + + + + motor for vertical movement (z). + + + + + + + mom + + + + motor for rotation around vertical axis (omega). + + + + + + + msh [z=<val1>] [omega=<val2>] + + + + is a special SANS command for controlling both axes of the magnet sample holder together. + + + + + + +
+
+ Haake C25P temperature controller + + + + + + start_sea + + + + + starts the sea server from SICS. + + + + + + + temperature + + + + reads out the current temperature. + + + + + + + drive temperature <val> + + + + changes the set temperature of the thermostat to the value <val>. + + + + + + + in a terminal window: sea + + + + + starts the sea server client from a terminal. Choose Haake as device. The sea server client is the + best way to control and monitor the thermostat manually. Please refer to the + + SEA Wiki page for more information. + + + + + + +
Eurotherm controller @@ -1617,12 +1622,6 @@
-
- ITC-4 and ITC-503 temperature controllers - - *outdated controllers, will be replaced* - -
Analogue and digital input and output @@ -2154,6 +2153,65 @@
+
+ Useful commands + + + + + + gc <measMonis> <totalCounts> + + + + GuessCount: executes a measurement of <measMonis> Monis and extrapolates the measurement time and Monis + for a final value of <totalCounts> counts. A useful tool to estimate the measurement time for a sample. Example: + gc 5 1E7 forces the instrument to measures for 5 Monis and estimates the measurement + time and Monis for 10'000'000 counts. + + + + + + + qrange [x <detdist>] [wl <lambda>] + + + + calculates the q range of the current setting. The detector distance x (in mm) and the wavelength wl + (in nm) can be varied with the optional parameters. Examples: qrange prints the q range of the current + setting, qrange x 6000 wl 0.8 prints the q range of the current + setting with forced values for the detector distance (6000mm) and the wavelength (0.8nm). + + + + + + + sinq + + + + prints the SINQ status in the SICS client which issued the command. + + + + + + + in a terminal window: sanscheck <filename> + + + + checks the batchfile <filename> + for errors and calculates the total of Monis to be measured. + + + + + + +
@@ -2418,8 +2476,7 @@ Define the directory, where you intend to store your batch - files with batchroot /data/lnsg/<username>[/<batchdir>] - resp. with + files with exe batchpath /data/lnsg/<username>[/<batchdir>]. @@ -2553,61 +2610,14 @@ 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 - http://cseng.awl.com/authordetail.qry?AuthorID=69 - - Tool Command Language (TCL) http://www.tcltk.com - . + The macro language is + + John Ousterhout's + + Tool Command Language (TCL). A set of important Tcl commands are described in section . - To execute batch files three commands are available: + To execute batch files, the following commands are available: - - - FileEval <batchfile> - - - - This command tries to open the file - batchfile and executes the - script in this file. If not an absolute path name is defined - the SICS server will search in the directory - /home/SANS/bin. However, you - don't have privileges to save files in this directory. For - executing batch files located in a directory of your choice - the commands BatchRoot and - BatchRun resp. - exe BatchPath and - exe are available. - - - - - - BatchRoot [<pathname>] - - - - By this command the directory name, in which SICS is searching - for a batch file, is stored in the SICS variable - BatchRoot. Calling - BatchRoot without parameters - will return the actual contents of the variable. - - - - - - BatchRun <filename> - - - - This command tries to open the file filename - located in the directory defined by - BatchRoot and executes the - script in this file. - - - exe BatchPath [<pathname>] @@ -2631,15 +2641,15 @@ This command tries to open the file filename located in the directory defined by exe BatchPath and executes the - script in this file. Compared to BatchRun, - this command allows enhanced batch control through the + script in this file. + This command allows enhanced batch control through the SICSBatchEditor. If you want to print information from a macro script to a client (about the progress of - the batch job for example), a special command is available: + the batch job for example), special commands are available: @@ -2652,8 +2662,36 @@ + + + BroadCast some text ... + + + + This command writes everything after BroadCast + to all clients. + + + + To check a batchfile for errors and to estimate the total Monis to be measured, a special program + can be executed in a terminal window. Navigate to the folder containing the batchfile and execute + the following command + + + + in a terminal window: sanscheck <filename> + + + + checks the batchfile <filename> + for errors and calculates the total of Monis to be measured. + + + + +
Logging the executed commands @@ -3490,20 +3528,18 @@
TCL command language interface - The macro language implemented in the SICS server is John Ousterhout's - http://cseng.awl.com/authordetail.qry?AuthorID=69 - Tool Command Language (TCL) - http://www.tcltk.com - . Tcl has control constructs, variables of its own, loop constructs, - associative arrays and procedures. Tcl is well documented by several books - http://www.cica.indiana.edu/cica/faq/tcl/tcl.html - , online tutorials and manuals - http://www.scriptics.com/man/tcl8.0/contents.htm - . For getting further - informations on Tcl have a look on the TCL WWW Infohttp://www.sco.com/Technology/tcl/Tcl.html - - of Tcl Web serverhttp://www.tcltk.com - . All SICS commands are + The macro language implemented in the SICS server 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, + online tutorials and manuals. + For getting further + informations on Tcl have a look on the + TCL WWW Info + of + Tcl Web server. 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, @@ -3511,9 +3547,9 @@ gets and socket. Below only a small subset of the most important Tcl commands like assigning variables, evaluating expressions, control and loop constructs are - described. For complete description of Tcl command have a look on the manual - http://www.scriptics.com/man/tcl8.0/contents.htm - pages or on one of the many books about Tcl/Tk. + described. For complete description of Tcl command have a look on the + manual pages or on one of + the many books about Tcl/Tk.
@@ -4111,7 +4147,7 @@ while {$x<10} { </para> </section> <section> - <title>Change the collimation + Changing the collimation @@ -4299,7 +4335,7 @@ bs x = 2 y ++10 - bsfree + bscfree is a manager command, which releases the beam stop motors, @@ -4343,6 +4379,50 @@ bs x = 2 y ++10
+ +
+ Calculating the q range + The q range of the current setting can comfortably be calculated with the following command: + + + + qrange [x <detdist>] [wl <lambda>] + + + + calculates the q range of the current setting. The detector distance x (in mm) and the wavelength wl + (in nm) can be varied with the optional parameters. Examples: qrange prints the q range of the current + setting, qrange x 6000 wl 0.8 prints the q range of the current + setting with forced values for the detector distance (6000mm) and the wavelength (0.8nm). + + + + + +
+ +
+ Estimating the measurement time + The measurement time of a sample depends on many factors and needs to be estimated for each + sample individually. This procedure is simplified with the command GuessCount. + + + + gc <measMonis> <totalCounts> + + + + GuessCount: executes a measurement of <measMonis> Monis and extrapolates the measurement time and Monis + for a final value of <totalCounts> counts. Example: + gc 5 1E7 forces the instrument to measures for 5 Monis and estimates the measurement + time and Monis for 10'000'000 counts. + + + + + +
+
@@ -4463,53 +4543,6 @@ st pos P1 P1 to bring the sample in position.
-
- Haake temperature controller - - This is sort of a buck full of water equipped with a temperature control system. - The RS-232 interface of this device can only be operated at 4800 baud max. This is - why it has to be connected to the serial printer port of the Macintosh serial port - server computer. This makes the channel number to use for initialisation a 1 always. - The driver for this device has been realised in the Tcl extension language of the - SICS server. A prerequisite for the usage of this device is that the file - hakle.tcl is sourced in the SICS initialisation - file and the command inihaakearray has been - published. Installing the Haake into SICS requires two steps: first create an - array with initialisation parameters, second install the device with - evfactory. A command procedure is supplied for - the first step. Thus the initialisation sequence becomes: - - -inihaakearray <name-of-array> <macintosh-computer> <name> <port> <channel> -evfactory new temperature tcl <name-of-array> - - - An example for the SANS: - - -inihaakearray eimer lnsa10.psi.ch 4000 1 -evfactory new temperature tcl eimer - - - Following this, the thermostat can be controlled with the other environment - control commands. - - - The Haake Thermostat understands a single special subcommand: - sensor. The thermostat may be equipped with an - external sensor for controlling and reading. The subcommand - sensor allows to switch between the two. The - exact syntax is: - - -temperature sensor <val> - - - <val> can be either - intern or - extern. - -
Bruker electromagnet @@ -4668,6 +4701,72 @@ msh.omega = 0.000000 about special SANS commands.
+
+ Haake C25P temperature controller + + This is sort of a bucket full of water equipped with a temperature control system. + It is connected with a blue ethernet cable to the port nr. 8 of the SANS terminal. The + SEA software written by Markus Zolliker is the best way to control and monitor the + thermostat manually; it is started from a terminal window with sea. + Please refer to the + + SEA Wiki page for more information. + + + To add an external Pt100 sensor, plug in the sensor and restart the thermostat and the sea client (choose + 'Haake' as device and check the box 'has sample sensor'). If the external sensor should be used as + reference to control the thermostat, check the box 'control on sample'. + + + + + start_sea + + + + + starts the sea server from SICS. + + + + + + + temperature + + + + reads out the current temperature. + + + + + + + drive temperature <val> + + + + changes the set temperature of the thermostat to the value <val>. + + + + + + + in a terminal window: sea + + + + + starts the sea server client from a terminal. Choose Haake as device. + + + + + + +
Eurotherm temperature controller @@ -4709,11 +4808,6 @@ EVFactory new temperature euro lnsa10.psi.ch 4000 13
-
- ITC-4 and ITC-503 temperature controller - *outdated controllers, will be replaced* - -
@@ -5260,7 +5354,20 @@ EVFactory new temperature euro lnsa10.psi.ch 4000 13
Status of the actual acquisition process - empty + A + webpage + with the actual instrument status is available (only inside the PSI network). + + + sinq + + + prints the SINQ status in the SICS client which issued the command. + + + + +
@@ -5268,16 +5375,27 @@ EVFactory new temperature euro lnsa10.psi.ch 4000 13 Other programs
- PSI2HMI - empty + Grasp + Grasp stands for 'Graphical Reduction and Analysis SANS Program for Matlab' which was developed + by Charles Dewhurst at the Institut Laue-Langevin (ILL) in Grenoble, France. Please refer to the + Grasp webpage. +
BerSANS software package - The Manual of the BerSANS Software Package is available in pdf format as well as a zipped pdf file. + The BerSANS data reduction software has been developed by Uwe Keiderling at the Hahn-Meitner-Institut + (HMI) in Berlin, Germany. + The Manual of the BerSANS Software Package can be + downloaded + as pdf file. +
- sasfit program - empty + SASfit program + SASfit for analyzing and plotting small angle scattering data has been written by Joachim + Kohlbrecher at the Paul Scherrer Institute (PSI) in Villigen, Switzerland. Please refer to the + SASfit webpage. +