Opened 5 years ago
Last modified 3 years ago
#2189 assigned Task
PUB-05_SI3_documentation
| Reported by: | vancop | Owned by: | vancop |
|---|---|---|---|
| Priority: | high | Milestone: | Unscheduled |
| Component: | SI3 | Version: | trunk |
| Severity: | minor | Keywords: | |
| Cc: |
Description (last modified by vancop)
SI3 documentation must be continued and reviewed
Summary
| Action | ${ACTION_NAME} Subject |
|---|---|
| PI(S) | M. Vancoppenolle |
| 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
Write and revise documentation.
Description
Progress should be made on the documentation. There are a few missing chapters left, and progress should be done.
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 (0)
(No commits)
Change History (8)
comment:1 Changed 5 years ago by nemo
- Priority changed from low to high
comment:2 Changed 5 years ago by vancop
- Description modified (diff)
comment:3 Changed 5 years ago by nemo
- Owner set to vancop
- Status changed from new to assigned
- Summary changed from SI3-08_SI3_documentation to PUBS-05_SI3_documentation
comment:4 Changed 5 years ago by vancop
comment:5 Changed 5 years ago by vancop
- wp_comment set to This task will be ongoing over the duration of IS-ENES3, until 2022. It must be spread among the sea ice working group members during our next meeting in 2020.
comment:6 Changed 4 years ago by vancop
- Milestone changed from 2019 WP to 2020 WP
comment:7 Changed 4 years ago by vancop
- Summary changed from PUBS-05_SI3_documentation to PUB-05_SI3_documentation
comment:8 Changed 3 years ago by nemo
- Milestone changed from 2020 WP to Unscheduled
The documentation of SI3 will be written collectively in the framework of IS-ENES3.
Writing and reviewing will be organised by the SIWG at its next meeting.