Changes between Initial Version and Version 1 of 2016WP/HPC-1_SilviaMocavero

Timestamp:

2016-03-25T17:00:58+01:00 (8 years ago)

Author:

mocavero

Comment:

--

2016WP/HPC-1_SilviaMocavero

@@ +1 @@
+= Form page for development work =
+
+A wiki page associated with a give action should be created in `wiki/${YEAR}WP/${WORKING_GROUP|INSTITUTE}-${ACTION_NUMBER}_${PI}` using this template.[[BR]]From that, you can customize it while editing within the !TracForm container `{{{#!TracForm ... }}}`. If necessary, you can copy the entire form (add a number `_[0-9]` to wiki page name) or the respective area in order to match the number of the (P)Reviewer(s). The best solution is not to extend significantly the length of the page.
+
+This is the color code for the fulfilment of this form:
+
+{{{#!comment
+Be careful switching between 'textarea' & 'wysiwyg' view with the following table
+}}}
+
+{{{#!td style='background:lightgrey'
+PI(S)
+}}}
+{{{#!td style='background:lightblue'
+Previewer(s)
+}}}
+{{{#!td style='background:lightgreen'
+Reviewer(s)
+}}}
+
+----
+
+[[PageOutline(2)]]
+
+The 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]]
+
+== Abstract ==
+
+This section should be completed before starting to develop the code, in order to find agreement on the method beforehand.
+
+{{{
+#!TracForm
+#!subcontext abstract
+#!submit_label 'Submit Abstract'
+#!keep_history yes
+'''__Details__'''[[BR]]
+{{{#!th align=left
+Action
+}}}
+{{{#!td
+[tf.input:action -id=piform '${WORKING_GROUP|INSTITUTE}-${ACTION_NUMBER} $Title' 100]
+}}}
+|-
+{{{#!th align=left style='background:lightgrey'
+PI(S) 
+}}}
+{{{#!td
+[tf.input:pi -id=piform 'Names' 100]
+}}}
+|-
+{{{#!th align=left
+{{{#!html
+<font style='background-color:#fcb; color:#500'>Ticket</font>
+}}}
+}}}
+{{{#!td style='background:lightgrey'
+#XXXX
+}}}
+|-
+{{{#!th align=left
+{{{#!html
+<font style='background-color:#fcb; color:#500'>Branch</font>
+}}}
+}}}
+{{{#!td style='background:lightgrey'
+[source:/branches/$YEAR/dev_r${FORK_REVISION}_${WORKING_GROUP|INSTITUTE}${ACTION_NUMBER}_${PURPOSE}]
+}}}
+|-
+{{{#!th align=left style='background-color:lightblue'
+Previewer(s)
+}}}
+{{{#!td
+[tf.input:previewers -id=piform 'Names' 100]
+}}}
+|-
+{{{#!th align=left style='background-color:lightgreen'
+Reviewer(s)
+}}}
+{{{#!td
+[tf.input:reviewers -id=piform 'Names' 100]
+}}}
+[[span(To enabling the !ticket and the source links related to your action, edit the form like a ordinary wiki page to hardcode them inside the table, style=background-color:#fcb;color:#500)]]
+
+'''__Description__'''
+ [tf.textarea:description -id=piform 'Describe the goal of development, and the methodology.\n\nAdd reference documents or publications if relevant.' 200 20]
+'''__Implementation__'''
+ [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]
+'''__Reference manual updates__'''
+ [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]
+
+'''Updated on [tf.form_updated_on:] by [tf.form_updater:]'''
+}}}
+
+Once the PI has completed this section, he should send a mail to the previewer(s) asking them to preview the work within two weeks.
+
+== Preview ==
+
+Since 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.
+
+{{{
+#!TracForm
+#!subcontext preview_
+#!submit_label 'Submit Preview'
+|| Questions || Answer || Comment ||
+|| 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] ||
+|| 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] ||
+|| 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] ||
+|| 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] ||
+|| ... ... ... || [tf.select:2.X -id=preform '' Yes No NR] || [tf.textarea:2.Xc -id=preform 'Add a comment?' 50 10] ||
+
+'''Updated on [tf.form_updated_on:] by [tf.form_updater:]'''
+}}}
+
+Once all "YES" have been reached, the PI can start the development into his development branch.
+
+== Tests ==
+
+Once the development is done, the PI should complete this section below and ask the reviewers to start their review in the lower section.
+
+{{{
+#!TracForm
+#!subcontext tests
+#!submit_label 'Submit Tests'
+|| Questions || Answer || Comment ||
+|| 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] ||
+|| 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] ||
+|| 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] ||
+|| 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] ||
+|| 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] ||
+|| 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] ||
+|| 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] ||
+|| 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] ||
+|| 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] ||
+|| 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] ||
+|| ... ... ... || [tf.select:3.XX -id=piform '' Yes No NR] || [tf.textarea:3.XXc -id=piform 'Add a comment?' 50 10] ||
+
+'''Updated on [tf.form_updated_on:] by [tf.form_updater:]'''
+}}}
+
+== Review ==
+
+A successful review is needed to schedule the merge of this development into the future NEMO release during next Merge Party (usually in November).
+
+{{{
+#!TracForm
+#!subcontext review
+#!submit_label 'Submit Review'
+'''__Code changes and documentation__'''[[BR]]
+|| Question || Answer || Comment ||
+|| 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] ||
+|| 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] ||
+|| 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] ||
+|| 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] ||
+|| 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] ||
+|| 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] ||
+|| 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] ||
+|| 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] ||
+|| ... ... ... || [tf.select:3.XX -id=revform '' Yes No NR] || [tf.textarea:3.XXc -id=revform 'Add a comment?' 50 10] ||
+'''__Review Summary__'''[[BR]]
+Is the review fully successful?[tf.select:status -id=revform '' Yes No][[BR]]
+[tf.textarea:comment -id=revform 'If not, please indicate what is still missing.' 50 10]
+
+'''Updated on [tf.form_updated_on:] by [tf.form_updater:]'''
+}}}
+
+Once review is successful, the development must be scheduled for merge during next Merge Party Meeting.