Edit-on-start Parameters: Difference between revisions

From MidasWiki
Jump to navigation Jump to search
mNo edit summary
(The midas documentation has moved to https://midas.triumf.ca/docs/)
Tag: Replaced
 
(3 intermediate revisions by one other user not shown)
Line 1: Line 1:
{{Pagelinks}}
The midas documentation has moved. See [https://midas.triumf.ca/docs/develop/features/core_system/runs/configuring/#asking-questions-when-the-run-starts-edit-on-start Asking questions when the run starts (edit on start)] on the Runs: configuring page and [https://midas.triumf.ca/docs/develop/reference/reference/odb_keys/#experimentedit-on-start /Experiment/Edit on start] on the ODB keys page for the new documentation about edit-on-start parameters.
= Links =
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
* [[Edit-on-Sequence Parameters]]
* [[/Experiment ODB tree]]
</div>
== Introduction ==
When a run is started, by default only the
[[/Runinfo ODB tree #Run number|run number]] of the upcoming run will be displayed for editing (Figure 1).
<br>
;Figure 1
: Run start with no edit-on-start parameters defined
 
{|  style="text-align: left; width: 100%; background-color: azure;" border="0" cellpadding="2" cellspacing="2"
|+
|-
|  Using [[mhttpd]]<br>
[[File:Mhstart1.gif|thumb|left|Click to enlarge]]
<br clear=all>
|  Using [[odbedit]]<br><br>
<pre>
[local:bnmr:S]/Experiment>start
Run number [30499]:
Are the above parameters correct? ([y]/n/q):
</pre>
<br><br>
|}
 
 
 
 
== ''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 <span style="color: purple;">''Edit on start''</span> that the user creates in the
[[/Experiment ODB tree]].
 
Many users link to the  [[Keys in the ODB /Logger tree #/Logger/Write data |Write data key]] (see [[#Creating ''edit-on-start'' parameters|below]])  which enables/disables writing of data. A quick test run can then be made without data logging (see Figure 2).
<br>
;Figure 2
: Run start with one edit-on-start parameter defined
 
{|  style="text-align: left; width: 100%; background-color: azure;" border="0" cellpadding="2" cellspacing="2"
|+
|-
|  Using [[mhttpd]]<br>
[[File:Mhstart.gif|thumb|left|Click to enlarge]]
<br clear=all>
|  Using [[odbedit]]<br>
<pre>
[local:test:S]/Experiment>start
Write data : n
Run number [30499]:
Are the above parameters correct? ([y]/n/q): 
</pre>
<br><br>
|}
 
== Creating ''edit-on-start'' parameters ==
 
;Note
: The examples shown here use <span style="color:darkcyan;">''odbedit''</span> for ease of documentation; many users will prefer to  use the editing function of the <span style="color:darkcyan;">''mhttpd''</span> [[ODB Page]] to create the ODB keys.
<br>
The first step to setting up the ''edit-on-start'' parameters is to create the subtree  <span style="color: purple;">''Edit on start''</span> under <span style="color: purple;">''/Experiment''</span> 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 <span style="color: purple;">''Edit on start''</span> subtree.
 
Many users find it convenient to create a subtree of <span style="color: purple;">''/Experiment''</span> named <span style="color: purple;">''Run Parameters''</span> to contain their run parameters. Links are then created in the <span style="color: purple;">''Edit on start''</span> subtree.
 
The example below shows the creation of three parameters in the <span style="color: purple;">''Edit on start''</span> subtree.:
 
*    a parameter to contain the title of the run (called <span style="color: purple;">''run_title''</span> )
*    a link to the ODB parameter <span style="color: purple;">''/Logger/Write data''</span>
*    a link to the ODB parameter <span style="color: purple;">''/Equipment/FIFO_acq/frontend/hardware/num cycles''</span>(previously created by the user)
*  a link to the ODB parameter <span style="color: purple;">''/Equipment/Run Parameters/Run Description''</span>  (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/frontend/hardware/num cycles" "Number of cycles"
[local:Default:S]/Edit on start>ln "/Experiment/Run Parameters/Run Description" "Description"
[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  13m  0  RWD
  Number of cycles -> /equipment/fifo_acq/frontend/hardware/num cycles
                                DWORD  1    4    >99d 0  RWD  0
  write data -> /logger/Write data
                                BOOL    1    4    >99d 0  RWD  y
  Description -> /Experiment/Run Parameters/Run Description
         
 
== 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.
 
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 <span style="color: purple;">''Parameter Comments''</span> 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 <span style="color: purple;">''Parameter Comments''</span> subtree must match the name of the actual parameter, rather than the link-name.
 
This is illustrated in the [[#Example|example]] below, where the Edit-on-start parameter is a link named "number of cycles", which links to the actual parameter named <span style="color: purple;">''/equipment/fifo_acq/frontend/hardware/num cycles''</span>.
 
The parameter name in the <span style="color: purple;">''Parameter Comments''</span> subtree for this parameter must be "num cycles" and NOT "number of cycles".
 
== Example of edit-on-start parameters ==
The relevant parts of the /Experiment tree are shown below
[local:test:S]/Experiment>ls -lr
Key name                        Type    #Val  Size  Last Opn Mode Value
---------------------------------------------------------------------------
Experiment                    DIR
    Name                        STRING  1    32    5s  0  RWD  test
    .........
    Run Parameters              DIR
        Run Description        STRING  1    256  2h  0  RWD  Test run
    edit on start              DIR
        run_title              STRING  1    128  1m  0  RWD  test without beam
        experiment number      STRING  1    32    1m  0  RWD  12345
        sample                  STRING  1    32    1m  0  RWD  NA
        field                  STRING  1    32    52s  0  RWD  2500
        Number of cycles -> /equipment/fifo_acq/frontend/hardware/num cycles
                                DWORD  1    4    >99d 0  RWD  0
        write data -> /logger/Write data
                                BOOL    1    4    >99d 0  RWD  y
        Description -> /Experiment/Run Parameters/Run Description
                                STRING  1    256  2h  0  RWD  Test run
    parameter comments          DIR
        field                  STRING  1    64    35m  0  RWD  <i>Entered in Tesla unit</i>
        active                  STRING  1    64    35m  0  RWD  <i>Enter y to save data to disk</i>
        Num cycles              STRING  1    80    34m  0  RWD  <i>Stop run after num cycles is reached. Enter 0 to disable (free running)</i>
      .......
 
Starting a run with edit-on-start parameters set up as above results in a list of the edit-on-start parameters which the user can change (Figure 3).
 
<br>
;Figure 3
: Run start with many edit-on-start parameters defined
 
 
{|  style="text-align: left; width: 100%; background-color: azure;" border="0" cellpadding="2" cellspacing="2"
|+
|-
|  Using [[mhttpd]]<br>
[[File:Mhstart2.gif|thumb|left|Click to enlarge]]
<br clear=all>
|  Using [[odbedit]]<br>
<pre>
[local:test:S]/Experiment>start
run_title : test without beam
experiment number : 12345
sample : NA
field : 2500
Number of cycles : 0
write data : y
Description : Test run
Run number [30499]:
Are the above parameters correct? ([y]/n/q):
Starting run #30499
</pre>
|}

Latest revision as of 22:00, 30 October 2026

The midas documentation has moved. See Asking questions when the run starts (edit on start) on the Runs: configuring page and /Experiment/Edit on start on the ODB keys page for the new documentation about edit-on-start parameters.

Retrieved from "https://daq00.triumf.ca/MidasWiki/index.php?title=Edit-on-start_Parameters&oldid=3696"