Difference between revisions of "MIDAS environment variables"

From MidasWiki
Jump to navigation Jump to search
(Created page with "The MIDAS DAQ system uses a several environment variables to facilitate the startup of the different applications. These are also discussed in the QuickStart section. ===...")
 
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
The MIDAS DAQ system uses a several environment variables to facilitate the startup of the different applications. These are also discussed in the [[QuickStart]] section.
+
{{Pagelinks}}
  
=== MIDASSYS ===
+
= Introduction =
 +
MIDAS uses a several environment variables to facilitate the startup of the different applications. Only [[#MIDASSYS|MIDASSYS]] is required. 
  
This environmental variable '''is required.''' It should point to the main path of the installed MIDAS package.
+
The MIDAS environment variables are also discussed in [[Compilation & Build]] and [[QuickStart]].
For example
 
  
   setenv MIDASSYS $HOME/packages/midas   
+
;NOTE
 +
:Except where noted, the following environment variables are defined on the '''MIDAS experiment host''', i.e. the host on which the MIDAS experiment shared memories are residing.
 +
<br>
 +
---------
 +
<br>
 +
= MIDASSYS =
 +
This environmental variable is required. It should point to the main path of the installed MIDAS package on the experiment host e.g.
 +
;csh :    setenv MIDASSYS $HOME/packages/midas 
 +
;bash :   export MIDASSYS=$HOME/packages/midas   
 +
The application [[odbedit]] will generate a warning message unless this variable is defined.
  
The application [[odbedit]] will generate a warning message if <span style="color:steelblue;">MIDASSYS</span> is not defined.
 
  
---------------
+
<br>
 
+
--------
=== MIDAS_EXPTAB ===
+
<br>
  
This variable specifies the location of the [[exptab file]] containing the predefined MIDAS experiment.  
+
= MIDAS_EXPTAB =
 +
This variable specifies the location of the optional [[exptab (Experiment Table)|exptab]] file containing the predefined MIDAS experiment(s), e.g.  
  
If <span style="color:steelblue;">MIDAS_EXPTAB</span> is not defined, the default location will be used (i.e. for OS_UNIX: /etc, / and for OS_WINNT: \system32, \system ).
+
;csh : setenv MIDAS_EXPTAB $HOME/online/exptab
For example
+
;bash : export MIDAS_EXPTAB = $HOME/online/exptab
  
  setenv MIDAS_EXPTAB $HOME/online/exptab
+
If '''MIDAS_EXPTAB''' is not defined, the default location will be used (i.e. for OS_UNIX: ''/etc'', / and for OS_WINNT: ''\system32, \system '').
  
 +
  
 +
<br>
 
-----------
 
-----------
 +
<br>
  
 +
= MIDAS_SERVER_HOST =
  
=== MIDAS_SERVER_HOST ===
+
If all the MIDAS clients run on the '''experiment host''', this variable is NOT defined.
  
This variable predefines the name of the host on which the MIDAS experiment shared memories are residing. It is needed when a connection to a remote experiment is requested. It obviates the need to add the "''-h <hostname>''" argument to the utilities command line (see [[Common Parameters to MIDAS Utilities]]). This variable is valid for Unix as well as Windows OS. Superceded if [[#MIDAS_DIR]] is defined.
+
It is needed when a connection to a remote experiment is requested. In that case, this variable is '''defined on the remote host(s)''', and predefines the name of the [[#Introduction|experiment host]]. In this case, the [[mserver]] client must also be started on the experiment host. See [[Quickstart Linux|Quickstart]] for more information.
  
------
+
Defining MIDAS_SERVER_HOST makes adding the "''-h <hostname>''" argument to the application command unnecessary (see [[Common Parameters to MIDAS Utilities]]).
  
 +
'''MIDAS_SERVER_HOST''' will be superseded by [[#MIDAS_DIR |MIDAS_DIR]] if defined. This variable is valid for Unix as well as Windows OS.
  
 +
<br>
 +
--------
 +
<br>
  
=== MIDAS_EXPT_NAME ===
+
= MIDAS_EXPT_NAME =
  
This variable predefines the default name of the experiment to connect to. It prevents the requested application from asking for the experiment name when multiple experiments are available on the host. Defining <span style="color:steelblue;">MIDAS_EXPT_NAME</span> makes adding the "''-e <exptname>''" argument to the application command unnecessary (see [[Common Parameters to MIDAS Utilities]]). This variable is valid for Unix as well as Windows OS.  Superceded if [[#MIDAS_DIR |MIDAS_DIR]] is defined.
 
  
-----
+
Where there are multiple experiments available on the MIDAS experiment host, this variable predefines the name of the experiment to which the user wishes to connect. It prevents the requested application from asking for the experiment name. Defining MIDAS_EXPT_NAME makes adding the ''"-e <exptname>"'' argument to the application command unnecessary (see [[Common Parameters to MIDAS Utilities]]).
  
 +
'''MIDAS_EXPT_NAME''' will be superseded by [[#MIDAS_DIR |MIDAS_DIR]] if defined. This variable is valid for Unix as well as Windows OS.
  
=== MIDAS_DIR ===
+
<br>
 +
--------
 +
<br>
  
This variable predefines the LOCAL directory path where the shared memories for the experiment are located. Defining this variable results in a single experiment called "Default". Since a given directory path can only refer to a single experiment, <span style="color:steelblue;">MIDAS_DIR</span> supersedes the hostname and exptname parameters (see [[Common Parameters to MIDAS Utilities]]) as well as the  
+
= MIDAS_DIR =
[[#MIDAS_SERVER_HOST|MIDAS_SERVER_HOST]] and [[#MIDAS_EXPT_NAME|MIDAS_EXPT_NAME]] environment variables.  
+
This variable predefines the LOCAL directory path where the shared memories for the experiment are located. Defining this variable results in a single experiment called "Default". Since a given directory path can only refer to a single experiment, '''MIDAS_DIR''' supersedes the ''"-e <exptname>"'' and "''-h <hostname>''" arguments as well as the [[#MIDAS_SERVER_HOST |MIDAS_SERVER_HOST]] and [[#MIDAS_EXPT_NAME|MIDAS_EXPT_NAME]] environment variables.
  
Note:
+
;Note : If you wish to use the [[exptab]] file to define multiple experiments on a single host, do not define '''MIDAS_DIR'''.
If you wish to use the "exptab" file (see [[#MIDAS_EXPTAB|MIDAS_EXPTAB]]) to define multiple experiments on a single host, do ''not'' define
 
<span style="color:steelblue;">MIDAS_DIR</span>
 
  
 +
<br>
 +
------------
 +
<br>
  
  
 +
= MIDAS_INVALID_STRING_IS_OK =
 +
;Note
 +
: Environment variable MIDAS_INVALID_STRING_IS_OK and UTF-8 key check added Jan 2017.
  
------
+
By default, the ODB keys names are checked to ensure they are UTF-8 compliant (see [[ODB Access and Use#ODB Keys|ODB Keys]] for more information).
  
 +
Defining environment value  '''MIDAS_INVALID_STRING_IS_OK'''  (set to any value)  disables this key check.  The existence of this environment value is only checked for once, when a program starts.
  
=== ROOTSYS ===
+
<br>
 +
------------
 +
<br>
  
This variable must point to the '''ROOT''' package if generating a complete MIDAS/ROOT analyzer application (see [[Build Options]] ). If not using '''ROOT''',
 
<span style="color:steelblue;">ROOTSYS</span> should be undefined.
 
  
 +
= ROOTSYS =
 +
This variable must point to the ROOT package if generating a complete MIDAS/ROOT analyzer application. If not using ROOT, '''ROOTSYS''' should be undefined.
  
---------
+
<br>
 +
-----------
 +
<br>
  
 +
= CERNLIB_PACK =
 +
In case of HBOOK/PAW analyzer application, this variable should be pointing to a valid cernpacklib.a library. See [[#HAVE_HBOOK |HAVE_HBOOK]].
  
=== CERNLIB_PACK ===
+
<br>
 
+
----------
In case of HBOOK/PAW analyzer application, this variable should be pointing to a valid cernpacklib.a library. See HAVE_HBOOK .
+
<br>
 
 
 
 
 
 
--------
 
 
 
 
 
 
 
 
 
=== MIDAS_FRONTEND_INDEX ===
 
 
 
This variable predefines the index assigned to the equipment using the event builder option. Useful if the frontend applications are started from different hosts. Refer to Principle of the Event Builder and related frontend fragment for more information.
 
 
 
 
 
 
 
-----------
 
 
 
  
 +
= MIDAS_FRONTEND_INDEX =
 +
This variable predefines the index assigned to the equipment using the event builder option. Useful if the [[Frontend Application|Frontend Applications]] are started from different hosts. Refer to [[Event Builder#Event Builder and related frontend fragment|Event Builder and related frontend fragment]] for more information.
 +
<br>
 +
---------
 +
<br>
  
 +
= MCHART_DIR =
 +
This variable is used for the old [[mchart]] utility.
  
=== MCHART_DIR ===
 
  
This variable is used for the old mchart utility.
+
[[Category:Environment variable]] [[Category:Appendices]]

Latest revision as of 16:27, 23 January 2017


Introduction

MIDAS uses a several environment variables to facilitate the startup of the different applications. Only MIDASSYS is required.

The MIDAS environment variables are also discussed in Compilation & Build and QuickStart.

NOTE
Except where noted, the following environment variables are defined on the MIDAS experiment host, i.e. the host on which the MIDAS experiment shared memories are residing.




MIDASSYS

This environmental variable is required. It should point to the main path of the installed MIDAS package on the experiment host e.g.

csh
setenv MIDASSYS $HOME/packages/midas
bash
export MIDASSYS=$HOME/packages/midas

The application odbedit will generate a warning message unless this variable is defined.





MIDAS_EXPTAB

This variable specifies the location of the optional exptab file containing the predefined MIDAS experiment(s), e.g.

csh
setenv MIDAS_EXPTAB $HOME/online/exptab
bash
export MIDAS_EXPTAB = $HOME/online/exptab

If MIDAS_EXPTAB is not defined, the default location will be used (i.e. for OS_UNIX: /etc, / and for OS_WINNT: \system32, \system ).





MIDAS_SERVER_HOST

If all the MIDAS clients run on the experiment host, this variable is NOT defined.

It is needed when a connection to a remote experiment is requested. In that case, this variable is defined on the remote host(s), and predefines the name of the experiment host. In this case, the mserver client must also be started on the experiment host. See Quickstart for more information.

Defining MIDAS_SERVER_HOST makes adding the "-h <hostname>" argument to the application command unnecessary (see Common Parameters to MIDAS Utilities).

MIDAS_SERVER_HOST will be superseded by MIDAS_DIR if defined. This variable is valid for Unix as well as Windows OS.




MIDAS_EXPT_NAME

Where there are multiple experiments available on the MIDAS experiment host, this variable predefines the name of the experiment to which the user wishes to connect. It prevents the requested application from asking for the experiment name. Defining MIDAS_EXPT_NAME makes adding the "-e <exptname>" argument to the application command unnecessary (see Common Parameters to MIDAS Utilities).

MIDAS_EXPT_NAME will be superseded by MIDAS_DIR if defined. This variable is valid for Unix as well as Windows OS.




MIDAS_DIR

This variable predefines the LOCAL directory path where the shared memories for the experiment are located. Defining this variable results in a single experiment called "Default". Since a given directory path can only refer to a single experiment, MIDAS_DIR supersedes the "-e <exptname>" and "-h <hostname>" arguments as well as the MIDAS_SERVER_HOST and MIDAS_EXPT_NAME environment variables.

Note
If you wish to use the exptab file to define multiple experiments on a single host, do not define MIDAS_DIR.





MIDAS_INVALID_STRING_IS_OK

Note
Environment variable MIDAS_INVALID_STRING_IS_OK and UTF-8 key check added Jan 2017.

By default, the ODB keys names are checked to ensure they are UTF-8 compliant (see ODB Keys for more information).

Defining environment value MIDAS_INVALID_STRING_IS_OK (set to any value) disables this key check. The existence of this environment value is only checked for once, when a program starts.





ROOTSYS

This variable must point to the ROOT package if generating a complete MIDAS/ROOT analyzer application. If not using ROOT, ROOTSYS should be undefined.




CERNLIB_PACK

In case of HBOOK/PAW analyzer application, this variable should be pointing to a valid cernpacklib.a library. See HAVE_HBOOK.




MIDAS_FRONTEND_INDEX

This variable predefines the index assigned to the equipment using the event builder option. Useful if the Frontend Applications are started from different hosts. Refer to Event Builder and related frontend fragment for more information.



MCHART_DIR

This variable is used for the old mchart utility.