Common Parameters to MIDAS Utilities: Difference between revisions

From MidasWiki
Jump to navigation Jump to search
No edit summary
mNo edit summary
 
(6 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{Pagelinks}}
= Common Input Parameters =
Each of the [[Application listing|MIDAS utilities]] define a number of input parameters. The following parameters are common to many :
Each of the [[Application listing|MIDAS utilities]] define a number of input parameters. The following parameters are common to many :


== Midas experiment (exptname) ==
;  [-e <exptname> ] :specifies the [[MIDAS Experiment Name|MIDAS Experiment]] to connect to (where multiple experiments are defined on the MIDAS host (see [[exptab]]).  
The [[Application listing|MIDAS utility]]  input parameter  '''''exptname'''''
* This option supersedes the default experiment name given by the environment variable [[Environment Variables#MIDAS_EXPT_NAME|MIDAS_EXPT_NAME]] , if defined.  
;  [-e <exptname> ] :specifies the MIDAS experiment to connect to (where multiple experiments are defined on the MIDAS host (see [[exptab]]).  
* If multiple experiments are defined, unless  [[Environment Variables#MIDAS_EXPT_NAME|MIDAS_EXPT_NAME]] is defined or this argument is supplied, the application will request the experiment name.
* This option supersedes the default experiment name given by the environment variable [[Compilation & Build #MIDAS_EXPT_NAME|MIDAS_EXPT_NAME]] , if defined.  
* If the environment variable [[Environment Variables#MIDAS_DIR|MIDAS_DIR]] is defined (i.e. single default experiment), both the ''exptname''  input parameter  and environment variable [[Environment Variables#MIDAS_EXPT_NAME|MIDAS_EXPT_NAME]] will be superseded.
* 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.
 




== Midas host (hostname) ==
; [-h <hostname> ]  : connect to midas server [[mserver]] on given host ''hostname'', i.e. specifies the [[MIDAS Host Name |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.
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 :
* If ''hostname'' '''is''' supplied :
** ''hostname''  must be a valid IP host name.  
** ''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.   
** ''hostname'' supersedes the default hostname given by the environment variable [[Environment Variables#MIDAS_SERVER_HOST|MIDAS_SERVER_HOST]] , if defined.   
** the [[mserver]] utility '''must''' be running on the remote host.
** the [[mserver]] utility '''must''' be running on the remote host.
* If more than one copy of <span style="color:darkcyan;font-style:italic">mserver</span> is running, the  <span style="color:darkcyan;font-style:italic">mserver</span> portname must be specified, e.g.
odbedit -h myhost:1173 -e myexpt -c "ls /Experiment"
   
   
* 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.
* If the environment variable [[Environment Variables#MIDAS_DIR|MIDAS_DIR]] is defined (i.e. single default experiment), both the ''hostname'' input parameter  and environment variable  [[Environment Variables#MIDAS_SERVER_HOST|MIDAS_SERVER_HOST]] will be superseded.
 
[[Category:Utilities]] [[Category:Appendices]]

Latest revision as of 18:36, 8 June 2016


Common Input Parameters

Each of the MIDAS utilities define a number of input parameters. The following parameters are common to many :

[-e <exptname> ]
specifies the MIDAS Experiment 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 MIDAS_EXPT_NAME , if defined.
  • If multiple experiments are defined, unless MIDAS_EXPT_NAME is defined or this argument is supplied, the application will request the experiment name.
  • If the environment variable MIDAS_DIR is defined (i.e. single default experiment), both the exptname input parameter and environment variable MIDAS_EXPT_NAME will be superseded.


[-h <hostname> ]
connect to midas server mserver on given host hostname, i.e. 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 MIDAS_SERVER_HOST , if defined.
    • the mserver utility must be running on the remote host.
  • If more than one copy of mserver is running, the mserver portname must be specified, e.g.
odbedit -h myhost:1173 -e myexpt -c "ls /Experiment"


  • If the environment variable MIDAS_DIR is defined (i.e. single default experiment), both the hostname input parameter and environment variable MIDAS_SERVER_HOST will be superseded.
Retrieved from "https://daq00.triumf.ca/MidasWiki/index.php?title=Common_Parameters_to_MIDAS_Utilities&oldid=2527"