Common Parameters to MIDAS Utilities: Difference between revisions

From MidasWiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 2: Line 2:


== Midas experiment (exptname) ==
== Midas experiment (exptname) ==
The [[Application listing|MIDAS utility]]  input parameter  '''exptname'''
The [[Application listing|MIDAS utility]]  input parameter  '''''exptname'''''
;  [-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 [[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.
;  [-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 [[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.






== Midas host (hostname) ==
== Midas host (hostname) ==
The [[Application listing|MIDAS utility]]  input parameter '''hostname'''
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. "hostname" must be a valid IP host name. This option supersedes the default hostname given by the environment variable [[Compilation & Build #MIDAS_SERVER_HOST|MIDAS_SERVER_HOST]] , if defined. Note that the [[mserver]] utility must be running on the remote host in this case. If the experiment is running on the local host, this argument need not be supplied.
; [-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 :
Note:
** ''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. 
If the environment variable [[Compilation & Build #MIDAS_DIR|MIDAS_DIR]] is defined (i.e. single default experiment), the '''expname''' and '''hostname''' input parameters and environment variables [[Compilation & Build #MIDAS_EXPT_NAME|MIDAS_EXPT_NAME]] and [[Compilation & Build #MIDAS_SERVER_HOST|MIDAS_SERVER_HOST]] will be superseded.
** 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.

Revision as of 16:25, 19 August 2013

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

Midas experiment (exptname)

The MIDAS utility input parameter exptname

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


Midas host (hostname)

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