New URL for NEMO forge!   http://forge.nemo-ocean.eu

Since March 2022 along with NEMO 4.2 release, the code development moved to a self-hosted GitLab.
This present forge is now archived and remained online for history.
2016WP/SIMPLIF-3_BDY (diff) – NEMO

Changes between Initial Version and Version 1 of 2016WP/SIMPLIF-3_BDY


Ignore:
Timestamp:
2016-06-13T19:19:10+02:00 (8 years ago)
Author:
lovato
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • 2016WP/SIMPLIF-3_BDY

    v1 v1  
     1= 2016WP  SIMPLIF-3 Remove key_bdy= 
     2 
     3This is the color code for the fulfilment of this form: 
     4{{{#!td style='background:lightgrey' 
     5PI(S) 
     6}}} 
     7{{{#!td style='background:lightblue' 
     8Previewer(s) 
     9}}} 
     10{{{#!td style='background:lightgreen' 
     11Reviewer(s) 
     12}}} 
     13 
     14---- 
     15 
     16[[PageOutline(2)]] 
     17 
     18The 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]] 
     19 
     20== Abstract == 
     21 
     22{{{ 
     23#!TracForm 
     24#!subcontext abstract 
     25#!submit_label 'Save Abstract' 
     26#!keep_history yes 
     27'''__Details__'''[[BR]] 
     28{{{#!th align=left 
     29Action 
     30}}} 
     31{{{#!td 
     32[tf.input:action -id=piform 'SIMPLIF-3 Remove key_bdy' 100] 
     33}}} 
     34|- 
     35{{{#!th align=left style='background:lightgrey' 
     36PI(S)  
     37}}} 
     38{{{#!td 
     39[tf.input:pi -id=piform 'Tomas Lovato' 100] 
     40}}} 
     41|- 
     42{{{#!th align=left 
     43{{{#!html 
     44<font style='background-color:#fcb; color:#500'>Ticket</font> 
     45}}} 
     46}}} 
     47{{{#!td style='background:lightgrey' 
     48#1729 
     49}}} 
     50|- 
     51{{{#!th align=left 
     52{{{#!html 
     53<font style='background-color:#fcb; color:#500'>Branch</font> 
     54}}} 
     55}}} 
     56{{{#!td style='background:lightgrey' 
     57[source:/branches/2016/​dev_r6522_SIMPLIF_3] 
     58}}} 
     59|- 
     60{{{#!th align=left style='background-color:lightblue' 
     61Previewer(s) 
     62}}} 
     63{{{#!td 
     64[tf.input:previewers -id=piform 'G. Madec' 100] 
     65}}} 
     66|- 
     67{{{#!th align=left style='background-color:lightgreen' 
     68Reviewer(s) 
     69}}} 
     70{{{#!td 
     71[tf.input:reviewers -id=piform 'G. Madec' 100] 
     72}}} 
     73 
     74'''__Description__''' 
     75 [tf.textarea:description -id=piform 'Remove the macro key_bdy activating the code for the open boundary treatment in favour of static code always present in compilation and activated only when bdy are required by the user configuration with ln_bdy.' 200 3] 
     76'''__Implementation__''' 
     77 [tf.textarea:implementation -id=piform 'The logical variable ln_bdy have to be inserted in the code and the related namelist and its usage have to replace lk_bdy. \n \n Move the content of bdy_par into bdy_oce and replace where needed the use associations of bdy_par with bdy_oce. \n \n  Remove the macro from code and configurations \n \n Changes to namelist_ref are indeed required, as well as in AMM12 that will be used for testing. \n' 200 10] 
     78'''__Reference manual and web pages updates__''' 
     79 [tf.textarea:manual -id=piform 'The manual should be updated to describe the activation of bdy from namelist.' 200 5] 
     80 
     81'''Updated on [tf.form_updated_on:] by [tf.form_updater:]''' 
     82}}} 
     83 
     84Once the PI has completed this section, he should send a mail to the previewer(s) asking them to preview the work within two weeks. 
     85 
     86== Preview == 
     87 
     88Since 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. 
     89 
     90{{{ 
     91#!TracForm 
     92#!subcontext preview_ 
     93#!submit_label 'Save Preview' 
     94|| Questions || Answer || Comment || 
     95|| 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] || 
     96|| 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] || 
     97|| 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] || 
     98|| 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] || 
     99|| ... ... ... || [tf.select:2.X -id=preform '' Yes No NR] || [tf.textarea:2.Xc -id=preform 'Add a comment?' 50 10] || 
     100 
     101'''Updated on [tf.form_updated_on:] by [tf.form_updater:]''' 
     102}}} 
     103 
     104Once all "YES" have been reached, the PI can start the development into his development branch. 
     105 
     106== Tests == 
     107 
     108Once the development is done, the PI should complete this section below and ask the reviewers to start their review in the lower section. 
     109 
     110{{{ 
     111#!TracForm 
     112#!subcontext tests 
     113#!submit_label 'Save Tests' 
     114|| Questions || Answer || Comment || 
     115|| 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] || 
     116|| 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] || 
     117|| 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] || 
     118|| 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] || 
     119|| 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] || 
     120|| 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] || 
     121|| 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] || 
     122|| 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] || 
     123|| 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] || 
     124|| 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] || 
     125|| ... ... ... || [tf.select:3.XX -id=piform '' Yes No NR] || [tf.textarea:3.XXc -id=piform 'Add a comment?' 50 10] || 
     126 
     127'''Updated on [tf.form_updated_on:] by [tf.form_updater:]''' 
     128}}} 
     129 
     130== Review == 
     131 
     132A successful review is needed to schedule the merge of this development into the future NEMO release during next Merge Party (usually in November). 
     133 
     134{{{ 
     135#!TracForm 
     136#!subcontext review 
     137#!submit_label 'Save Review' 
     138'''__Code changes and documentation__'''[[BR]] 
     139|| Question || Answer || Comment || 
     140|| 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] || 
     141|| 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] || 
     142|| 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] || 
     143|| 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] || 
     144|| 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] || 
     145|| 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] || 
     146|| 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] || 
     147|| 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] || 
     148|| ... ... ... || [tf.select:3.XX -id=revform '' Yes No NR] || [tf.textarea:3.XXc -id=revform 'Add a comment?' 50 10] || 
     149'''__Review Summary__'''[[BR]] 
     150Is the review fully successful?[tf.select:status -id=revform '' Yes No][[BR]] 
     151[tf.textarea:comment -id=revform 'If not, please indicate what is still missing.' 50 10] 
     152 
     153'''Updated on [tf.form_updated_on:] by [tf.form_updater:]''' 
     154}}} 
     155 
     156Once review is successful, the development must be scheduled for merge during next Merge Party Meeting.