Difference between revisions of "Edit-on-start Parameters"

From MidasWiki
Jump to navigation Jump to search
Line 61: Line 61:
  
  
== Edit-on-start parameter comments ==
+
== edit-on-start parameter comments ==
  
 
An optional subdirectory <span style="color: purple;">''Parameter Comments''</span> can be created under the [[/Experiment ODB tree]] to display some extra text on the [[mhttpd]] Start page under an [[#edit-on-start parameters|edit-on-start parameter]] where the parameter name may not contain enough information. In this case, a parameter comment can be created by the user.
 
An optional subdirectory <span style="color: purple;">''Parameter Comments''</span> can be created under the [[/Experiment ODB tree]] to display some extra text on the [[mhttpd]] Start page under an [[#edit-on-start parameters|edit-on-start parameter]] where the parameter name may not contain enough information. In this case, a parameter comment can be created by the user.

Revision as of 18:22, 21 August 2013

Introduction

When a run is started, by default only the run number of the upcoming run will be displayed for editing.

The following example shows a run started using odbedit.

  • Note: Examples are shown using odbedit for ease of documentation; mhttpd could be used instead.

In the example below, the default run number of the next run is 30499. The user has changed this to 500.

[local:bnmr:S]/Experiment>start
Run number [30499]: 500
Are the above parameters correct? ([y]/n/q): 

edit-on-start parameters

It is often convenient to display and edit additional parameters prior to the run start. Not surprisingly, these parameters are known as edit-on-start parameters, since they automatically appear every time a run starts, and they are editable by the user.

Edit-on-start parameters are defined by creating ODB keys (or links to existing ODB keys) in a special subtree named Edit on start that the user creates in the /Experiment ODB tree.

Many users link to the Write data key which enables/disables writing of data. A quick test run can then be made without data logging, for example:

[local:bnmr:S]/Experiment>start
Write data : n
Run number [30499]:
Are the above parameters correct? ([y]/n/q):  


Creating edit-on-start parameters

The first step to setting up the edit-on-start parameters is to create the subtree Edit on start under /Experiment as follows:

$odbedit
[local:Default:S]/>cd /experiment
[local:Default:S]/Experiment>mkdir "Edit on start"
[local:Default:S]/Experiment>cd "Edit on start"
[local:Default:S]/Edit on start>

Then the user either creates the required parameters, or, if the parameters already exist elsewhere in the ODB, creates links to the parameters in the Edit on start subtree.

Many users find it convenient to create a subtree of /Experiment named Run Parameters to contain their run parameters. Links are then created in the Edit on start subtree.

The example below shows the creation of three parameters in the Edit on start subtree.:

  • a parameter to contain the title of the run (called run_title )
  • a link to the ODB parameter /Logger/Write data
  • a link to the ODB parameter /Equipment/FIFO_acq/hardware/num scans(previously created by the user)
  • a link to the ODB parameter /Equipment/Run Parameters/Sample (previously created by the user)
[local:Default:S]/Edit on start>
[local:Default:S]/Edit on start>create string run_title
String length [32]:128
[local:Default:S]/Edit on start>ln "/Equipment/FIFO_acq/hardware/num scans" "number of scans"
[local:Default:S]/Edit on start>ln "/Experiment/Run Parameters/Sample" "sample"
[local:Default:S]/Edit on start>ln "/Logger/Write data" "write data"
[local:Default:S]Edit on start>ls -lt
Key name                        Type    #Val  Size  Last Opn Mode Value
---------------------------------------------------------------------------
run_title                       STRING  1     128   3h   0   RWD  2e test
number of scans                 INT     1     4     11h  0   RWD  /Equipment/FIFO_acq/hardware/num scans -> 0
sample                          STRING  1     23    3h   0   RWD  /Experiment/Run Parameters/Sample -> NA
write data                      BOOL    1     4     7s   0   RWD  /Logger/Write data -> y


edit-on-start parameter comments

An optional subdirectory Parameter Comments can be created under the /Experiment ODB tree to display some extra text on the mhttpd Start page under an edit-on-start parameter where the parameter name may not contain enough information. In this case, a parameter comment can be created by the user.

This "parameter comment" option is visible ONLY when using the MIDAS web server mhttpd. The odbedit start command will not display this extra information.

The name of the parameter in the Parameter Comments subtree must match that of the corresponding edit-on-start parameter. Comments may contain html tags if desired.

Note
If the edit-on-start parameter is a link which is named differently from the actual parameter, then the parameter name in the Parameter Comments subtree must match the name of the actual parameter, rather than the link-name.

This is illustrated below where the Edit-on-start parameter is a link named "number of channels", which links to the actual parameter /sis/nchannels.

[local:midas:S]/Experiment>ls "Edit on start" -lr

number of channels              LINK    1     15    22m  0   RWD  /sis/nchannels

The parameter name in the Parameter Comments subtree for this parameter must be "nchannels" and NOT "number of channels" as show in the example.

Example

[local:midas:S]/Experiment>ls -lr
Key name                        Type   #Val  Size  Last Opn Mode Value
---------------------------------------------------------------------------
Experiment                      DIR
   Name                        STRING  1     32    17s  0   RWD  midas
   Edit on Start               DIR
       Write data              BOOL    1     4     16m  0   RWD  y
       enable                  BOOL    1     4     16m  0   RWD  n
       nchannels               INT     1     4     16m  0   RWD  0
       dwelling time (ns)      INT     1     4     16m  0   RWD  0


   Parameter Comments          DIR
       Write Data              STRING  1     64    44m  0   RWD  Enable logging
       enable                  STRING  1     64    7m   0   RWD  SIS Multi Channel Scaler for expt B1 only
       nchannels               STRING  1     64    14m  0   RWD  maximum 1024
       dwelling time (ns)      STRING  1     64    8m   0   RWD  Check hardware now
[local:midas:S]Edit on Start>ls -l
Key name                        Type   #Val  Size  Last Opn Mode Value
---------------------------------------------------------------------------
Write Data                      LINK    1     19    50m  0   RWD  /logger/Write data
enable                          LINK    1     12    22m  0   RWD  /sis/enable
number of channels              LINK    1     15    22m  0   RWD  /sis/nchannels
dwelling time (ns)              LINK    1     24    12m  0   RWD  /sis/dwelling time (ns)

This results in a start run page as shown below.

mhttpd run start page showing edit-on-start parameters and parameter comments