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.
ticket/1605/Review (diff) – NEMO

Changes between Version 1 and Version 2 of ticket/1605/Review


Ignore:
Timestamp:
2015-10-07T12:14:47+02:00 (9 years ago)
Author:
pabouttier
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • ticket/1605/Review

    v1 v2  
    44 
    55== For completion by the Sci/Tech/Code reviewer == 
    6 '''Reviewer:''' [ Enter your name here ] 
     6'''Reviewer:''' Pierre-Antoine Bouttier 
    77 
    88=== Ticket Details, Documentation and Code changes === 
    9 ||Do you understand the area of code being altered and the reasoning why it is being altered?||YES/NO|| 
    10 ||Do the proposed code changes correspond with the stated reason for the change?||YES/NO|| 
    11 ||Is the in-line documentation accurate and sufficient?||YES/NO|| 
    12 ||Do the code changes comply with NEMO coding standards?||YES/NO|| 
    13 ||Is the Ticket documented with sufficient detail for others to understand the impact of the change?||YES/NO|| 
    14 ||Does any corresponding external documentation require updating?||YES/NO|| 
    15 ||If yes, which docs and have the updates been drafted?||YES/NO|| 
    16 ||Are namelist changes required for this change?||YES/NO|| 
    17 ||If yes, have they been done?||YES/NO|| 
    18 ||Has a completed Ticket Summary template been appended to the ticket to aid code reviews||YES/NO|| 
    19 ||Does this summary correspond with your understanding of the full ticket?||YES/NO|| 
     9|| Do you understand the area of code being altered and the reasoning why it is being altered? || YES || 
     10|| Do the proposed code changes correspond with the stated reason for the change? || YES || 
     11|| Is the in-line documentation accurate and sufficient? || YES || 
     12|| Do the code changes comply with NEMO coding standards? || Partially, due to the storng.F90 file (see https://forge.ipsl.jussieu.fr/nemo/ticket/1605 ) || 
     13|| Is the Ticket documented with sufficient detail for others to understand the impact of the change? || YES, || 
     14|| Does any corresponding external documentation require updating? || YES || 
     15|| If yes, which docs and have the updates been drafted? || A chapter in the NEMO book is missing about that module. || 
     16|| Are namelist changes required for this change? || YES || 
     17|| If yes, have they been done? || YES (yes, in the CONFIG/SHARED/namelist_ref file) || 
     18|| Has a completed Ticket Summary template been appended to the ticket to aid code reviews || NO (see https://forge.ipsl.jussieu.fr/nemo/ticket/1605 ) || 
     19|| Does this summary correspond with your understanding of the full ticket? || NA || 
    2020 
    2121Ticket, Documentation and Code comments 
    2222 
    23 Add specific Ticket, Documentation and code comments here 
     23The main point here is that the documentation in the NEMO book is missing. 
    2424 
    2525=== Testing === 
    26 ||Has the NVTK and other jobs been tested with this change?||YES/NO|| 
    27 ||Have the required bit comparability tests been run?||YES/NO|| 
    28 ||Can this change be shown to have a null impact? (if option not selected)||YES/NO|| 
    29 ||If no, is reason for the change valid/understood?||YES/NO/NA|| 
    30 ||If no, ensure that the ticket details the impact this change will have on model configurations .||YES/NO/NA|| 
    31 ||Is this change expected to preserve all diagnostics?||YES/NO|| 
    32 ||If no, is reason for the change valid/understood?||YES/NO/NA|| 
    33 ||Are there significant changes in run time/memory?||YES/NO|| 
     26|| Has the NVTK and other jobs been tested with this change? || YES || 
     27|| Have the required bit comparability tests been run? || YES || 
     28|| Can this change be shown to have a null impact? (if option not selected) || YES || 
     29|| If no, is reason for the change valid/understood? || NA || 
     30|| If no, ensure that the ticket details the impact this change will have on model configurations . || NA || 
     31|| Is this change expected to preserve all diagnostics? || YES (if option not selected) || 
     32|| If no, is reason for the change valid/understood? || NA || 
     33|| Are there significant changes in run time/memory? || NO (if option not selected) || 
    3434 
    3535Testing Comments 
    3636 
    37 Add specific testing comments here 
    38  
    39 Add specific testing comments here 
     37SETTE tests are all OK when option is disabled. Scientific tests have not been done with this module enabled. 
    4038 
    4139=== Code Review === 
    42 ||Do the code changes comply with NEMO coding standards?||YES/NO|| 
    43 ||Are code changes consistent with the design of NEMO?||YES/NO|| 
    44 ||Is the code free of unwanted TABs?||YES/NO|| 
    45 ||Has the code been wholly (100%) produced by NEMO developers working on NEMO?||YES/NO|| 
    46 ||If no, ensure collaboration agreement has been added to the ticket keywords|||| 
     40|| Do the code changes comply with NEMO coding standards? || Partially (as previously said) || 
     41|| Are code changes consistent with the design of NEMO? || YES || 
     42|| Is the code free of unwanted TABs? || YES || 
     43|| Has the code been wholly (100%) produced by NEMO developers working on NEMO? || YES || 
     44|| If no, ensure collaboration agreement has been added to the ticket keywords || 
    4745 
    48 Add specific code comments or suggested alterations here. 
     46Allocation of arrays in the module are not checked during the initialisation phase. This have to be fixed. 
     47 
     48Another remark is more about  the software architecture. It seems to be more meaningful to extract STO/ directory from OPA_SRC directory. Indeed, the module is not directly related to the NEMO dynamic core and it is generic enough to be applied to other NEMO components (e.g. LIM2, PISCES) 
    4949 
    5050=== Review Summary === 
    51 Add summary here 
     51Currently, the stochastic parametrization of EOS is implemented. It does not introduce regressive behaviors of the code.  
     52 
     53However, an external documentation is still missing. Also, Scientific tests have not been done.  
     54 
     55Concerning the code itself, arrays allocation have to be checked. The STO directory could be extracted from OPA_SRC. 
    5256 
    5357=== Approval for the trunk ===