linse/sics
0
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

PSI sics-cvs-psi-2008-10-02

Browse Source
This commit is contained in:
koennecke
2008-10-02 00:00:00 +00:00
committed by Douglas Clowes
parent 6e926b813f
commit 4baffb9b7a
304 changed files with 77527 additions and 3612 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
doc/manager/nxscript.htm
View File

@@ -104,7 +104,7 @@ the dictionary file:
would denote the normal counting tube at a scanning type of
experiment.
</dl>
<dt>nxscript puthm hmAlias hmName ?start? ?length?
<dt>nxscript puthm hmAlias hmName ?start? ?length? ?bank?
<dd>Writes data from the histogram memory hmName to a NeXus file using
the alias hmAlias. Nxscript automatically updates the dim0, dim1, ..., timedim
dictionary variables. Thus these can be used to define the dimensions in the
@@ -116,7 +116,9 @@ subset writing, the dimensions have to be specified in the definition
string belonging to the alias. Nxscript sets a variable timedim in the
dictionary though which contains the length of a time binning if
appropriate. This is a special feauture for writing extra detectors at
SANS and AMOR.
SANS and AMOR. Optionally, together with start and length, a bank number can
be given. This is a feauture to support the rare case of having multiple banks
in one histogram memory. If not give bank defaults to 0.
<dt>nxscript puttimebinning aliasName hmName
<dd>Writes the time binning at histogram memory hmName to file using
the alias aliasName. The length of the time binning data is
@@ -125,14 +127,28 @@ automatically appended to the definition string for the alias.
<dd>Writes the Tcl array arrayName to file using the aliasName. The
definiton string belonging to aliasName does not need to contain a
-dim argument as this is set by this routine. The parameter length is
the length of the array. Only rank 1 arrays are supported.
the length of the array. Only rank 1 arrays are supported. The array is
considered a float array.
<dt>nxscript putintarray aliasName arrayName length
<dd>The same as above, but the data is considered integer.
<dt>nxsript putglobal attName bla bla bla
<dd>This writes an global attribute attName. Everything after attName
is concatenated to a string which then respresents the value of the
attribute.
attribute.
<dt>nxscript putsicsdata alias dataname
<dd>Writes the sicsdata array dataname to alias.
<dt>nxscript putattribute alias name value
<dd>Add another text attribute to alias. The name of the attribute is name, the
value value.
<dt>nxscript makelink targetAlias victimAlias
<dd>This creates a symbolic link for victimAlias in the group
designated by targetAlias.
<dt>nxscript putslab alias startlist sizelist obj
<dd>Writes a slab of data. alias is the alis to write too. startslist is
a Tcl list containing the start indexes, sizelist is the size of the slab
to write as a Tcl list and obj is the SICS object to write. Obj can be a
histogram memory; then the histogram memory data is written. Or it can be
a sicsdata object, the value of which will then be written.
</dl>
</p>
<H1>Automatic Updating of NeXus Files</H1>

3
doc/manager/nxupdate.htm
View File

@@ -65,6 +65,9 @@ file.
<dt>updateintervall
<dd>The time intervall in seconds between updates. The defualt is
1200, eg. 20 minutes.
<dt>onoff
<dd>can be 1 or 0. Switches automatic updates on or off. It might be usefule for
scans to switch this off.
</dl>
</p>
</BODY>

31
doc/manager/tas.htm
View File

@@ -21,6 +21,37 @@ The TAS requires the following initializations in its instrument file:
<dt>MakeTasUB tasub
<dd>Installs the TAS crystallographic calculation module into SICS. It will
have the name tasub (recommended).
<dt>MakeTasUB tasub a1 a2 mcv mch a3 a4 sgu sgl a5 a6 acv ach
<dd>Installs the TAS crystallographic calculation module into SICS. It will
have the name tasub (recommended). This versions allows to specifiy motor names for functions. If there is no motor for
a function it can be replaced with a placeholder in the parameter list, like dummy. This is only allowed for the
curvature motors. The motor functions:
<dl>
<dt>a1
<dd>monochormator rotation
<dt>a2
<dd>monochromator two theta
<dt>mcv
<dd>monochromator vertical curvature
<dt>mch
<dd>monochromator horizontal curvature
<dt>a3
<dd> sample rotation
<dt>a4
<dd>sample tow theta
<dt>sgu
<dd>sample tilt
<dt>sgl
<dd>second sample tilt
<dt>a5
<dd>analyzer rotation
<dt>a6
<dd>analyzer two theta
<dt>acv
<dd>analyzer vertical curvature
<dt>ach
<dd>analyzer horizontal curvature
</dl>
<dt>MakeTasScan iscan tasub
<dd>Installs the module with the TAS specific scan functions into SICS. The
TAS implements its own data format resembling the ILL TAS data format.

5
doc/user/commandlog.htm
View File

@@ -35,6 +35,11 @@ started. In order to make this work a ServerOption with the name logstartfile
must exist in the instrument configuration file. The value of this option
must be the full path name of the file to execute.
</P>
<p>
<b>Note:</b> with the command <it>config listen 1</it> you can have the output
to the command log printed into your client, too. With <it>config listen 0</it> you can switch this off again. This is useful for listening into a running
instrument.
</p>
</BODY>
</HTML>

14
doc/user/exeman.html
View File

@@ -45,6 +45,13 @@ named buffer within the stack of nested buffers.
<dt>Clears the queue of batch buffers
<dt>exe queue
<dd>Prints the content of the batch buffer queue.
<dt>exe fullpath filename
<dd>Prints the full path name for filename if the file can be located
somewhere in exe paths. Else an error is printed. The purpose is to use
exe file management facilties in scripts.
<dt>exe makepath filename
<dd>Prints the full path name for filename in the first direcory of batch path.
This is a tool to have scripts open files in the proper user directory.
<dt>exe run
<dd>Starts executing the batch buffers in the queue.
<dt>exe print buffername
@@ -58,7 +65,12 @@ most useful for SICS clients watching the progress of the experiment.
<dt>exe append some text
<dd> Appends a line with everything after append to the upload buffer
<dt>exe save filename
<dd>saves the recently uploaded buffer under filename on the SICS server.
<dd>saves the recently uploaded buffer under filename on the SICS server. Does not overwrite
existing files.
<dt>exe forcesave filename
<dd>saves the recently uploaded buffer under filename on the SICS server. Overwrites existing file.
<dt>exe clearupload
<dd>clears any pending upload operations.
</dl>
</P>
</BODY>

2
doc/user/macro.htm
View File

@@ -7,7 +7,7 @@
<p>
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:</p>
<p>
<b> fileeval <i>name</i> </b> tries to open the file name and
<b> exe <i>name</i> </b> tries to open the file name and
executes the script in this file.
</p>
<p>

24
doc/user/optimise.htm
View File

@@ -29,6 +29,18 @@ maximum number of cycles was reached. This routine requires that the
instrument is currently placed somewhere on the peak and not miles away.
</P>
<p>
The peak optimiser supports another optimisation algorithm which is faster but
may not be as accurate. This is hill climbing:
<pre>
while errors gt precision and cycles lt maxcycles
for all variables
find the direction into which the intensity rises
step into this direction until the intensity drops
end for
end while
</pre>
</p>
<p>
The Peak Optimiser is implemented as an object with the name opti. It
understand the following commands:
<DL>
@@ -43,7 +55,10 @@ and number of steps parameters should cover the whole peak. However, the
Optimiser will extend the scan is the specified range is not sufficient.
<DT>opti run
<DD>Starts the optimiser. It will then optimise the peak. This may take some
time.
time as it uses a time consuming scan based algorithm.
<DT>opti climb
<DD>Starts the optimiser in hill climbing mode. Hill climbing is faster but may
not be as accurate as a scan based optimization.
</DL>
The behaviour of the optimiser can be configured by modifying some
parameters. The synatx is easy: <b>opti parameter</b> prints the value of the
@@ -72,5 +87,12 @@ status of the countmode parameter this is either a preset time or a preset
monitor.
</DL>
</p>
<p>
It is the users reponsability to provide meaningful step widths. Usually this is
dependent on the instrument resolution and thus fairly constant. Also these
optimisation algorithms will fail if the instrument is not positioned at the
flank of a peak. Probaly the best will be to do several cycles of hill
climbing first, followed by one cycle of scan optimisation for extra accuracy.
</p>
</BODY>
</HTML>

BIN
doc/user/sansdoc.tgz Normal file
View File

Binary file not shown.

5284
doc/user/sansdocbook.xml Normal file
View File

File diff suppressed because it is too large Load Diff

4
doc/user/system.htm
View File

@@ -66,6 +66,10 @@ above and restores SICS to the state it was in when the status was saved with
read.
</p>
<p>
<b>restore listerr</b> prints the list of lines which caused errors during the
last restore.
</p>
<p>
<b>killfile</b> decrements the data number used for SICS file writing
and thus consequently overwrites the last datafile. This is useful
when useless data files have been created during tests. As this is

86
doc/user/tasmad.html
View File

@@ -40,7 +40,7 @@
<dt> Examples <dd> Whenever examples are shown, anything which is actually
typed by the user is shown <em>like this</em>. It will generally be shown
in lower case. E.g.
<pre> <em>scan a1=0 da1=1 np=6</em></pre>
<pre> <em>sc a1=0 da1=1 np=6</em></pre>
indicates that everything between the <em>s</em> and <em>6</em>, inclusive,
is to be typed by the user.
<dt> Optional Arguments <dd> 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.
<a href="#LIST">LI</a> 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.
<a href="#LOG">LO</a> LOg : Controls terminal logging.
<a href="#ONOFF">OF</a> OFf : Turns flipper off.
<a href="#ONOFF">ON</a> ON : Turns flipper on.
@@ -129,17 +122,13 @@
<a href="#PA">PA</a> Pol.An. : Defines a polarization analysis file (default
file ext'n is .PAL).
<a href="#PRINT">PR</a> PRint : Prints one ore more variables or parameters.
<a href="#RUN">RU</a> RUn : Runs a jobfile.
<a href="#SCAN">SC</a> SCan : Scans a variable with given or previously
defined increment, number of points and
time interval or monitor count.
<a href="#SET">SE</a> SEt : Sets a parameter value.
<a href="#SCANFAST">SF</a> ScanFast : Scans a variable quickly.
<a href="#SCANFAST">FS</a> ScanFast : Scans a variable quickly.
<a href="#SWITCHES">SW</a> SWitch : Sets some switches.
<a href="#SETZERO">SZ</a> 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).
<a href="#SETZERO">SZ</a> SetZero : Sets the zero point offset of a variable.
</pre>
<h3><a name="CLEAR">CLEAR</a></h3>
<pre>
@@ -150,8 +139,7 @@
the motors or supplies which have been cleared are listed by THE
Program.
e.g. CL A1-A3&lt;CR&gt;
CL I3,RA,I4&lt;CR&gt;
e.g. CL I3,RA,I4&lt;CR&gt;
CL&lt;CR&gt;
</pre>
@@ -488,33 +476,6 @@
e.g. PR A1,A5&lt;CR&gt;
PR QH-EN,GM&lt;CR&gt;
</pre>
<h3><a name="RUN">RUN</a></h3>
<pre>
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&lt;CR&gt; commands from file MYJOB.HET
RU MYJOB&lt;CR&gt; commands from file MYJOB.JOB
RUN&lt;CR&gt; gives prompt for job file name
JOB-FILE NAME:
</pre>
<h3><a name="SCAN">SCAN</a></h3>
<pre>
@@ -619,7 +580,7 @@
sets dM and dA to 3.355 <20>
</pre>
<h3><a name="SCANFAST">SF</a></h3>
<h3><a name="SCANFAST">FS</a></h3>
<table>
<tr><td valign=top><b>ScanFast</b>
<td>Scans a simple variable quickly. The variable is driven
@@ -636,7 +597,7 @@
to be specified directly.
</tr>
<tr><td><td>Example:<pre>
SF A1=6,DA1=1,NP=13,TI=2 --&gt; A1 = 0 to +12 with
FS A1=6,DA1=1,NP=13,TI=2 --&gt; A1 = 0 to +12 with
readings every 2 secs.</pre>
</tr>
<tr><td><td>All of the data is output to a disk file as with the
@@ -650,7 +611,7 @@
<pre>
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:
<dd>Sets the title string (up to 72 characters) to be written to the data
file header.
<dt><em>set user ...</em>
<dd>Sets the experiment user's name (6 characters).
<dd>Sets the experiment user's name.
<dt><em>set local ...</em>
<dd>Sets the local contact's name (6 characters).
<dd>Sets the local contact's name.
</dl>
@@ -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
<09>-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)
</pre>
<h3>Polarisation Analysis Variables</h3>
<pre>
*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.
</pre>
<h3><a name="Increments_Variables">Increments Variables</a></h3>
<pre>
For all variables A1 through T in the list of type (iv) variables

15
doc/user/tasstore.htm
View File

@@ -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:
<pre>
/home/INST/data/YYYY
/home/INST/data/YYYY/HHH
</pre>
on the instrument computer or in
<pre>
/data/lnslib/data/INST/data/YYYY
/afs/psi.ch/project/sinqdata/YYYY/INST/HHH
</pre>
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:
<pre>
instRRRRRYYYY.dat
instYYYYnTRRRRR.dat
</pre>
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.
</p>
<p>

23
doc/user/tasub.htm
View File

@@ -81,6 +81,12 @@ In order to calculate a UB matrix a list of reflections must be maintained. This
<dd>Add a new reflection to the list. Besides the indices all angles are given:
a3, the sample rotation, a4, sample two theta, sgu, upper tilt cradle, sgl, lower tilt
cradle and incoming energey ei and outgoing energy ef.
<dt>tasub addauxref qh qk ql
<dd>Adds an auxiliary reflection with indices qh, qk, ql to the list. A4 is
calculated from cell constants. A3 is either left alone or is calculated to
have the correct angular difference to a previous reflection. This is a help
for setting up the instrument or running powder mode. When a UB has been
generated from auxiliary reflections, a3, sgu and sgl angles will be incorrect.
</dl>
</p>
<h3>Calculations</h3>
@@ -88,15 +94,23 @@ In order to calculate a UB matrix a list of reflections must be maintained. This
This section covers the parameters and commands to use to make the module do calculations
for you.
<dl>
<dt>tasbub const ki | kf
<dt>tasbub const ki | kf | elastic
<dd>Sets a parameter to determine if KI or KF is fixed when the energy transfer en is
being driven. Allowed values: ki, kf
being driven. Allowed values: ki, kf, elastic. In elastic mode the analyzer is
disregarded. This is useful for two circle diffractometers.
<dt>tasub const
<dd>Prints if ki or kf is fixed.
<dt>tasub ss
<dd>Prints the sample scattering sense.
<dt>tasub ss 1 | -1
<dd>Sets the sample scattering sense. Allowed values are either 1 or -1.
<dt>tasub silent 0 | 1
<dd>Prints or sets the silent flag. If this is 0, the messages Driving motor ..
from .. to .. are suppressed.</dd>
<dt>tasub outofplane 0 | 1
<dd>Prints or sets the outofplane flag. If this flag is 0, the instrument will stay
in the scattering plane and not move out of it. This is here in order to protect those
bloody magnets which cannot be tilted.</dd>
<dt>tasub makeub r1 r2
<dd>Calculate a new UB matrix from the current cell constants and the entries r1 and r2 in
the reflection list. r1 and r2 are integer numbers. This command will not only print the
@@ -137,7 +151,7 @@ The virtual motor qm implements <b>powder mode</b>. In this mode, only the sampl
respective positions. THis is commonly used to analyze the energy transfer of powder samples.
</p>
<p>
There is another important command:
There are other important command:
<dl>
<dt>tasub update
<dd>This command will force a recalculation of the current Q-E position for the virtual
@@ -145,6 +159,9 @@ motors from angles. Normally tasub will take care of this. However, if any of th
motors are moved directly or manualy, this command might be required. The SICS dr
wrapper command, however, even takes care of this.
</dl>
<dt>tasub updatetargets
<dd>This command makes the QE targets macth the current position. This is
useful after initialization in the instrument.tcl file.</dd>
</p>
<h3>Internal Commands</h3>
<p>