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.
Changeset 11015 for NEMO/trunk/doc/latex/SI3/main/SI3_manual.tex – NEMO

Ignore:
Timestamp:
2019-05-20T20:57:09+02:00 (5 years ago)
Author:
nicolasmartin
Message:

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)
Location:
NEMO/trunk/doc/latex/SI3/main
Files:
1 edited
1 moved

Legend:

Unmodified
Added
Removed

  • NEMO/trunk/doc/latex/SI3/main/SI3_manual.tex

    r9995 r11015  
    11%% ============================================================================== 
    2 %% NEMO_book.tex: build the NEMO Reference Manual 
     2%% SI3 Reference Manual 
    33%% ============================================================================== 
    4  
    5  
    6 %% Run ../build_NEMO_manual.sh to generate the PDF version (with pdflatex) 
    7  
    8 %% Document layout 
    9 %% ============================================================================== 
    10  
    11 \documentclass[a4paper, 11pt]{book} 
    124 
    135 
    … …  
    157%% ============================================================================== 
    168 
    17 \usepackage{../../tex_main/NEMO_manual} 
    18 \usepackage{../../tex_sub/NEMO_minted} 
     9%% Document layout 
     10\documentclass{book} 
    1911 
    20 \usepackage{bm} 
     12%% Custom style (.sty) 
     13\usepackage{../../NEMO/main/NEMO_manual} 
     14 
     15%% Include references and index for single subfile compilation 
     16\newcommand{\biblio}{\bibliography{../main/SI3_manual}} 
     17\newcommand{\pindex}{\printindex} 
    2118 
    2219\makeindex 
    2320 
     21%% End of common preamble between main and sub-files 
     22\begin{document} 
    2423 
    25 %%  
    26 %% ============================================================================== 
    27  
    28 \begin{document} 
     24%% Override custom cmds for full manual compilation 
     25\renewcommand{\biblio}{} 
     26\renewcommand{\pindex}{} 
    2927 
    3028 
    … …  
    3230%% ============================================================================== 
    3331 
     32\graphicspath{{../../figures/logos/}} 
     33 
    3434%% Frontpage 
     35\title{ 
     36  \includegraphics[height=0.05\textheight]{CMCC}\hfill 
     37  \includegraphics[height=0.05\textheight]{CNRS}\hfill 
     38  \includegraphics[height=0.05\textheight]{MOI} \hfill 
     39  \includegraphics[height=0.05\textheight]{UKMO}\hfill 
     40  \includegraphics[height=0.05\textheight]{NERC}       \\ 
     41  {\Huge SI$^3$ \\} 
     42  {\Large Sea Ice modelling Integrated Initiative -- The NEMO Sea Ice engine}\\  
     43  {\small \textcolor{red}{First draft documentation. Needs completion and rewriting}.} 
     44} 
     45\author{The NEMO Sea Ice Working Group 
     46%  \thanks{ 
     47% 
     48%  }                                                        \\ 
     49%                                                           \\ 
     50  \textit{Issue 27, Notes du P\^{o}le de mod\'{e}lisation} \\ 
     51  \textit{Institut Pierre-Simon Laplace (IPSL)}            \\ 
     52  \textit{ISSN 1288-1619} 
     53} 
     54\date{\today} 
    3555 
    36 \title{ 
    37 \vspace{1.5cm} 
    38 \rule{400pt}{1.5pt} \\ 
    39 \vspace{0.45cm} 
    40  {\Huge SI$^3$ \\} 
    41  {\Large -- Sea Ice modelling Integrated Initiative --}\\ 
    42  {\Large The NEMO Sea Ice engine}\\  
    43 \date{\today} 
    44 \author{The NEMO Sea Ice Working Group \\ 
    45 \\ 
    46 \small \textit{Note du P\^ole de mod\'elisation de l'Institut Pierre-Simon Laplace No 31} \\ 
    47 \small \textcolor{red}{First draft documentation. Needs completion and rewriting}. \\ 
    48 \\ 
    49 ISSN No 1288-1619\\ 
    50 } 
    51 \rule{400pt}{1.5pt} 
    52 } 
    53  
    54 \maketitle                 % generate the title 
    55  
     56\maketitle 
    5657\frontmatter 
    5758 
     59 
    5860%% ToC i.e. Table of Contents 
    59  
    6061\dominitoc 
    6162\tableofcontents 
    … …  
    6768\mainmatter 
    6869 
    69 \subfile{../tex_sub/todolist} 
     70\graphicspath{{../../figures/SI3/}} 
     71 
     72\subfile{../subfiles/todolist} 
    7073 
    7174%% Abstract - Foreword 
    7275 
    73 \subfile{../tex_sub/abstract_foreword} 
     76\subfile{../subfiles/abstract_foreword} 
    7477 
    7578% Introduction 
    7679 
    77 \subfile{../tex_sub/introduction} 
     80\subfile{../subfiles/introduction} 
    7881 
    7982% Chapters 
    8083 
    81 \subfile{../tex_sub/chap_model_basics} 
     84\subfile{../subfiles/chap_model_basics} 
    8285 
    83 \subfile{../tex_sub/chap_domain} 
     86\subfile{../subfiles/chap_domain} 
    8487 
    85 \subfile{../tex_sub/chap_dynamics} 
     88\subfile{../subfiles/chap_dynamics} 
    8689 
    87 \subfile{../tex_sub/chap_transport} 
     90\subfile{../subfiles/chap_transport} 
    8891 
    89 \subfile{../tex_sub/chap_ridging_rafting} 
     92\subfile{../subfiles/chap_ridging_rafting} 
    9093 
    91 \subfile{../tex_sub/chap_radiative_transfer} 
     94\subfile{../subfiles/chap_radiative_transfer} 
    9295 
    93 \subfile{../tex_sub/chap_thermo} 
     96\subfile{../subfiles/chap_thermo} 
    9497 
    95 \subfile{../tex_sub/chap_interfaces} 
     98\subfile{../subfiles/chap_interfaces} 
    9699 
    97 \subfile{../tex_sub/chap_output_diagnostics} 
     100\subfile{../subfiles/chap_output_diagnostics} 
    98101 
    99 \subfile{../tex_sub/chap_single_category_use} 
     102\subfile{../subfiles/chap_single_category_use} 
    100103 
    101 \subfile{../tex_sub/chap_bdy_agrif} 
     104\subfile{../subfiles/chap_bdy_agrif} 
    102105 
    103 \subfile{../tex_sub/chap_miscellaneous} 
     106\subfile{../subfiles/chap_miscellaneous} 
    104107 
    105108%% Appendix 
    … …  
    117120\addcontentsline{toc}{chapter}{Bibliography} 
    118121 
    119 \bibliography{../tex_main/SI3_manual.bbl} 
     122\bibliography{../main/SI3_manual} 
    120123%\bibliography{/Users/ioulianikolskaia/Boulot/LIBRARY/BIBTEX/Martin_biblio.bib}  
    121124 
Note: See TracChangeset for help on using the changeset viewer.