[[PageOutline(2)]]

= Form page for development work =
|| '''Abstract''' || ''`#!TracForm #!subcontext abstract on [tf.form_updated_on:abstract] by [tf.form_updater:abstract]`'' ||
|| '''Preview''' || ''`#!TracForm #!subcontext preview on [tf.form_updated_on:preview] by [tf.form_updater:preview]`'' ||
|| '''Review''' || ''`#!TracForm #!subcontext review on [tf.form_updated_on:review] by [tf.form_updater:review]`'' ||

----
== Abstract ==
{{{
#!TracForm
#!subcontext abstract
#!submit_label 'Submit Abstract'
|| Action || ''[tf.input:action 'Number & name' 150]'' ||
|| PI(S) || ''[tf.input:pi 'Names' 100]'' ||
|| Linked !ticket || ''[tf.input:ticket # 10]'' ||
|| Previewer(s) || ''[tf.input:previewers 'Names' 100]'' ||
|| Reviewer(s) || ''[tf.input:reviewers 'Names' 100]'' ||
'''This section should be completed before starting to develop the code, in order to find agreement on the method and the implementation beforehand.'''

=== Part 1: Description ===
[tf.textarea:description 'Describe the goal of development, and the methodology.\n\nAdd reference documents or publications if relevant.' 200 20]

=== Part 2: Implementation ===
[tf.textarea:implementation '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 description' 200 20]

=== Part 3: Reference manual updates ===
[tf.textarea:manual 'Using part 1 and 2, define the summary of changes to be done in the NEMO reference manual (tex files)' 200 20]
}}}
'''END of PI's section: 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 '' Yes No NR] || [tf.textarea:2.1 'Write here' 50 10] ||
|| ''Does the previewer agree with the proposed flowchart and list of routines to be changed?'' || [tf.select:2.2 '' Yes No NR] || [tf.textarea:2.2 'Write here' 50 10] ||
|| ''Does the previewer agree with the proposed new list of variables, including agreement with coding rules?'' || [tf.select:2.3 '' Yes No NR] || [tf.textarea:2.3 'Write here' 50 10] ||
|| ''Does the previewer agree with the proposed summary of updates in reference manual?'' || [tf.select:2.4 '' Yes No NR] || [tf.textarea:2.4 'Write here' 50 10] ||
|| ''... ... ...'' || [tf.select:2.X '' Yes No NR] || [tf.textarea:2.X 'Write here' 50 10] ||
}}}
[[BR]]'''Once all "YES" have been reached, the PI can start the development into his development branch.'''

----
== Review ==
Once the development is done, the PI should complete the tests section below and ask the reviewers to start their 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'
=== Tests ===
|| Questions || Answer || Comment ||
|| Can this change be shown to produce expected impact? (if option activated)? || [tf.select:3.1 '' Yes No NR] || [tf.textarea:3.1 'Write here' 50 10] ||
|| Can this change be shown to have a null impact? (if option not activated) || [tf.select:3.2 '' Yes No NR] || [tf.textarea:3.2 'Write here' 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 '' Yes No NR] || [tf.textarea:3.3 'Write here' 50 10] ||
|| Detailed results of SETTE tests (restartability and reproducibility for each of the reference configuration) || [tf.select:3.4 '' Yes No NR] || [tf.textarea:3.4 'Write here' 50 10] ||
|| Results of the required bit comparability tests been run: Are there no differences when activating the development? || [tf.select:3.5 '' Yes No NR] || [tf.textarea:3.5 'Write here' 50 10] ||
|| If some differences appear, is reason for the change valid/understood? || [tf.select:3.6 '' Yes No NR] || [tf.textarea:3.6 'Write here' 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 '' Yes No NR] || [tf.textarea:3.7 'Write here' 50 10] ||
|| Is this change expected to preserve all diagnostics? || [tf.select:3.8 '' Yes No NR] || [tf.textarea:3.8 'Write here' 50 10] ||
|| If no, is reason for the change valid/understood? || [tf.select:3.9 '' Yes No NR] || [tf.textarea:3.9 'Write here' 50 10] ||
|| Are there significant changes in run time/memory? || [tf.select:3.10 '' Yes No NR] || [tf.textarea:3.10 'Write here' 50 10] ||
|| ... ... ... || [tf.select:3.XX '' Yes No NR] || [tf.textarea:3.XX 'Write here' 50 10] ||
=== Code changes and documentation ===
|| Question || Answer || Comment ||
|| Is the proposed methodology now implemented? || [tf.select:3.11 '' Yes No NR] || [tf.textarea:3.11 'Write here' 50 10] ||
|| Are the code changes in agreement with the flowchart defined at Preview step? || [tf.select:3.12 '' Yes No NR] || [tf.textarea:3.12 'Write here' 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 '' Yes No NR] || [tf.textarea:3.13 'Write here' 50 10] ||
|| Is the in-line documentation accurate and sufficient? || [tf.select:3.14 '' Yes No NR] || [tf.textarea:3.14 'Write here' 50 10] ||
|| Do the code changes comply with NEMO coding standards? || [tf.select:3.15 '' Yes No NR] || [tf.textarea:3.15 'Write here' 50 10] ||
|| Is the !ticket of development documented with sufficient details for others to understand the impact of the change? || [tf.select:3.16 '' Yes No NR] || [tf.textarea:3.16 'Write here' 50 10] ||
|| Are the reference manual tex files now updated following the proposed summary in preview section? || [tf.select:3.17 '' Yes No NR] || [tf.textarea:3.17 'Write here' 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 '' Yes No NR] || [tf.textarea:3.18 'Write here' 50 10] ||
|| ... ... ... || [tf.select:3.XXX '' Yes No NR] || [tf.textarea:3.XXX 'Write here' 50 10] ||
=== Review Summary ===
'''Is the review fully successful?'''[tf.select:status '' Yes No][[BR]]
[tf.textarea:status 'If not, please indicate what is still missing.' 50 10]
}}}
Once review is successful, the development must be scheduled for merge during next Merge Party Meeting.