Changeset 11170


Ignore:
Timestamp:
2019-06-21T12:18:45+02:00 (16 months ago)
Author:
nicolasmartin
Message:

Review of the overall building of any reference manual
Implementation of a compilation process shared between the 3 manuals: now a global document.tex will be used as the main LaTeX file (a symbolic link will refer to it in each ./engine/main directory).
At the time of the manual building, a few small LaTeX files will be imported on the fly from the corresponding folder ./latex/engine/main.

  • definitions.tex: engine, title, author(s), IPSL publication number and DOI ID
  • thanks.tex: list of collaborators to be thanked for the writing/reviewing
  • chapters.tex: ordered list of chapters (relative path to subfiles)
  • appendices.tex: ordered list of subordinate chapters (relative path to subfiles)
Location:
NEMO/trunk/doc/latex
Files:
5 added
3 edited
2 copied
2 moved

Legend:

Unmodified
Added
Removed
  • NEMO/trunk/doc/latex/global/document.tex

    r11154 r11170  
    11%% ============================================================================== 
    2 %% NEMO Reference Manual 
     2%% Reference Manual 
    33%% ============================================================================== 
    44 
     5%% NEMO release version 
     6\def\version{X.X~} 
    57 
    68%% Preamble 
     
    1214%% Custom style (.sty) 
    1315\usepackage{../../global/packages} 
    14 \hypersetup{ 
    15   pdftitle={NEMO ocean engine}, 
    16   pdfauthor={Gurvan Madec and NEMO System Team}, 
    17   colorlinks 
    18 } 
     16 
     17%% Engine name and Zenodo DOI 
     18\input{definitions} 
    1919 
    2020%% Include references and index for single subfile compilation 
    21 \newcommand{\biblio}{\bibliography{../main/NEMO_manual}} 
     21\newcommand{\biblio}{\bibliography{../main/bibliography}} 
    2222\newcommand{\pindex}{\printindex} 
    2323 
     
    3636%% ============================================================================== 
    3737 
    38 \title{NEMO ocean engine} 
    39 \author{Gurvan Madec \and NEMO System Team\thanks{ 
    40     TBD 
    41   } 
    42 } 
    43 \date{\today} 
    44  
    4538%% Title and information pages 
    4639\input{../../global/frontpages} 
    4740 
    48 %% Citation embedded 
    49 \textsf{ 
    50 ``{\bfseries NEMO ocean engine}'',  
    51 Madec Gurvan and NEMO System Team,  
    52 {\em Scientific Notes of Climate Modelling Center (27)} -- ISSN 1288-1619,  
    53 Institut Pierre-Simon Laplace (IPSL),  
    54 \href{https://doi.org/10.5281/zenodo.1464816}{doi:10.5281/zenodo.1464816} 
    55 } 
     41%% Engine citation 
     42\input{../../global/citation} 
    5643 
     44%% Foreword 
    5745\newpage 
    5846%\frontmatter   %% Chapter numbering off and Roman numerals for page numbers 
    5947\pagenumbering{roman} 
    60  
    61 \subfile{../subfiles/foreword}            %% Foreword 
    62  
     48\subfile{../subfiles/foreword} 
    6349 
    6450%% ToC i.e. Table of Contents 
    6551\newpage 
    66 \dominitoc 
    67 \tableofcontents 
     52\dominitoc\tableofcontents 
    6853 
    6954\clearpage 
    7055%\end{document} 
     56 
    7157 
    7258%% Mainmatter 
     
    7662\pagenumbering{arabic} 
    7763 
    78 \graphicspath{{../../figures/NEMO/}} 
     64\graphicspath{{../../figures/\engine/}} 
     65\input{chapters} 
    7966 
    80 \subfile{../subfiles/introduction}        %% Introduction 
    81  
    82 %% Chapters 
    83 \subfile{../subfiles/chap_model_basics} 
    84 \subfile{../subfiles/chap_time_domain}    %% Time discretisation (time stepping strategy) 
    85 \subfile{../subfiles/chap_DOM}            %% Space discretisation 
    86 \subfile{../subfiles/chap_TRA}            %% Tracer advection/diffusion equation 
    87 \subfile{../subfiles/chap_DYN}            %% Dynamics : momentum equation 
    88 \subfile{../subfiles/chap_SBC}            %% Surface Boundary Conditions 
    89 \subfile{../subfiles/chap_LBC}            %% Lateral Boundary Conditions 
    90 \subfile{../subfiles/chap_LDF}            %% Lateral diffusion 
    91 \subfile{../subfiles/chap_ZDF}            %% Vertical diffusion 
    92 \subfile{../subfiles/chap_DIA}            %% Outputs and Diagnostics 
    93 \subfile{../subfiles/chap_OBS}            %% Observation operator 
    94 \subfile{../subfiles/chap_ASM}            %% Assimilation increments 
    95 \subfile{../subfiles/chap_STO}            %% Stochastic param. 
    96 \subfile{../subfiles/chap_misc}           %% Miscellaneous topics 
    97 \subfile{../subfiles/chap_CONFIG}         %% Predefined configurations 
    9867 
    9968%% Appendix 
    10069%% ============================================================================== 
    10170 
    102 \appendix   % Chapter numbering is reset with letters now 
     71%% Chapter numbering is reset with letters now 
     72\appendix    
    10373 
    104 \subfile{../subfiles/annex_A}             %% Generalised vertical coordinate 
    105 \subfile{../subfiles/annex_B}             %% Diffusive operator 
    106 \subfile{../subfiles/annex_C}             %% Discrete invariants of the eqs. 
    107 \subfile{../subfiles/annex_iso}            %% Isoneutral diffusion using triads 
    108 \subfile{../subfiles/annex_D}             %% Coding rules 
     74\input{appendices} 
    10975 
    110 %% Not included 
    111 %\subfile{../subfiles/chap_model_basics_zstar} 
    112 %\subfile{../subfiles/chap_DIU} 
    113 %\subfile{../subfiles/chap_conservation} 
    114 %\subfile{../subfiles/annex_E}            %% Notes on some on going staff 
    11576 
    11677%% Backmatter 
     
    12081 
    12182%% Bibliography 
    122 \phantomsection 
    123 \addcontentsline{toc}{chapter}{Bibliography} 
    124 \bibliography{../main/NEMO_manual} 
     83\phantomsection\addcontentsline{toc}{chapter}{Bibliography} 
     84\bibliography{../main/bibliography} 
    12585 
    12686%% Index 
    12787\clearpage 
    128 \phantomsection 
    129 \addcontentsline{toc}{chapter}{Index} 
     88\phantomsection\addcontentsline{toc}{chapter}{Index} 
    13089\printindex 
    13190 
  • NEMO/trunk/doc/latex/global/frontpages.tex

    r11148 r11170  
    1 \graphicspath{{../../figures/logos/}} 
     1\title{\heading} 
     2\author{\1stauthor \and \2ndauthor\thanks{\protect\input{thanks}}} 
     3\date{\today} 
     4 
     5\graphicspath{{../../figures/}} 
    26 
    37\pretitle{ 
     
    59\begin{figure}[H] 
    610  \begin{minipage}[c]{0.35\textwidth} 
    7     \href{http://www.nemo-ocean.eu}{\includegraphics[width=0.7\textwidth]{NEMO_grey}} 
     11    \href{http://www.nemo-ocean.eu}{\includegraphics[width=0.7\textwidth]{logos/NEMO_grey}} 
    812  \end{minipage} 
    913  \hfill 
     
    1721} 
    1822\posttitle{\par\end{center}\vskip 0.5em} 
    19 \preauthor{\begin{center}\Large\lineskip 0.5em\begin{tabular}[t]{c}} 
     23\preauthor{\begin{center}\Large\lineskip0.5em\begin{tabular}[t]{c}} 
    2024\postauthor{\end{tabular}\par\end{center}} 
    2125\predate{ 
    2226  \vfill 
    2327  \begin{center} 
    24     \large 
    25     Version X.X -- 
     28    \large Version \version --- 
    2629} 
    2730\postdate{ 
    28     \par 
    29     ~\\ 
    30     \href{http://doi.org/10.5281/zenodo.1464816}{\includegraphics{{../../NEMO/main/zenodo.1464816}.pdf}} 
     31    \par~\\ 
     32    \href{http://doi.org/10.5281/zenodo.\zid}{\includegraphics{{badges/zenodo.\zid}.pdf}} 
    3133  \end{center} 
    3234  \vfill 
    3335  \begin{center} 
    34 %    \hspace*{\fill} 
    35     \href{http://www.cmcc.it}{          \includegraphics[height=0.055\textheight]{CMCC}} %\hfill 
     36    \href{http://www.cmcc.it}{          \includegraphics[height=0.055\textheight]{logos/CMCC}} 
    3637    \hspace{0.5em} 
    37     \href{http://www.cnrs.fr}{          \includegraphics[height=0.055\textheight]{CNRS}} %\hfill 
     38    \href{http://www.cnrs.fr}{          \includegraphics[height=0.055\textheight]{logos/CNRS}} 
    3839    \hspace{0.9em} 
    39     \href{http://www.mercator-ocean.fr}{\includegraphics[height=0.055\textheight]{MOI} } %\hfill 
     40    \href{http://www.mercator-ocean.fr}{\includegraphics[height=0.055\textheight]{logos/MOI} } 
    4041    \hspace{0.45em} 
    41     \href{http://www.metoffice.gov.uk}{ \includegraphics[height=0.055\textheight]{UKMO}} %\hfill 
     42    \href{http://www.metoffice.gov.uk}{ \includegraphics[height=0.055\textheight]{logos/UKMO}} 
    4243    \hspace{0.5em} 
    43     \href{http://nerc.ukri.org}{        \includegraphics[height=0.055\textheight]{NERC}}        \\ 
    44 %    \hspace*{\fill} 
    45     \large{{\em{C}ommunity \hspace{1.5em} {O}cean \hspace{1.5em} {M}odel}}     \\ 
     44    \href{http://nerc.ukri.org}{        \includegraphics[height=0.055\textheight]{logos/NERC}} \\ 
     45    \large{{\em{C}ommunity \hspace{1.5em} {O}cean \hspace{1.5em} {M}odel}} 
    4646  \end{center} 
    4747} 
     
    5757\subsubsection*{Disclaimer} 
    5858 
    59 Like all components of NEMO, 
    60 this core engine is developed under the \href{http://www.cecill.info}{CECILL license}, 
     59Like all components of the modelling framework, 
     60the \engine~core engine is developed under the \href{http://www.cecill.info}{CECILL license}, 
    6161which is a French adaptation of the GNU GPL (General Public License). 
    6262Anyone may use it freely for research purposes, and is encouraged to 
     
    8080  associated applications and an exhaustive users bibliography 
    8181\item the \href{http://forge.ipsl.jussieu.fr/nemo}{development platform} of the model with 
    82   the code repository and some main resources (wiki, ticket system, forums, ...) 
     82  the code repository and some main resources (wiki, ticket system, forums, \ldots) 
    8383\item the \href{http://zenodo.org/communities/nemo-ocean}{online archive} 
    8484  delivering the publications issued by the consortium 
     
    8686  the \href{http://listes.ipsl.fr/sympa/info/nemo-newsletter}{newsletter} for 
    8787  top-down communications from the project 
    88   (announcements, calls, job opportunities, ...) 
     88  (announcements, calls, job opportunities, \ldots) 
    8989  and the \href{http://listes.ipsl.fr/sympa/info/nemo-forge}{forge updates} 
    9090  (commits, tickets and forums) 
     
    108108  \hfill 
    109109  \begin{minipage}[c]{0.25\textwidth} 
    110     \href{http://www.cmc.ipsl.fr}{\includegraphics[width=\textwidth]{IPSL_upright}} 
     110    \href{http://www.cmc.ipsl.fr}{\includegraphics[width=\textwidth]{logos/IPSL_upright}} 
    111111  \end{minipage} 
    112112\end{figure} 
  • NEMO/trunk/doc/latex/global/packages.sty

    r11148 r11170  
    1 %% LaTeX packages 
     1%% LaTeX packages in use 
    22%% ============================================================================== 
     3 
    34\usepackage{natbib}                      %% bib 
    45\usepackage{caption}                     %% caption 
     
    1011\usepackage[outputdir=../build]{minted}  %% listing 
    1112\usepackage{amsmath}                     %% maths 
    12 \usepackage{fancyhdr}                    %% page 
     13%\usepackage{fancyhdr}                    %% page 
    1314\usepackage{minitoc}                     %% toc 
    1415\usepackage{subfiles}                    %% subdocs 
    15 \usepackage[utf8]{inputenc}              %% input encoding 
    1616\usepackage{draftwatermark}              %% watermark 
    17 \usepackage{textcomp}                    %% Companion fonts 
    18 \usepackage{titling} 
     17\usepackage{titling}                     %% titlepage 
    1918 
    2019%% Extensions in bundle package 
    21 \usepackage{amssymb, graphicx, makeidx, tabularx} 
     20\usepackage{amssymb, graphicx, makeidx, tabularx, textcomp} 
     21\usepackage[utf8]{inputenc}              %% input encoding 
    2222 
    2323%% Configuration 
     
    3030\usepackage{../../global/styles} 
    3131\usepackage{../../global/new_cmds} 
    32 \usepackage{../../global/minted} 
     32\usepackage{../../global/highlighting} 
    3333\usepackage{../../global/todonotes} 
  • NEMO/trunk/doc/latex/global/styles.sty

    r11148 r11170  
    11%% Styles 
    22%% ============================================================================== 
    3 \pagestyle{fancy} 
     3 
     4%\pagestyle{fancy} 
    45\bibliographystyle{../../global/ametsoc} 
    56 
     
    78\DeclareMathAlphabet{\mathpzc}{OT1}{pzc}{m}{it} 
    89 
     10%% Hyperref 
     11\hypersetup{ 
     12  colorlinks 
     13} 
    914 
    1015%% Page layout 
Note: See TracChangeset for help on using the changeset viewer.