Common Parameters to MIDAS Utilities: Difference between revisions

From MidasWiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
== 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 :
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 Name|MIDAS Experiment]] to connect to (where multiple experiments are defined on the MIDAS host (see [[exptab]]).  
;  [-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.  
* 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 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.
Line 24: Line 8:




 
; [-h <hostname> ]  : 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 :

Revision as of 16:36, 20 August 2013

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> ]
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 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.