Changes between Initial Version and Version 1 of 2017WP/Met_Office-1_Matt Martin_avgoperator


Ignore:
Timestamp:
2017-05-18T04:02:31+02:00 (4 years ago)
Author:
nicolasmartin
Comment:

New page from template Work Plan Action?

Legend:

Unmodified
Added
Removed
Modified
  • 2017WP/Met_Office-1_Matt Martin_avgoperator

    v1 v1  
     1= '''''Met_Office-1_MattMartin_avgoperator''''' 
     2 
     3The PI is responsible to closely follow the progress of the action, and especially to contact NEMO project manager if the delay on preview (or review) are longer than the 2 weeks expected. 
     4 
     5== Help 
     6 
     7The action has to be detailed briefly in the 'Summary' section for later inclusion in other pages.\\ 
     8Edit the 'Summary' section as with an ordinary wiki page. 
     9* ''Italic formatting'' shows the default values or help. 
     10* Set specific TracLinks (development ticket and branch). 
     11 
     12Out of this, the rest of the page can be edited on-line inside the form fields considering the following color code given hereafter. 
     13 
     14{{{#!th 
     15   Role / Color code 
     16}}} 
     17||  [[span(PI(S), style=background-color:lightgrey)]]  ||  [[span(Previewer(s), style=background-color:lightblue)]]  ||  [[span(Reviewer(s), style=background-color:lightgreen)]]  || 
     18 
     19Record your modifications for the section you have edited by clicking on the corresponding button at the end of the section with 'Save ...' button. Just above, the log record will be updated. 
     20 
     21The informations inside the form fields and this wiki page itself are stored in 2 separate databases.\\ 
     22As a consequence, there is absolutely no risk to make any modification in the page itself as long as you don't rename the page or modify the source code of `{{{#!TracForm ... }}}` processors. 
     23 
     24== Summary #summary 
     25 
     26|| '''Action'''       || Met_Office-1_MattMartin_avgoperator           || 
     27|| '''PI(S)'''        || Matt Martin                            || 
     28{{{#!td 
     29'''Digest''' 
     30}}} 
     31{{{#!td 
     32Add an averaging operator to OBS operator for use with satellite observations 
     33}}} 
     34|- 
     35|| '''Dependencies''' || ''Depends on ...''                                                         || 
     36|| '''Target'''       || ''Priority or deadline''                                                   || 
     37|| '''Trac Ticket'''  || #XXXX                                                                      || 
     38|| '''SVN branch'''   || [source:/branches/$YEAR/dev_r{REV}_{WGorINSTITUTE}-{NUM}_{PIS}-{KEYWORDS}] || 
     39|| '''Previewer(s)''' || ''Names''                                                                  || 
     40|| '''Reviewer(s)'''  || ''Names''                                                                  || 
     41|| '''Status'''       || ''!Pending/In progress/Postponed/Ready''                                   || 
     42|| '''Link'''         || [[ExtractUrl(.)]]                                                          ||   
     43 
     44{{{#!comment 
     45DON'T REMOVE THIS VOID HEADING OR IT WILL BREAK THE INCLUDE FEATURE BETWEEN WIKI PAGES 
     46}}} 
     47==  == 
     48{{{#!comment 
     49DON'T REMOVE THIS VOID HEADING OR IT WILL BREAK THE INCLUDE FEATURE BETWEEN WIKI PAGES 
     50}}} 
     51 
     52{{{#!Fold title=Abstract tag=h2 
     53[=#abstract] 
     54 
     55This section should be completed before starting to develop the code, in order to find agreement on the method beforehand. 
     56 
     57{{{#!TracForm 
     58#!subcontext abstract 
     59#!submit_label 'Save Abstract' 
     60#!keep_history yes 
     61 
     62=== Description 
     63 
     64 [tf.textarea:description -id=piform -class=taform 'Describe the goal of development, and the methodology.\n\nAdd reference documents or publications if relevant.' 0 20] 
     65 
     66=== Implementation 
     67 
     68 [tf.textarea:implementation -id=piform -class=taform 'Describe flow chart of the changes in the code.\n\nList the .F90 files and modules to be changed.\n\nDetailed list of new variables (including namelists) to be defined.\nGive for each the chosen name (following coding rules) and definition.' 0 20] 
     69 
     70=== Reference manual and web pages updates 
     71 
     72 [tf.textarea:manual -id=piform -class=taform 'Using part 1 and 2, define the summary of changes to be done in the NEMO reference manual (tex files), and in the content of web pages.' 0 20] 
     73 
     74'''''Updated on [tf.form_updated_on:] by [tf.form_updater:]''''' 
     75 
     76}}} 
     77 
     78Once the PI has completed this section, he should send a mail to the previewer(s) asking them to preview the work within two weeks. 
     79 
     80}}} 
     81 
     82{{{#!Fold title=Preview tag=h2 
     83[=#preview] 
     84 
     85Since the preview step must be completed before the PI starts the coding, the previewer(s) answers are expected to be completed within the two weeks after the PI has sent his request.[[BR]]For each question, an iterative process should take place between PI and previewer(s) in order to reach a "YES" answer for each of the following questions. 
     86 
     87{{{#!TracForm 
     88#!subcontext preview_ 
     89#!submit_label 'Save Preview' 
     90 
     91|| Questions || Answer || Comment || 
     92|| Does the previewer agree with the proposed methodology? || [tf.select:2.1 -id=preform '' Yes No NR] || [tf.textarea:2.1c -id=preform 'Add a comment?' 50 10] || 
     93|| Does the previewer agree with the proposed flowchart and list of routines to be changed? || [tf.select:2.2 -id=preform '' Yes No NR] || [tf.textarea:2.2c -id=preform 'Add a comment?' 50 10] || 
     94|| Does the previewer agree with the proposed new list of variables, including agreement with coding rules? || [tf.select:2.3 -id=preform '' Yes No NR] || [tf.textarea:2.3c -id=preform 'Add a comment?' 50 10] || 
     95|| Does the previewer agree with the proposed summary of updates in reference manual? || [tf.select:2.4 -id=preform '' Yes No NR] || [tf.textarea:2.4c -id=preform 'Add a comment?' 50 10] || 
     96|| ... ... ... || [tf.select:2.X -id=preform '' Yes No NR] || [tf.textarea:2.Xc -id=preform 'Add a comment?' 50 10] || 
     97 
     98'''''Updated on [tf.form_updated_on:] by [tf.form_updater:]''''' 
     99 
     100}}} 
     101 
     102Once all "YES" have been reached, the PI can start the development into his development branch. 
     103 
     104}}} 
     105 
     106{{{#!Fold title=Tests tag=h2 
     107[=#tests] 
     108 
     109Once the development is done, the PI should complete this section below and ask the reviewers to start their review in the lower section. 
     110 
     111{{{#!TracForm 
     112#!subcontext tests 
     113#!submit_label 'Save Tests' 
     114 
     115|| Questions || Answer || Comment || 
     116|| Can this change be shown to produce expected impact? (if option activated)? || [tf.select:3.1 -id=piform '' Yes No NR] || [tf.textarea:3.1c -id=piform 'Add a comment?' 50 10] || 
     117|| Can this change be shown to have a null impact? (if option not activated) || [tf.select:3.2 -id=piform '' Yes No NR] || [tf.textarea:3.2c -id=piform 'Add a comment?' 50 10] || 
     118|| Detailed results of restartability and reproducibility when the option is activated. Please indicate the configuration used for this test || [tf.select:3.3 -id=piform '' Yes No NR] || [tf.textarea:3.3c -id=piform 'Add a comment?' 50 10] || 
     119|| Detailed results of SETTE tests (restartability and reproducibility for each of the reference configuration) || [tf.select:3.4 -id=piform '' Yes No NR] || [tf.textarea:3.4c -id=piform 'Add a comment?' 50 10] || 
     120|| Results of the required bit comparability tests been run: Are there no differences when activating the development? || [tf.select:3.5 -id=piform '' Yes No NR] || [tf.textarea:3.5c -id=piform 'Add a comment?' 50 10] || 
     121|| If some differences appear, is reason for the change valid/understood? || [tf.select:3.6 -id=piform '' Yes No NR] || [tf.textarea:3.6c -id=piform 'Add a comment?' 50 10] || 
     122|| If some differences appear, is the !ticket describing in detail the impact this change will have on model configurations? || [tf.select:3.7 -id=piform '' Yes No NR] || [tf.textarea:3.7c -id=piform 'Add a comment?' 50 10] || 
     123|| Is this change expected to preserve all diagnostics? || [tf.select:3.8 -id=piform '' Yes No NR] || [tf.textarea:3.8c -id=piform 'Add a comment?' 50 10] || 
     124|| If no, is reason for the change valid/understood? || [tf.select:3.9 -id=piform '' Yes No NR] || [tf.textarea:3.9c -id=piform 'Add a comment?' 50 10] || 
     125|| Are there significant changes in run time/memory? || [tf.select:3.10 -id=piform '' Yes No NR] || [tf.textarea:3.10c -id=piform 'Add a comment?' 50 10] || 
     126|| ... ... ... || [tf.select:3.XX -id=piform '' Yes No NR] || [tf.textarea:3.XXc -id=piform 'Add a comment?' 50 10] || 
     127 
     128'''''Updated on [tf.form_updated_on:] by [tf.form_updater:]''''' 
     129 
     130}}} 
     131 
     132}}} 
     133 
     134{{{#!Fold title=Review tag=h2 
     135[=#review] 
     136 
     137A successful review is needed to schedule the merge of this development into the future NEMO release during next Merge Party (usually in November). 
     138 
     139{{{#!TracForm 
     140#!subcontext review 
     141#!submit_label 'Save Review' 
     142 
     143=== Code changes and documentation 
     144 
     145|| Question || Answer || Comment || 
     146|| Is the proposed methodology now implemented? || [tf.select:3.11 -id=revform '' Yes No NR] || [tf.textarea:3.11c -id=revform 'Add a comment?' 50 10] || 
     147|| Are the code changes in agreement with the flowchart defined at Preview step? || [tf.select:3.12 -id=revform '' Yes No NR] || [tf.textarea:3.12c -id=revform 'Add a comment?' 50 10] || 
     148|| Are the code changes in agreement with list of routines and variables as proposed at Preview step?[[BR]]If not, are the discrepancies acceptable? || [tf.select:3.13 -id=revform '' Yes No NR] || [tf.textarea:3.13c -id=revform 'Add a comment?' 50 10] || 
     149|| Is the in-line documentation accurate and sufficient? || [tf.select:3.14 -id=revform '' Yes No NR] || [tf.textarea:3.14c -id=revform 'Add a comment?' 50 10] || 
     150|| Do the code changes comply with NEMO coding standards? || [tf.select:3.15 -id=revform '' Yes No NR] || [tf.textarea:3.15c -id=revform 'Add a comment?' 50 10] || 
     151|| Is the !ticket of development documented with sufficient details for others to understand the impact of the change? || [tf.select:3.16 -id=revform '' Yes No NR] || [tf.textarea:3.16c -id=revform 'Add a comment?' 50 10] || 
     152|| Are the reference manual tex files now updated following the proposed summary in preview section? || [tf.select:3.17 -id=revform '' Yes No NR] || [tf.textarea:3.17c -id=revform 'Add a comment?' 50 10] || 
     153|| Is there a need for some documentation on the web pages (in addition to in-line and reference manual)?[[BR]]If yes, please describe and ask PI. A yes answer must include all documentation available. || [tf.select:3.18 -id=revform '' Yes No NR] || [tf.textarea:3.18c -id=revform 'Add a comment?' 50 10] || 
     154|| ... ... ... || [tf.select:3.XX -id=revform '' Yes No NR] || [tf.textarea:3.XXc -id=revform 'Add a comment?' 50 10] || 
     155 
     156==== Review Summary 
     157 
     158Is the review fully successful? [tf.select:status -id=revform '' Yes No] 
     159 
     160[tf.textarea:comment -id=revform 'If not, please indicate what is still missing.' 50 10] 
     161 
     162'''''Updated on [tf.form_updated_on:] by [tf.form_updater:]''''' 
     163 
     164}}} 
     165 
     166Once review is successful, the development must be scheduled for merge during next Merge Party Meeting. 
     167 
     168}}}