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






== Midas host ==
== Midas host (hostname) ==
The [[Application listing|MIDAS utility]] input parameter
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. "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.


Line 14: Line 14:
Note:
Note:


If the environment variable [[Compilation & Build #MIDAS_DIR|MIDAS_DIR]] (i.e. single default experiment) is defined, the arguments -e and -h and environment variables [[Compilation & Build #MIDAS_EXPT_NAME|MIDAS_EXPT_NAME]] and  [[Compilation & Build #MIDAS_SERVER_HOST|MIDAS_SERVER_HOST]] will be superseded.
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.

Revision as of 14:58, 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.


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. "hostname" must be a valid IP host name. This option supersedes the default hostname given by the environment variable 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.


Note:

If the environment variable MIDAS_DIR is defined (i.e. single default experiment), the expname and hostname input parameters and environment variables MIDAS_EXPT_NAME and MIDAS_SERVER_HOST will be superseded.