3 | | ''A wiki page associated with a given action should be created in `wiki/${YEAR}WP/${WORKING_GROUP|INSTITUTE}-${ACTION_NUMBER}_${PIS}` using this template.Then, detail your action in the 'Summary' sub-page (ordinary wiki page).[[BR]]From that, the rest of the page has to be edited on-line inside the colored form fields and submit your modifications by clicking on the 'Submit ...' at the end of the section.'' |
| 3 | == Help == |
| 4 | |
| 5 | ''The development process of each action of the yearly workplan should be described only in one wiki page created in the tree of the corre`wiki/${YEAR}WP/${WORKING_GROUP|INSTITUTE}-${ACTION_NUMBER}_${PIS}` using this template.Then, detail your action in the 'Summary' sub-page (ordinary wiki page).[[BR]]From that, the rest of the page has to be edited on-line inside the colored form fields and submit your modifications by clicking on the 'Submit ...' at the end of the section.'' |
| 6 | '''There is absolutely no risk for all form content to make any modification in the wiki page as long as you edit out of `{{{TracForm ... }}}` processor'''. The data of a form field is stored in a different database from the wiki page, so you can delete a version or submit a new one without danger.[[BR]] |
| 7 | |
| 8 | '''For the Trac links to associated !ticket & development branch, it is mandatory to edit the page in `textarea` view'''. The `wysiwyg` view will alter the interpretation of the Trac processors `{{{#!th ... }}}` or `{{{#!td ... }}}` in the table.[[BR]] |
| 9 | ''To keep a preview, you can tick the box `edit side-by-side` at top right of the editing frame. It will part your screen with the editing view on the left and the preview on the right so you can control your changes. If you get by default the 'wysiwyg' view, this is due to your last editing work and can be changed in a simple manner.'' |
37 | | [tf.textarea:implementation -id=piform '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.' 200 20] |
38 | | === Reference manual updates === |
39 | | [tf.textarea:manual -id=piform 'Using part 1 and 2, define the summary of changes to be done in the NEMO reference manual (tex files).' 200 20] |
40 | | ==== ''Updated on [tf.form_updated_on:] by [tf.form_updater:]'' ==== |
| 45 | [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] |
| 46 | === Reference manual and web pages updates === |
| 47 | [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] |
| 48 | |
| 49 | '''''Updated on [tf.form_updated_on:] by [tf.form_updater:]''''' |
53 | | || Does the previewer agree with the proposed methodology? || [tf.select:2.1 -id=preform '' Yes No NR] || [tf.textarea:2.1 -id=preform 'Add a comment?' 50 10] || |
54 | | || 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.2 -id=preform 'Add a comment?' 50 10] || |
55 | | || 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.3 -id=preform 'Add a comment?' 50 10] || |
56 | | || 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.4 -id=preform 'Add a comment?' 50 10] || |
57 | | || ... ... ... || [tf.select:2.X -id=preform '' Yes No NR] || [tf.textarea:2.X -id=preform 'Add a comment?' 50 10] || |
58 | | ==== ''Updated on [tf.form_updated_on:] by [tf.form_updater:]'' ==== |
| 63 | || 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] || |
| 64 | || 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] || |
| 65 | || 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] || |
| 66 | || 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] || |
| 67 | || ... ... ... || [tf.select:2.X -id=preform '' Yes No NR] || [tf.textarea:2.Xc -id=preform 'Add a comment?' 50 10] || |
| 68 | |
| 69 | '''''Updated on [tf.form_updated_on:] by [tf.form_updater:]''''' |
70 | | || Can this change be shown to produce expected impact? (if option activated)? || [tf.select:3.1 -id=piform '' Yes No NR] || [tf.textarea:3.1 -id=piform 'Add a comment?' 50 10] || |
71 | | || 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.2 -id=piform 'Add a comment?' 50 10] || |
72 | | || 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.3 -id=piform 'Add a comment?' 50 10] || |
73 | | || 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.4 -id=piform 'Add a comment?' 50 10] || |
74 | | || 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.5 -id=piform 'Add a comment?' 50 10] || |
75 | | || If some differences appear, is reason for the change valid/understood? || [tf.select:3.6 -id=piform '' Yes No NR] || [tf.textarea:3.6 -id=piform 'Add a comment?' 50 10] || |
76 | | || 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.7 -id=piform 'Add a comment?' 50 10] || |
77 | | || Is this change expected to preserve all diagnostics? || [tf.select:3.8 -id=piform '' Yes No NR] || [tf.textarea:3.8 -id=piform 'Add a comment?' 50 10] || |
78 | | || If no, is reason for the change valid/understood? || [tf.select:3.9 -id=piform '' Yes No NR] || [tf.textarea:3.9 -id=piform 'Add a comment?' 50 10] || |
79 | | || Are there significant changes in run time/memory? || [tf.select:3.10 -id=piform '' Yes No NR] || [tf.textarea:3.10 -id=piform 'Add a comment?' 50 10] || |
80 | | || ... ... ... || [tf.select:3.XX -id=piform '' Yes No NR] || [tf.textarea:3.XX -id=piform 'Add a comment?' 50 10] || |
81 | | ==== ''Updated on [tf.form_updated_on:] by [tf.form_updater:]'' ==== |
| 83 | || 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] || |
| 84 | || 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] || |
| 85 | || 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] || |
| 86 | || 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] || |
| 87 | || 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] || |
| 88 | || 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] || |
| 89 | || 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] || |
| 90 | || 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] || |
| 91 | || 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] || |
| 92 | || 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] || |
| 93 | || ... ... ... || [tf.select:3.XX -id=piform '' Yes No NR] || [tf.textarea:3.XXc -id=piform 'Add a comment?' 50 10] || |
| 94 | |
| 95 | '''''Updated on [tf.form_updated_on:] by [tf.form_updater:]''''' |
92 | | || Is the proposed methodology now implemented? || [tf.select:3.11 -id=revform '' Yes No NR] || [tf.textarea:3.11 -id=revform 'Add a comment?' 50 10] || |
93 | | || 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.12 -id=revform 'Add a comment?' 50 10] || |
94 | | || 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.13 -id=revform 'Add a comment?' 50 10] || |
95 | | || Is the in-line documentation accurate and sufficient? || [tf.select:3.14 -id=revform '' Yes No NR] || [tf.textarea:3.14 -id=revform 'Add a comment?' 50 10] || |
96 | | || Do the code changes comply with NEMO coding standards? || [tf.select:3.15 -id=revform '' Yes No NR] || [tf.textarea:3.15 -id=revform 'Add a comment?' 50 10] || |
97 | | || 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.16 -id=revform 'Add a comment?' 50 10] || |
98 | | || 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.17 -id=revform 'Add a comment?' 50 10] || |
99 | | || 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.18 -id=revform 'Add a comment?' 50 10] || |
100 | | || ... ... ... || [tf.select:3.XXX -id=revform '' Yes No NR] || [tf.textarea:3.XXX -id=revform 'Add a comment?' 50 10] || |
101 | | === Review Summary === |
| 108 | || 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] || |
| 109 | || 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] || |
| 110 | || 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] || |
| 111 | || 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] || |
| 112 | || 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] || |
| 113 | || 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] || |
| 114 | || 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] || |
| 115 | || 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] || |
| 116 | || ... ... ... || [tf.select:3.XX -id=revform '' Yes No NR] || [tf.textarea:3.XXc -id=revform 'Add a comment?' 50 10] || |
| 117 | '''__Review Summary__'''[[BR]] |