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 9388 for branches/2017/dev_merge_2017/DOC/tex_main/NEMO_manual.tex – NEMO

Ignore:
Timestamp:
2018-03-08T17:57:24+01:00 (6 years ago)
Author:
nicolasmartin
Message:

Global reorganisation of DOC directory: implementation and configuration of syntax highlighting with 'minted' LaTeX package
New macros have been created to insert different source codes (fortran, xml, c and shell-session) in the document.
Pygments Python package is now required to compile the documentation.

Location:
branches/2017/dev_merge_2017/DOC/tex_main
Files:
1 added
1 moved

Legend:

Unmodified
Added
Removed

  • branches/2017/dev_merge_2017/DOC/tex_main/NEMO_manual.tex

    r9387 r9388  
    44 
    55 
    6 %% Run build_NEMO_manual.sh to generate the PDF version (with pdflatex) 
     6%% Run ../build_NEMO_manual.sh to generate the PDF version (with pdflatex) 
     7 
     8%% Document layout 
     9%% ============================================================================== 
     10 
     11\documentclass[a4paper, 11pt]{book} 
    712 
    813 
    … …  
    1015%% ============================================================================== 
    1116 
    12 \include{texfiles/preamble} 
     17\usepackage{../tex_main/NEMO_manual} 
     18\usepackage{../tex_sub/minted} 
     19\pagestyle{fancy} 
     20\bibliographystyle{../tex_sub/ametsoc} 
     21 
     22\makeindex 
     23 
     24 
     25%%  
     26%% ============================================================================== 
    1327 
    1428\begin{document} 
    15  
    16  
    17 %% 'minted' env. & shortcuts for syntax highlighting 
    18  
    19 \setminted[fortran]{fontsize=\tiny, breaklines} 
    20 \newminted{fortran}{}         % \begin{fortrancode} 
    21 \newmintinline{fortran}{}     % \fortraninline 
    22 \newmintedfile{fortran}{}     % \fortranfile 
    23 \newminted{xml}{fontsize=\tiny, breaklines} 
    24 \newminted{sh}{} 
    25 \newminted{c}{} 
    2629 
    2730 
    … …  
    2932%% ============================================================================== 
    3033 
    31 \subfile{texfiles/top_matter} 
     34%% Frontpage 
    3235 
     36\title{ 
     37\vspace{-6.0cm}\includegraphics[width=1.1\textwidth]{logo_ALL}          \\ 
     38\vspace{ 5.1cm}\includegraphics[width=0.9\textwidth]{NEMO_logo_Black}   \\ 
     39\vspace{ 1.4cm}\rule{345pt}{1.5pt}                                      \\ 
     40\vspace{0.45cm}{\Huge NEMO ocean engine}                                \\ 
     41\rule{345pt}{1.5pt} 
     42} 
    3343 
    34 %% Frontpage 
     44\author{ 
     45\Large Gurvan Madec, and the NEMO team                                                          \\ 
     46\texttt{\small\href{mailto:gurvan.madec@locean-ipsl.umpc.fr}{gurvan.madec@locean-ipsl.umpc.fr}} \\ 
     47} 
     48 
     49\date{ 
     50Decembre 2017                                                                                \\ 
     51{\small  -- version 4.0 alpha --}                                                            \\ 
     52~                                                                                            \\ 
     53\textit{\small Note du P\^ole de mod\'{e}lisation de l'Institut Pierre-Simon Laplace No 27 } \\ 
     54\vspace{0.45cm}{ ISSN No 1288-1619.} 
     55} 
     56%\date{\today} 
    3557 
    3658\maketitle 
    … …  
    5274%% Abstract - Foreword 
    5375 
    54 \subfile{texfiles/chapters/abstract_foreword} 
     76\subfile{../tex_sub/abstract_foreword} 
    5577 
    5678 
    5779% Introduction 
    5880 
    59 \subfile{texfiles/chapters/introduction} 
     81\subfile{../tex_sub/introduction} 
    6082 
    6183 
    6284% Chapters 
    6385 
    64 \subfile{texfiles/chapters/chap_model_basics} 
     86\subfile{../tex_sub/chap_model_basics} 
    6587 
    66 \subfile{texfiles/chapters/chap_step}           % Time discretisation (time stepping strategy) 
     88\subfile{../tex_sub/chap_time_domain}           % Time discretisation (time stepping strategy) 
    6789 
    68 \subfile{texfiles/chapters/chap_DOM}            % Space discretisation 
     90\subfile{../tex_sub/chap_DOM}          % Space discretisation 
    6991 
    70 \subfile{texfiles/chapters/chap_TRA}            % Tracer advection/diffusion equation 
     92\subfile{../tex_sub/chap_TRA}          % Tracer advection/diffusion equation 
    7193 
    72 \subfile{texfiles/chapters/chap_DYN}            % Dynamics : momentum equation 
     94\subfile{../tex_sub/chap_DYN}          % Dynamics : momentum equation 
    7395 
    74 \subfile{texfiles/chapters/chap_SBC}            % Surface Boundary Conditions 
     96\subfile{../tex_sub/chap_SBC}          % Surface Boundary Conditions 
    7597 
    76 \subfile{texfiles/chapters/chap_LBC}            % Lateral Boundary Conditions 
     98\subfile{../tex_sub/chap_LBC}          % Lateral Boundary Conditions 
    7799 
    78 \subfile{texfiles/chapters/chap_LDF}            % Lateral diffusion 
     100\subfile{../tex_sub/chap_LDF}          % Lateral diffusion 
    79101 
    80 \subfile{texfiles/chapters/chap_ZDF}            % Vertical diffusion 
     102\subfile{../tex_sub/chap_ZDF}          % Vertical diffusion 
    81103 
    82 \subfile{texfiles/chapters/chap_DIA}            % Outputs and Diagnostics 
     104\subfile{../tex_sub/chap_DIA}          % Outputs and Diagnostics 
    83105 
    84 \subfile{texfiles/chapters/chap_OBS}            % Observation operator 
     106\subfile{../tex_sub/chap_OBS}          % Observation operator 
    85107 
    86 \subfile{texfiles/chapters/chap_ASM}            % Assimilation increments 
     108\subfile{../tex_sub/chap_ASM}          % Assimilation increments 
    87109 
    88 \subfile{texfiles/chapters/chap_STO}            % Stochastic param. 
     110\subfile{../tex_sub/chap_STO}          % Stochastic param. 
    89111 
    90 \subfile{texfiles/chapters/chap_misc}           % Miscellaneous topics 
     112\subfile{../tex_sub/chap_misc}            % Miscellaneous topics 
    91113 
    92 \subfile{texfiles/chapters/chap_CONFIG}         % Predefined configurations 
     114\subfile{../tex_sub/chap_CONFIG}       % Predefined configurations 
    93115 
    94116 
    95 % Appendix 
     117%% Appendix 
    96118 
    97119\appendix 
    98120 
    99 \subfile{texfiles/chapters/annex_A}             % Generalised vertical coordinate 
     121\subfile{../tex_sub/annex_A}              % Generalised vertical coordinate 
    100122 
    101 \subfile{texfiles/chapters/annex_B}             % Diffusive operator 
     123\subfile{../tex_sub/annex_B}              % Diffusive operator 
    102124 
    103 \subfile{texfiles/chapters/annex_C}             % Discrete invariants of the eqs. 
     125\subfile{../tex_sub/annex_C}              % Discrete invariants of the eqs. 
    104126 
    105 \subfile{texfiles/chapters/annex_iso}           % Isoneutral diffusion using triads 
     127\subfile{../tex_sub/annex_iso}            % Isoneutral diffusion using triads 
    106128 
    107 \subfile{texfiles/chapters/annex_D}             % Coding rules 
     129\subfile{../tex_sub/annex_D}              % Coding rules 
    108130 
    109131%% Not included 
    110 %\subfile{texfiles/chapters/chap_conservation}  % 
    111 %\subfile{texfiles/chapters/annex_E}            % Notes on some on going staff 
    112 %\subfile{texfiles/chapters/annex_Fox-Kemper}   % Notes on Fox-Kemper 
    113 %\subfile{texfiles/chapters/annex_EVP}          % Notes on EVP 
     132%\subfile{../tex_sub/chap_conservation}   % 
     133%\subfile{../tex_sub/annex_E}          % Notes on some on going staff 
     134%\subfile{../tex_sub/annex_Fox-Kemper} % Notes on Fox-Kemper 
     135%\subfile{../tex_sub/annex_EVP}           % Notes on EVP 
    114136 
    115137 
    … …  
    128150%% Bibliography 
    129151 
    130 \bibliography{texfiles/bibliography/NEMO_manual} 
     152\bibliography{../tex_main/NEMO_manual} 
    131153 
    132154 
Note: See TracChangeset for help on using the changeset viewer.