Last edition: 04/21/20 14:09:52 by smueller

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.

  1. Summary
  2. Preview
  3. Tests
  4. Review


Action DATAINT-02_smueller_IOM_revision
PI S. Müller
Digest Revision of IOM
Dependencies If any
Branch source:/NEMO/branches/{YEAR}/dev_r{REV}_{ACTION_NAME}
Previewers S. Masson, M. Andrejczuk
Reviewers S. Masson, M. Andrejczuk
Ticket #2427


Source-code file netCDF-Fortran API call IOIPSL API call XIOS API call key_iomput dependency IOM call
source:/NEMO/trunk/src/ABL/sbcabl.F90 no no no YES YES
source:/NEMO/trunk/src/OCE/C1D/step_c1d.F90 no no YES YES YES
source:/NEMO/trunk/src/OCE/DIA/diadetide.F90 no no no YES YES
source:/NEMO/trunk/src/OCE/DIA/diamlr.F90 no no YES YES YES
source:/NEMO/trunk/src/OCE/DIA/dianam.F90 no YES no no no
source:/NEMO/trunk/src/OCE/DIA/diawri.F90 no YES no YES YES
source:/NEMO/trunk/src/OCE/DOM/daymod.F90 no YES no no YES
source:/NEMO/trunk/src/OCE/DOM/domain.F90 no YES no YES YES
source:/NEMO/trunk/src/OCE/FLO/flowri.F90 no YES no YES YES
source:/NEMO/trunk/src/OCE/ICB/icbrst.F90 YES no no no YES
source:/NEMO/trunk/src/OCE/ICB/icbtrj.F90 YES YES no no no
source:/NEMO/trunk/src/OCE/IOM/iom.F90 no YES YES YES YES
source:/NEMO/trunk/src/OCE/IOM/iom_nf90.F90 YES no no no YES
source:/NEMO/trunk/src/OCE/IOM/restart.F90 no no YES YES YES
source:/NEMO/trunk/src/OCE/LBC/mppini.F90 no YES no no YES
source:/NEMO/trunk/src/OCE/nemogcm.F90 no no YES YES YES
source:/NEMO/trunk/src/OCE/OBS/obs_fbm.F90 YES no no no no
source:/NEMO/trunk/src/OCE/OBS/obs_grid.F90 YES no no no no
source:/NEMO/trunk/src/OCE/OBS/obs_readmdt.F90 YES no no no YES
source:/NEMO/trunk/src/OCE/OBS/obs_read_prof.F90 YES no no no no
source:/NEMO/trunk/src/OCE/OBS/obs_read_surf.F90 YES no no no no
source:/NEMO/trunk/src/OCE/OBS/obs_sstbias.F90 YES no no no YES
source:/NEMO/trunk/src/OCE/OBS/obs_utils.F90 YES no no no no
source:/NEMO/trunk/src/OCE/step.F90 no no no YES YES
source:/NEMO/trunk/src/OCE/stpctl.F90 YES no no no no
source:/NEMO/trunk/src/OCE/step_oce.F90 no no no YES no
source:/NEMO/trunk/src/OCE/TRD/trd_oce.F90 no no no YES no
source:/NEMO/trunk/src/OCE/TRD/trdmxl.F90 no YES no no no
source:/NEMO/trunk/src/OFF/nemogcm.F90 no no YES YES YES
source:/NEMO/trunk/src/SAO/nemogcm.F90 no no YES YES YES
source:/NEMO/trunk/src/SAO/obs_fbm.F90 YES no no no no
source:/NEMO/trunk/src/SAO/sao_read.F90 YES no no no no
source:/NEMO/trunk/src/SAS/diawri.F90 no YES no YES YES
source:/NEMO/trunk/src/SAS/nemogcm.F90 no no YES YES YES
source:/NEMO/trunk/src/SAS/step.F90 no no no YES YES
source:/NEMO/trunk/src/SAS/stpctl.F90 YES no no no no
source:/NEMO/trunk/src/TOP/AGE/trcwri_age.F90 no no no YES YES
source:/NEMO/trunk/src/TOP/C14/trcwri_c14.F90 no no no YES YES
source:/NEMO/trunk/src/TOP/CFC/trcwri_cfc.F90 no no no YES YES
source:/NEMO/trunk/src/TOP/MY_TRC/trcwri_my_trc.F90 no no no YES YES
source:/NEMO/trunk/src/TOP/PISCES/trcwri_pisces.F90 no no no YES YES
source:/NEMO/trunk/src/TOP/trcwri.F90 no no no YES YES
source:/NEMO/trunk/src/TOP/TRP/trdmxl_trc.F90 no YES no no no
source:/NEMO/trunk/src/TOP/TRP/trdtrc_oce.F90 no YES no no no
source:/NEMO/trunk/tests/CANAL/MY_SRC/diawri.F90 no YES no YES YES
source:/NEMO/trunk/tests/CANAL/MY_SRC/stpctl.F90 YES no no no no
source:/NEMO/trunk/tests/STATION_ASF/MY_SRC/diawri.F90 no YES no YES YES
source:/NEMO/trunk/tests/STATION_ASF/MY_SRC/nemogcm.F90 no no YES YES YES
source:/NEMO/trunk/tests/STATION_ASF/MY_SRC/step_c1d.F90 no no YES YES YES
source:/NEMO/trunk/tests/STATION_ASF/MY_SRC/stpctl.F90 YES no no no no
other source-code files of source:/NEMO/trunk no no no no YES or no


Describe flow chart of the changes in the code.
List the Fortran modules and subroutines to be created/edited/deleted.
Detailed list of new variables to be defined (including namelists),
give for each the chosen name and description wrt coding rules.

Documentation updates

Using previous parts, define the main changes to be done in the NEMO literature (manuals, guide, web pages, …).


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 the request to the previewer(s).
Then an iterative process should take place between PI and previewer(s) in order to find a consensus

Possible bottlenecks:

  • the methodology
  • the flowchart and list of routines to be changed
  • the new list of variables wrt coding rules
  • the summary of updates in literature

Once an agreement has been reached, preview is ended and the PI can start the development into his branch.


Once the development is done, the PI should complete the tests section below and after ask the reviewers to start their review.

This part should contain the detailed results of SETTE tests (restartability and reproducibility for each of the reference configuration) and detailed results of restartability and reproducibility when the option is activated on specified configurations used for this test

Regular checks:

  • Can this change be shown to produce expected impact (option activated)?
  • Can this change be shown to have a null impact (option not activated)?
  • Results of the required bit comparability tests been run: are there no differences when activating the development?
  • If some differences appear, is reason for the change valid/understood?
  • If some differences appear, is the impact as expected on model configurations?
  • Is this change expected to preserve all diagnostics?
  • If no, is reason for the change valid/understood?
  • Are there significant changes in run time/memory?


A successful review is needed to schedule the merge of this development into the future NEMO release during next Merge Party (usually in November).


  • Is the proposed methodology now implemented?
  • Are the code changes in agreement with the flowchart defined at preview step?
  • Are the code changes in agreement with list of routines and variables as proposed at preview step?
    If, not, are the discrepancies acceptable?
  • Is the in-line documentation accurate and sufficient?
  • Do the code changes comply with NEMO coding standards?
  • Is the development documented with sufficient details for others to understand the impact of the change?
  • Is the project literature (manual, guide, web, …) now updated or completed following the proposed summary in preview section?


Is the review fully successful? If not, please indicate what is still missing

Once review is successful, the development must be scheduled for merge during next Merge Party Meeting.

Last modified 18 months ago Last modified on 2020-04-21T14:09:52+02:00