Changes between Version 1 and Version 2 of WRF4GCommandLineInterface


Ignore:
Timestamp:
Sep 28, 2012 2:55:13 PM (10 years ago)
Author:
maru
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • WRF4GCommandLineInterface

    v1 v2  
    1111=== Synopsis ===
    1212wrf4g_framework manages WRF4G framework components: !GridWay and MySQL (in case it is needed).
    13 It load the framework configuration from {{{$WRF4G_LOCATION/etc/framework4g.conf}}}.
     13It loads the framework configuration from {{{$WRF4G_LOCATION/etc/framework4g.conf}}}.
    1414
    1515----
     
    2121
    2222=== Synopsis ===
    23 Given a file (experiment.wrf4g) describing the experiment, prepare the experiment creating the realization and chunks needed to perform it.
     23Given a file (experiment.wrf4g) describing the experiment, prepare it by creating the realization and chunks needed to perform the experiment.
    2424
    2525=== Options ===
     
    4040
    4141=== Synopsis ===
    42 Submits an experiment or realization. If the user do not specify an experiment or realization with the options,
     42Submit an experiment or a realization. If the user doesn't specify an experiment or a realization with the options,
    4343the name of the experiment will be retrieved from  experiment.wrf4g in case it exists in the current folder.   
    4444
     
    5151  -r name, --rea=name   Name of the realization to sumbit
    5252  -F FILE, --frea=FILE  File containing the name of the realization to sumbit.
    53   -a, --rerun           Force to run although ths realization or experiment
     53  -a, --rerun           Force to run although the realization or experiment
    5454                        has finished
    5555  -o, --run-just-one    Run just the first chunk of the first realization.
     
    5858  -R N, --nrea=N        Run the next N realizations not finished of the
    5959                        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
     60  -p P, --priority=P    P is the priority of the experiment or realization that is
     61                        going to be launched (P is an integer between 0 and 20)
     62  -v, --verbose         Verbose mode. It explains what is being done
    6363  -f, --force           Don't ask the user if he wants to submit an experiment
    6464                        already submitted
     
    6666                        Specify dependencies between Chunks. afterok: The
    6767                        chunk may be scheduled for execution only after jobs
    68                         jobid have terminated with no errors.  afternotok: The
     68                        jobid have finished without any error.  afternotok: The
    6969                        chunk may be scheduled for execution only after jobs
    70                         jobid have terminated with errors. afterany: The chunk
     70                        jobid have finished with errors. afterany: The chunk
    7171                        may be scheduled for execution after jobs jobid have
    72                         terminated, with or without errors.
     72                        finished, with or without errors.
    7373}}}
    7474
     
    8080
    8181=== Synopsis ===
    82 Prints the experiment or realization status.
     82Print the experiment or realization status.
    8383
    8484=== Options ===
     
    9090  -l, --long            Show a detailed status.
    9191  -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)
     92                        Print n characters of the Experiment's name
     93                        (default value is 20 characters)
    9494
    9595
     
    129129
    130130    * Realization: Realization name.
    131     * Status: It can be take the following values: P(Prepared), S(Submitted), R(Running), F(Failed) and D(Done).
     131    * Status: It can take the following values: P(Prepared), S(Submitted), R(Running), F(Failed) and D(Done).
    132132    * Chunks [Chunk currently running/Total Chunks]: A realization is split into chunks. Each chunk is sent as a job.
    133133    * Computer resource: Computing Resource where the job is running. (It has to be one of the resources listed by wrf4g_resources)
     
    144144
    145145=== Synopsis ===
    146 Prints information about all the resources configured in framework4g.conf (default)
     146Print information about all the resources configured in framework4g.conf (default)
    147147
    148148=== Options ===
     
    205205=== Synopsys ===
    206206
    207 Change the priority of an experiment or realization. The priority must be in range ![0,20]
    208 and default value is 0. When a chunk gets a priority of 20, it becomes an urgent.
    209 This chunk is dispatched as soon as possible, bypassing all the scheduling policies.
     207Change the priority of an experiment/realization. The priority must be in range ![0,20]
     208and default value is 0. When a chunk gets a priority of 20, it becomes urgent.
     209This chunk is dispatched as soon as possible, passing all the scheduling policies.
    210210
    211211=== Options ===
     
    217217  -r name, --rea=name   Name of the realization to sumbit
    218218  -F FILE, --frea=FILE  File containing the name of the realization to change
    219                         of the priority
     219                        the priority
    220220  -v, --verbose         Verbose mode. Explain what is being done
    221221  -p PRIORITY, --priority=PRIORITY
     
    232232=== Synopsys ===
    233233
    234 Kill an experiment or realization. Only the ckunks, which have not done, will go back to "Prepared" status.
     234Kill an experiment or realization. Only the chunks which haven't been done, will go back to "Prepared" status.
    235235
    236236=== Options ===