Common Parameters to MIDAS Utilities: Difference between revisions

From MidasWiki
Jump to navigation Jump to search
No edit summary
(The midas documentation has moved to https://midas.triumf.ca/docs/)
 
(6 intermediate revisions by one other user not shown)
Line 1: Line 1:
 
The midas documentation has moved. See [https://midas.triumf.ca/docs/develop/reference/reference/programs/#common-parameters-for-many-midas-programs Common parameters for many midas programs] on the Programs and options page for the new documentation about the command-line parameters that many midas programs share.
== Midas experiment name ==
The name of the MIDAS experiment is given by
# environment variable [[Compilation & Build #MIDAS_DIR|MIDAS_DIR]] if defined
# the [[Application listing|MIDAS utility]]  input parameter  '''''exptname''''' if supplied
# environment variable [[Compilation & Build #MIDAS_EXPT_NAME|MIDAS_EXPT_NAME]] if defined
# if multiple experiments defined, user will be requested to supply experiment name
 
== Midas host name ==
The name of the MIDAS host is given by
#  environment variable [[Compilation & Build #MIDAS_DIR|MIDAS_DIR]] if defined
#  the [[Application listing|MIDAS utility]]  input parameter '''''hostname''''' if supplied
#  environment variable [[Compilation & Build #MIDAS_SERVER_HOST|MIDAS_SERVER_HOST]] if defined
#  '''local''' host
 
 
Each of the [[Application listing|MIDAS utilities]] define a number of input parameters. The following parameters are common to many :
 
The [[Application listing|MIDAS utility]]  input parameter  '''''exptname'''''
;  [-e <exptname> ] :specifies the [[MIDAS Experiment and Host names]] to connect to (where multiple experiments are defined on the MIDAS host (see [[exptab]]).  
* This option supersedes the default experiment name given by the environment variable [[Compilation & Build #MIDAS_EXPT_NAME|MIDAS_EXPT_NAME]] , if defined.  
* If multiple experiments are defined, unless  [[Compilation & Build #MIDAS_EXPT_NAME|MIDAS_EXPT_NAME]] is defined or this argument is supplied, the application will request the experiment name.
* If the environment variable [[Compilation & Build #MIDAS_DIR|MIDAS_DIR]] is defined (i.e. single default experiment), both the ''exptname''  input parameter  and environment variable [[Compilation & Build #MIDAS_EXPT_NAME|MIDAS_EXPT_NAME]] will be superseded.
 
 
 
 
The [[Application listing|MIDAS utility]]  input parameter '''''hostname'''''
; [-h <hostname> ]  : specifies the MIDAS host to connect to when connecting to an experiment running on a '''remote''' host. If the experiment is running on the '''local''' host, this argument need not be supplied.
 
* If ''hostname'' is supplied :
** ''hostname''  must be a valid IP host name.
** ''hostname'' supersedes the default hostname given by the environment variable [[Compilation & Build #MIDAS_SERVER_HOST|MIDAS_SERVER_HOST]] , if defined. 
** the [[mserver]] utility '''must''' be running on the remote host.
* If the environment variable [[Compilation & Build #MIDAS_DIR|MIDAS_DIR]] is defined (i.e. single default experiment), both the ''hostname'' input parameter  and environment variable  [[Compilation & Build #MIDAS_SERVER_HOST|MIDAS_SERVER_HOST]] will be superseded.

Latest revision as of 22:00, 30 October 2026

The midas documentation has moved. See Common parameters for many midas programs on the Programs and options page for the new documentation about the command-line parameters that many midas programs share.

Retrieved from "https://daq00.triumf.ca/MidasWiki/index.php?title=Common_Parameters_to_MIDAS_Utilities&oldid=3682"