source: NEMO/trunk/doc/latex/SI3/subfiles/todolist.tex @ 11015

Last change on this file since 11015 was 11015, checked in by nicolasmartin, 18 months ago

Modification of the content to be in line with the NEMO manual
SI3 manual can now be build like the NEMO manual with ./manual_build.sh SI3

  • Mimick the directory organisation with main and subfiles folders.
  • Regarding the particular case of namelists
    • Remove the duplicates already contained in the global namelists folder at 1st level of ./doc
    • Keep the namelists sub-folder only for namdyn_adv & namsbc which already exist in ocean namelists
  • Rewriting of SI3_manual.tex with NEMO_manual.tex as template to easily highlight differences
  • Updating of several paths for figures/namelists inclusion or LaTeX files referencing
  • LaTeX source:
    • Replacement of \forfile command for namelists with pre-configured \nlst alias
    • " "" \bm with \mathbf (save installation of an extra package)
File size: 1.8 KB
Line 
1\documentclass[../main/SI3_manual]{subfiles}
2
3\begin{document}
4
5% ================================================================
6% Dummy Chapter - To do list
7% ================================================================
8
9\chapter*{To-do-list for documentation}
10\label{chap:TDL}
11
12\begin{itemize}
13
14\item \textcolor{gray}{Documentation infrastructure ready by Jul 19, 2018.}
15
16\item \textcolor{gray}{Abstract: v1 written.}
17
18\item \textcolor{gray}{Disclaimer: v1 written.}
19
20\item Introduction: list of chapters and change between realeases to be written (1h)
21
22\item \textcolor{gray}{1. Model basics: v1 written.}
23
24\item \textcolor{gray}{Add namelist infrastructure as in NEMO doc (done)}
25
26\item \textcolor{gray}{2. Time, space and thickness space domain}
27
28\item 3. Ice dynamics: to be written (Clem \& Martin, 3h)
29
30\item 4. Ice transport: UM5 description to be written (Clem, 3h)
31
32\item 5. Ridging and rafting: V1 from previous doc. Should be refreshed. A bit too long. All namelist parameters are not explained (namdyn\_rdgrft).
33
34\item \textcolor{gray}{6. Radiative transfer: Full rewriting required (Martin \& Clem, 3-6h). Available elements from previous documentation, but mostly obsolete.}
35
36\item 7. Thermodynamics: Lots of rewriting required. Available elements from previous documentation, but mostly obsolete (Martin, 6h)
37
38\item 8. Interfaces: Full writing required
39
40\item 9. Output and diagnostics: Full writing required
41
42\item 10. Single category (Martin, 3h). Full writing required.
43
44\item 11. BDY-AGRIF (Clem, 3h). Full writing required.
45
46\item 12. Miscellaneous. Full writing required.
47
48\item Melt ponds are not currently considered in the plan.
49
50\item Make sure all namelist parameters are properly described.
51
52\item Peer-review by SIWG members.
53
54\end{itemize}
55
56\end{document}
Note: See TracBrowser for help on using the repository browser.