#2205 closed Task (fixed)
Update BDY documentation
Reported by: | mathiot | Owned by: | mathiot |
---|---|---|---|
Priority: | low | Milestone: | 2018 release-4.0 |
Component: | doc | Version: | trunk |
Severity: | minor | Keywords: | BDY v4.0 |
Cc: |
Description
Summary
Update the BDY documentation:
- namelist variable name in the text not up-to-date
- some namelist parameter are not described
- Example given in the text do not match the sample namelist
- Orlanski scheme not described
Action | ${ACTION_NAME} Subject |
---|---|
PI(S) | Principal investigator(s) |
Digest | Brief description with motivations and main tasks |
Dependencies | |
Branch | NEMO/branches/$YEAR/dev_r{REV}_{ACTION_NAME} |
Previewer(s) | |
Reviewer(s) | |
Wiki | wiki:${YEAR}WP/... |
Abstract
This section should be completed before starting to develop the code, in order to find agreement with the previewer(s) on the method beforehand.
Description
Describe the goal of development, and the methodology.
Add reference documents or publications if relevant.
Implementation
Describe flow chart of the changes in the code.
List the .F90 files and modules to be changed.
Detailed list of new variables (including namelists) to be defined, give for each the chosen name (following coding rules) and definition.
Reference manual and web pages updates
Using part 1 and 2, define the summary of changes to be done in reference manuals (tex files), guide (rst files) and in the content of web pages.
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.
Commit History (1)
Changeset | Author | Time | ChangeLog |
---|---|---|---|
10530 | mathiot | 2019-01-16T12:18:17+01:00 | update BDY doc with contribution from Enda, Dave and James. fix ticket #2205 |
Change History (3)
comment:1 Changed 5 years ago by mathiot
comment:2 Changed 5 years ago by mathiot
- Resolution set to fixed
- Status changed from new to closed
comment:3 Changed 20 months ago by nemo
- Keywords v4.0 added; removed
In 10530: