Changes between Initial Version and Version 1 of 2017WP/CONFIGMAN-3-Julien_runoff


Ignore:
Timestamp:
2017-05-11T16:41:44+02:00 (3 years ago)
Author:
jpaul
Comment:

Legend:

Unmodified
Added
Removed
Modified
  • 2017WP/CONFIGMAN-3-Julien_runoff

    v1 v1  
     1= '''''CONFIGMAN-3-Julien_runoff''''' 
     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.[[BR]] 
     4 
     5== Help 
     6 
     7{{{#!html 
     8The action has to be detailed briefly in the 'Summary' sub-page (ordinary wiki page) for later inclusion in other pages. Out of this, the rest of the page can be edited on-line inside the form fields considering the following color code given hereafter.<br><b>Record your modifications for the section you have edited by clicking on the corresponding button at the end of the section 
     9(<input type="submit" value="Save ... "/>). Just above, the timestamp of the record will be updated. 
     10</b> 
     11}}} 
     12{{{#!div class="important" 
     13Apart from the case of 'Summary' section (inclusion of sub-page), the informations inside the form fields and this wiki page itself are stored in 2 separate databases. As 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. 
     14}}} 
     15 
     16{{{#!div style="margin-left:25px" 
     17{{{#!th 
     18Role 
     19}}} 
     20{{{#!th 
     21Link(s) 
     22}}} 
     23|- 
     24{{{#!td style="background:lightgrey" 
     25PI(S) 
     26}}} 
     27{{{#!td style="background:lightgrey" 
     28{{{#!td width="100px" style="background:lightgrey; border:none" 
     29 1. [#summary Summary] 
     30}}} 
     31{{{#!td width="100px" style="border:none" 
     32 2. [#abstract Abstract] 
     33}}} 
     34{{{#!td width="100px" style="border:none" 
     35 4. [#tests Tests] 
     36}}} 
     37}}} 
     38|- 
     39{{{#!td style="background:lightblue" 
     40Previewer(s) 
     41}}} 
     42{{{#!td style="background:lightblue" 
     43 3. [#preview Preview] 
     44}}} 
     45|- 
     46{{{#!td style="background:lightgreen" 
     47Reviewer(s) 
     48}}} 
     49{{{#!td style="background:lightgreen" 
     50 5. [#review Review] 
     51}}} 
     52}}} 
     53 
     54== Summary [=#summary] 
     55 
     56'''[./Summary Edit the summary]''' 
     57 
     58{{{#!div style="background:lightgrey" 
     59[[Include(./Summary)]] 
     60}}} 
     61 
     62{{{#!Fold title=Abstract tag=h2 
     63[=#abstract] 
     64 
     65This section should be completed before starting to develop the code, in order to find agreement on the method beforehand. 
     66 
     67{{{ 
     68#!TracForm 
     69#!subcontext abstract 
     70#!submit_label 'Save Abstract' 
     71#!keep_history yes 
     72=== Description === 
     73 [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] 
     74=== Implementation === 
     75 [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] 
     76=== Reference manual and web pages updates === 
     77 [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] 
     78 
     79'''''Updated on [tf.form_updated_on:] by [tf.form_updater:]''''' 
     80}}} 
     81 
     82Once the PI has completed this section, he should send a mail to the previewer(s) asking them to preview the work within two weeks. 
     83 
     84}}} 
     85 
     86{{{#!Fold title=Preview tag=h2 
     87[=#preview] 
     88 
     89Since 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. 
     90 
     91{{{ 
     92#!TracForm 
     93#!subcontext preview_ 
     94#!submit_label 'Save Preview' 
     95|| Questions || Answer || Comment || 
     96|| 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] || 
     97|| 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] || 
     98|| 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] || 
     99|| 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] || 
     100|| ... ... ... || [tf.select:2.X -id=preform '' Yes No NR] || [tf.textarea:2.Xc -id=preform 'Add a comment?' 50 10] || 
     101 
     102'''''Updated on [tf.form_updated_on:] by [tf.form_updater:]''''' 
     103}}} 
     104 
     105Once all "YES" have been reached, the PI can start the development into his development branch. 
     106 
     107}}} 
     108 
     109{{{#!Fold title=Tests tag=h2 
     110[=#tests] 
     111 
     112Once the development is done, the PI should complete this section below and ask the reviewers to start their review in the lower section. 
     113 
     114{{{ 
     115#!TracForm 
     116#!subcontext tests 
     117#!submit_label 'Save Tests' 
     118|| Questions || Answer || Comment || 
     119|| 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] || 
     120|| 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] || 
     121|| 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] || 
     122|| 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] || 
     123|| 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] || 
     124|| 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] || 
     125|| 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] || 
     126|| 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] || 
     127|| 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] || 
     128|| 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] || 
     129|| ... ... ... || [tf.select:3.XX -id=piform '' Yes No NR] || [tf.textarea:3.XXc -id=piform 'Add a comment?' 50 10] || 
     130 
     131'''''Updated on [tf.form_updated_on:] by [tf.form_updater:]''''' 
     132}}} 
     133 
     134}}} 
     135 
     136{{{#!Fold title=Review tag=h2 
     137[=#review] 
     138 
     139A successful review is needed to schedule the merge of this development into the future NEMO release during next Merge Party (usually in November). 
     140 
     141{{{ 
     142#!TracForm 
     143#!subcontext review 
     144#!submit_label 'Save Review' 
     145=== Code changes and documentation === 
     146|| Question || Answer || Comment || 
     147|| 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] || 
     148|| 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] || 
     149|| 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] || 
     150|| 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] || 
     151|| 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] || 
     152|| 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] || 
     153|| 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] || 
     154|| 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] || 
     155|| ... ... ... || [tf.select:3.XX -id=revform '' Yes No NR] || [tf.textarea:3.XXc -id=revform 'Add a comment?' 50 10] || 
     156'''__Review Summary__'''[[BR]] 
     157Is the review fully successful?[tf.select:status -id=revform '' Yes No][[BR]] 
     158[tf.textarea:comment -id=revform 'If not, please indicate what is still missing.' 50 10] 
     159 
     160'''''Updated on [tf.form_updated_on:] by [tf.form_updater:]''''' 
     161}}} 
     162 
     163Once review is successful, the development must be scheduled for merge during next Merge Party Meeting. 
     164 
     165}}}