Changes between Initial Version and Version 1 of WRF4GCommandLineInterface


Ignore:
Timestamp:
Sep 12, 2012 11:06:41 AM (10 years ago)
Author:
carlos
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • WRF4GCommandLineInterface

    v1 v1  
     1[[PageOutline(1-10)]]
     2
     3
     4= Command Line Interface (CLI) for WRF4G =
     5
     6== wrf4g_framework == #wrf4g_framework
     7
     8=== Usage ===
     9wrf4g_framework {start|stop|restart|reload|status}
     10
     11=== Synopsis ===
     12wrf4g_framework manages WRF4G framework components: !GridWay and MySQL (in case it is needed).
     13It load the framework configuration from {{{$WRF4G_LOCATION/etc/framework4g.conf}}}.
     14
     15----
     16
     17== wrf4g_prepare == #wrf4g_prepare
     18
     19=== Usage ===
     20wrf4g_prepare  [--dry-run] [--reconfigure] [--verbose] [--help]
     21
     22=== Synopsis ===
     23Given a file (experiment.wrf4g) describing the experiment, prepare the experiment creating the realization and chunks needed to perform it.
     24
     25=== Options ===
     26{{{
     27  --dry-run        Perform a trial run with no changes made.
     28  --reconfigure    Reconfigure experiment. With this option we can change the start and end date of the experiments
     29                   and add new physics. Values are taken from a modified experiment.wrf4g.
     30  --verbose        Verbose mode. Explain what is being done
     31  --help           Shows this help
     32}}}
     33
     34----
     35
     36== wrf4g_submit == #wrf4g_submit
     37== Usage ==
     38wrf4g_submit [--dry-run] [--{exp Experiment|rea Realization|frea File|chunk ChunK|nchunk Number_of_chunks|nrea Number_of_realizations}] [--rerun] [--run-just-one][--priority P] [--verbose] [--force] [--tdep afterok | afternotok | afterany] [--help]
     39
     40
     41=== Synopsis ===
     42Submits an experiment or realization. If the user do not specify an experiment or realization with the options,
     43the name of the experiment will be retrieved from  experiment.wrf4g in case it exists in the current folder.   
     44
     45=== Options ===
     46{{{
     47  --version             show program's version number and exit
     48  -h, --help            show this help message and exit
     49  -n, --dry-run         Perform a trial run with no changes made
     50  -e name, --exp=name   Name of the experiment to sumbit
     51  -r name, --rea=name   Name of the realization to sumbit
     52  -F FILE, --frea=FILE  File containing the name of the realization to sumbit.
     53  -a, --rerun           Force to run although ths realization or experiment
     54                        has finished
     55  -o, --run-just-one    Run just the first chunk of the first realization.
     56                        Only for testing purposes.
     57  -C N, --nchunk=N      Run the next N chunks not finished of each realization
     58  -R N, --nrea=N        Run the next N realizations not finished of the
     59                        experiment
     60  -p P, --priority=P    P is the priority of the experiment or realization is
     61                        going to be launched (P is a integer between 0 and 20)
     62  -v, --verbose         Verbose mode. Explain what is being done
     63  -f, --force           Don't ask the user if he wants to submit an experiment
     64                        already submitted
     65  -d TYPE_DEP, --tdep=TYPE_DEP
     66                        Specify dependencies between Chunks. afterok: The
     67                        chunk may be scheduled for execution only after jobs
     68                        jobid have terminated with no errors.  afternotok: The
     69                        chunk may be scheduled for execution only after jobs
     70                        jobid have terminated with errors. afterany: The chunk
     71                        may be scheduled for execution after jobs jobid have
     72                        terminated, with or without errors.
     73}}}
     74
     75----
     76
     77== wrf4g_status == #wrf4g_status
     78=== Usage ===
     79wrf4g_status [--{exp Experiment|rea Realization}] [--long] [--ncharacters N] [--help]
     80
     81=== Synopsis ===
     82Prints the experiment or realization status.
     83
     84=== Options ===
     85{{{
     86  --version             show program's version number and exit
     87  -h, --help            show this help message and exit
     88  -e name, --exp=name   Name of the experiment.
     89  -r name, --rea=name   Name of the realization
     90  -l, --long            Show a detailed status.
     91  -n NUMBER_OF_CHARACTERS, --ncharacters=NUMBER_OF_CHARACTERS
     92                        Print n characters of the name of the Experiment or
     93                        Realization (default value is 20 characters)
     94
     95
     96}}}
     97
     98=== Output field description ===
     99'''Summarized output''': Shows realizations' status of each experiment (Default).
     100{{{
     101#!sh
     102[user@mycomputer~]$ wrf4g_status
     103Experiment P   W   R   D   F 
     104test       0   0   0   1   0 
     105uc_phys    0   4   1   0   0 
     106uc_single  1   0   0   0   0 
     107}}}
     108 
     109  * P: Prepared
     110  * W: Waiting
     111  * R: Running
     112  * F: Failed
     113
     114'''Long output''': Shows a detailed realization status of every experiment
     115
     116{{{
     117#!sh
     118[user@mycomputer~]$ wrf4g_status --long
     119Realization        GW  Stat Chunks Comp.Res   WN         Run.Sta       ext   %
     120test               2     D  3/3    mycomputer sipc18     Finished       0 100.00
     121uc_phys__phys1     3     R  1/3    mycomputer sipc18     WRF            - 0.00
     122uc_phys__phys2     6     W  1/3    -          -          Submitted      - 0.00
     123uc_phys__phys3     9     W  1/3    -          -          Submitted      - 0.00
     124uc_phys__phys4     12    W  1/3    -          -          Submitted      - 0.00
     125uc_phys__phys5     15    W  1/3    -          -          Submitted      - 0.00
     126uc_single          -     P  0/3    -          -          Prepared       - 0.00
     127}}}
     128
     129
     130    * Realization: Realization name.
     131    * Status: It can be take the following values: P(Prepared), S(Submitted), R(Running), F(Failed) and D(Done).
     132    * Chunks [Chunk currently running/Total Chunks]: A realization is split into chunks. Each chunk is sent as a job.
     133    * Computer resource: Computing Resource where the job is running. (It has to be one of the resources listed by wrf4g_resources)
     134    * WN: Computing node where the job is running.
     135    * Run.Sta: Job status in the WN (Downloading data, running ungrib, real, wrf, ...)
     136    * ext: Exit Code. If exit code is different from 0, there has been an error. Error codes are explained in `$WRF4G_LOCATION/lib/bash/wrf4g_exit_codes.sh`
     137    * % : percentage of simulation finished.
     138
     139----
     140
     141== wrf4g_resources == #wrf4g_resources
     142=== Usage ===
     143wrf4g_resources [-h] [-c delay] [-nfx] [-m job_id] [host_id]
     144
     145=== Synopsis ===
     146Prints information about all the resources configured in framework4g.conf (default)
     147
     148=== Options ===
     149{{{
     150  -h           print this help
     151  -c delay     refresh host information every delay seconds
     152  -n           do not print the header
     153  -f           full format
     154  -x           xml format
     155  -m job_id    print hosts matching the requirements of a given job
     156  host_id      only monitor this host_id, printing also queue information
     157}}}
     158
     159=== Output field description ===
     160
     161{{{
     162#!sh
     163[user@mycomputer~]$  wrf4g_resources
     164HID PRIO OS              ARCH  MHZ  %CPU    MEM(F/T)     DISK(F/T)      N(U/F/T) LRMS               HOSTNAME                     
     1650   1    GNU/Linux2.6.32 x86_6 2000    0    484/3270     1152/8662         0/1/1 FORK               mycomputer                   
     1661   1    GNU/Linux2.6.18 x86_6 2127    0     12/2048 671273/921472       88/0/88 PBS                asna_t1                       
     1672   1    GNU/Linux2.6.18 x86_6 2127    0     11/2048 671273/921472     168/0/168 PBS                asna_b2     
     168}}}
     169
     170{{{
     171FIELD INFORMATION
     172  HID          host unique identification assigned by the GridWay system
     173  PRIO         priority assigned to the host
     174  OS           operating system
     175  ARCH         architecture
     176  MHZ          CPU speed in MHZ
     177  %CPU         free CPU ratio
     178  MEM(F/T)     system memory: F = Free, T = Total
     179  DISK(F/T)    secondary storage: F = Free, T = Total
     180  N(U/F/T)     number of slots: U = used by GridWay, F = free, T = total
     181  LRMS         local resource management system, the jobmanager name
     182  HOSTNAME     FQDN of this hostthe
     183
     184QUEUE FIELD INFORMATION
     185  QUEUENAME    name of this queue
     186  SL(F/T)      slots:  F = Free, T = Total
     187  WALLT        queue wall time
     188  CPUT         queue cpu time
     189  COUNT        queue count number
     190  MAXR         max. running jobs
     191  MAXQ         max. queued jobs
     192  STATUS       queue status
     193  DISPATCH     queue dispatch type
     194  PRIORITY     queue priority
     195
     196}}}
     197
     198----
     199
     200== wrf4g_priority ==
     201
     202=== Usage ===
     203wrf4g_priority [--dry-run] [--{exp Experiment |rea Realization |frea File}] [--priority P] [--verbose] [--help]
     204
     205=== Synopsys ===
     206
     207Change the priority of an experiment or realization. The priority must be in range ![0,20]
     208and default value is 0. When a chunk gets a priority of 20, it becomes an urgent.
     209This chunk is dispatched as soon as possible, bypassing all the scheduling policies.
     210
     211=== Options ===
     212{{{
     213  --version             show program's version number and exit
     214  -h, --help            show this help message and exit
     215  -n, --dry-run         Perform a trial run with no changes made
     216  -e name, --exp=name   Name of the experiment to sumbit
     217  -r name, --rea=name   Name of the realization to sumbit
     218  -F FILE, --frea=FILE  File containing the name of the realization to change
     219                        of the priority
     220  -v, --verbose         Verbose mode. Explain what is being done
     221  -p PRIORITY, --priority=PRIORITY
     222                        The priority must be in range [0,20].
     223}}}
     224
     225----
     226
     227== wrf4g_kill ==
     228
     229=== Usage ===
     230wrf4g_kill [--dry-run] [--{exp Experiment |rea Realization|frea File}] [--verbose] [--help]
     231
     232=== Synopsys ===
     233
     234Kill an experiment or realization. Only the ckunks, which have not done, will go back to "Prepared" status.
     235
     236=== Options ===
     237{{{
     238   --version            show program's version number and exit
     239  -h, --help            show this help message and exit
     240  -n, --dry-run         Perform a trial run with no changes made
     241  -e name, --exp=name   Name of the experiment to sumbit
     242  -r name, --rea=name   Name of the realization to sumbit
     243  -F FILE, --frea=FILE  File containing the name of the realization to kill.
     244  -v, --verbose         Verbose mode. Explain what is being done.
     245}}}