PSI update

r1464 | ffr | 2007-02-12 12:20:21 +1100 (Mon, 12 Feb 2007) | 2 lines

doc/user/commandlog.htm

@@ -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>
 

doc/user/exeman.html

@@ -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>

doc/user/optimise.htm

@@ -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>

doc/user/tasub.htm

@@ -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>