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 14644 for NEMO/branches/2020/dev_r14116_HPC-04_mcastril_Mixed_Precision_implementation_final/doc/latex/global – NEMO

Ignore:
Timestamp:
2021-03-26T15:33:49+01:00 (3 years ago)
Author:
sparonuz
Message:

Merge trunk -r14642:HEAD

Location:
NEMO/branches/2020/dev_r14116_HPC-04_mcastril_Mixed_Precision_implementation_final
Files:
4 added
2 deleted
12 edited

Legend:

Unmodified
Added
Removed

  • NEMO/branches/2020/dev_r14116_HPC-04_mcastril_Mixed_Precision_implementation_final

    • Property svn:externals

      •  

        old new  
        99 
        1010# SETTE 
        11 ^/utils/CI/sette_wave@13990         sette 
         11^/utils/CI/sette@14244        sette 

  • NEMO/branches/2020/dev_r14116_HPC-04_mcastril_Mixed_Precision_implementation_final/doc/latex/global

    • Property svn:ignore set to
      *.aux
      *.bbl
      *.blg
      *.fdb*
      *.fls
      *.idx
      *.ilg
      *.ind
      *.lo*
      *.out
      *.toc
      *.xdv
      cache*

  • NEMO/branches/2020/dev_r14116_HPC-04_mcastril_Mixed_Precision_implementation_final/doc/latex/global/document.tex

    r14113 r14644  
    1  
    21%% ================================================================================================= 
    3 %% Template structure for reference manuals 
     2%% Manual structure 
    43%% ================================================================================================= 
    54 
    6 %% NEMO release version 
    7 \def \version{trunk} 
    8  
    9 %% Preamble 
     5%% Preamble: global configuration 
    106%% ================================================================================================= 
    117 
    12 %% Document layout 
    13 \documentclass[fontsize = 10pt, twoside, abstract]{scrreprt} 
     8%% Layout 
     9\documentclass[fontsize=10pt,twoside,abstract,draft]{scrreprt} 
     10%\documentclass[fontsize=10pt,twoside,abstract      ]{scrreprt} 
    1411 
    15 %% Load manual configuration 
    16 \input{../../global/prologue} 
     12%% Overall configuration  
     13\input{../../global/preamble} 
    1714 
    18 %% End of common preamble between main and sub-files 
    19 %% Override custom cmds for full manual compilation 
    20 \newcommand{\subinc}[1]{#1} 
    21 \newcommand{\subexc}[1]{} 
     15%% Special cmds around to {in,ex}clude content only in subfile 
     16  \newcommand{\subinc}[1]{#1} 
     17  \newcommand{\subexc}[1]{  } 
    2218 
    2319\begin{document} 
    2420 
    25 \renewcommand{\subinc}[1]{} 
     21\renewcommand{\subinc}[1]{  } 
    2622\renewcommand{\subexc}[1]{#1} 
    2723 
    28  
    29 %% Frontmatter 
     24%% Frontmatter: covers 
     25%% ({sub}title, DOI, authors, abstract and color theme are specific to each manual) 
    3026%% ================================================================================================= 
    3127 
     28%\frontmatter %% Not recognized in 'scrreprt' document class 
    3229\pagenumbering{gobble}   %% Disable page numbering temporarily 
     30\pagestyle{empty} 
    3331 
    34 %% Title page 
    3532\input{../../global/frontpage} 
    36  
    37 %% Footer for introductory parts (no header by cleaning default) 
    38 \ofoot[]{\engine\ Reference Manual} \ifoot[]{\pagemark} 
    39  
    40 %% Information page (2nd page) 
    4133\input{../../global/info_page} 
    4234 
     35\cleardoublepage 
     36 
     37\pagenumbering{Roman} %% Reactivate page numbering (uppercase roman numbers) 
     38\pagestyle{plain} 
     39%\lastpageref{pagesLTS.0} 
     40 
     41\tableofcontents 
    4342\listoffigures 
    4443\listoflistings 
    4544\listoftables 
     45%\listoftodos 
     46%\lastpageref{pagesLTS.Roman} 
    4647 
    47 \clearpage 
     48\cleardoublepage 
    4849 
    49 \pagenumbering{roman} 
    50 \ofoot[]{\engine\ Reference Manual} \ifoot[]{\pagemark} 
     50%% Mainmatter: toc, lists, introduction and primary chapters 
     51%% ================================================================================================= 
     52 
     53%\mainmatter %% Not recognized in 'scrreprt' document class 
     54\pagenumbering{arabic} %% Standard page numbering 
     55\pagestyle{plain} 
    5156 
    5257\input{introduction} 
    5358 
    54 %% Table of Contents 
    55 \tableofcontents 
     59\cleardoublepage 
    5660 
    57 \clearpage 
     61\pagestyle{scrheadings} 
     62\renewcommand{\chapterpagestyle}{empty} 
    5863 
     64\input{chapters} 
    5965 
    60 %% Mainmatter 
     66%% Appendix: subordinate chapters 
    6167%% ================================================================================================= 
    6268 
    63 %% Headings for document body 
    64 \pagenumbering{arabic} 
    65 \lohead{Chap.\ \thechapter\ \leftmark} \rehead{Sect.\ \thesection\ \rightmark} 
    66 \ifoot[]{Page\ \pagemark\ of \pageref*{LastPage}} 
     69\appendix %% Chapter numbering with letters by now 
     70\lohead{Apdx \thechapter\ \leftmark} 
    6771 
    68 \include{chapters} 
     72\input{appendices} 
    6973 
     74\input{../../global/coding_rules} %% Add coding rules on every manual 
    7075 
    71 %% Appendix 
     76%\lastpageref{pagesLTS.arabic} 
     77\cleardoublepage 
     78 
     79%% Backmatter: bibliography, glossaries and indices 
    7280%% ================================================================================================= 
    7381 
    74 \appendix   %% Chapter numbering with letters by now 
    75 \lohead{Apdx\ \thechapter\ \leftmark} 
    76 \include{appendices} 
     82%\backmatter %% Not recognized in 'scrreprt' document class 
     83\pagenumbering{roman} %% Lowercase roman numbers 
     84\pagestyle{plain} 
    7785 
    78 %% Append coding rules for every manual 
    79 \input{../../global/coding_rules} 
    80  
    81  
    82 %% Backmatter 
    83 %% ================================================================================================= 
    84  
    85 %% Bibliography and indexes 
    8686\input{../../global/epilogue} 
    8787 
     88%\lastpageref{pagesLTS.roman} 
     89 
    8890\end{document} 

  • NEMO/branches/2020/dev_r14116_HPC-04_mcastril_Mixed_Precision_implementation_final/doc/latex/global/epilogue.tex

    r14113 r14644  
    1  
    2 \clearpage 
     1%% ================================================================================================= 
     2%% Backmatter 
     3%% ================================================================================================= 
    34 
    45%% Bibliography 
     6%% ================================================================================================= 
     7 
    58\phantomsection 
    69\addcontentsline{toc}{chapter}{Bibliography} 
    7 \lohead{Bibliography} \rehead{Bibliography} 
     10\lohead{Bibliography} 
     11\rehead{Bibliography} 
    812\bibliography{../main/bibliography} 
    913 
    1014\clearpage 
    1115 
    12 %% Indexes 
     16%% Indices 
     17%% ================================================================================================= 
     18 
    1319\phantomsection 
    14 \addcontentsline{toc}{chapter}{Indexes} 
    15 \lohead{Indexes} \rehead{Indexes} 
     20\addcontentsline{toc}{chapter}{Indices} 
     21\lohead{Indices} 
     22\rehead{Indices} 
    1623\printindex[blocks] 
    1724\printindex[keys] 
    … …  
    1926\printindex[parameters] 
    2027\printindex[subroutines] 
     28 
     29\clearpage 
     30 
     31%% Glossary 
     32%% ================================================================================================= 
     33 
     34%\phantomsection 
     35%\addcontentsline{toc}{chapter}{Glossary} 
     36%\lohead{Glossary}\rehead{Glossary} 
     37%\printglossaries 

  • NEMO/branches/2020/dev_r14116_HPC-04_mcastril_Mixed_Precision_implementation_final/doc/latex/global/frontpage.tex

    r14113 r14644  
     1%% ================================================================================================= 
     2%% Front cover 
     3%% ================================================================================================= 
    14 
    25\begin{titlepage} 
    3 %  \newgeometry{hmargin = 1.5cm, vmargin = 3cm} 
    4   \setlength{\parindent}{0pt} 
     6%   \newgeometry{hmargin=1.5cm,vmargin=3cm} 
     7   \setlength{\parindent}{0pt} 
    58 
    6   \begin{center} 
    7     \begin{minipage}{0.3\textwidth} 
    8       \includegraphics[height=1.5cm]{logos/NEMO_grey} 
    9     \end{minipage}\begin{minipage}{0.6\textwidth} 
    10       \begin{center} 
    11       \Large\slshape 
    12       \textbf{N}ucleus for \textbf{E}uropean \textbf{M}odelling of the \textbf{O}cean \\ 
     9   \begin{center} 
     10 
     11      \begin{minipage}{0.3\textwidth} 
     12         \includegraphics[height=1.5cm]{NEMO_grey} 
     13      \end{minipage} %% Don't insert void line between `minipage` envs 
     14      \begin{minipage}{0.6\textwidth} 
     15         \begin{center} 
     16            \Large\slshape 
     17            \textbf{N}ucleus for \textbf{E}uropean \textbf{M}odelling of the \textbf{O}cean \\ 
     18            \medskip 
     19            \hyperref[resources]{ 
     20               \faWordpress \hspace{1cm} \faCodeFork      \hspace{1cm} 
     21               \faGithub    \hspace{1cm} \faCloudDownload \hspace{1cm} \faEnvelope 
     22            } 
     23         \end{center} 
     24      \end{minipage} 
     25 
     26   \end{center} 
     27 
     28   \spcup 
     29   \textcolor{white}{\fontsize{0.8cm}{0.8cm}\selectfont\textbf{\hdg}} 
     30   \ifdef{\shdg}{\medskip\par\textcolor{white}{\Huge\shdg}}{} 
     31   \spcdn 
     32 
     33   \begin{center} 
     34      \LARGE Version {\ver} - {\today} \\ 
    1335      \medskip 
    14       \hyperref[resources]{\textcolor{black}{ 
    15           \faWordpress \hspace{0.75cm} \faCodeFork      \hspace{0.75cm} 
    16           \faGithub    \hspace{0.75cm} \faCloudDownload \hspace{0.75cm} \faEnvelope 
    17         } 
    18       } 
    19       \end{center} 
    20     \end{minipage} 
    21   \end{center} 
     36      \href{http://doi.org/10.5281/zenodo.\zid}{\includegraphics{zenodo.\zid}} 
     37   \end{center} 
    2238 
    23   \spacetop 
    24   \textcolor{white}{\fontsize{0.8cm}{0.8cm}\selectfont\textbf{\heading}} 
    25   \ifdef{\subheading}{ 
    26     \medskip 
    27     \par 
    28     \textcolor{white}{\Huge \subheading} 
    29   }{} 
    30   \spacedown 
     39   \vfill 
    3140 
    32   \begin{center} 
    33     \LARGE Version \version\ -\ \today \\ 
    34     \medskip 
    35     \href{http://doi.org/10.5281/zenodo.\zid}{ \includegraphics{badges/zenodo.\zid} } 
    36   \end{center} 
     41   \begin{minipage}{\autwd} 
     42      \raggedleft\input{authors} 
     43   \end{minipage} 
     44   \hspace{15pt} %% Don't insert void line between `minipage` envs 
     45   \begin{minipage}{0.02\linewidth} 
     46      \rule{1pt}{\lnlg} 
     47   \end{minipage} 
     48   \hspace{ 5pt} %%   "     ""    ""   ""     "        ""      "" 
     49   \begin{minipage}{\abswd} 
     50      \begin{abstract} 
     51         \input{abstract} 
     52      \end{abstract} 
     53   \end{minipage} 
    3754 
    38   \vfill 
     55   \vfill 
    3956 
    40   \begin{minipage}{\authorswidth} 
    41     \raggedleft 
    42     \input{authors} 
    43   \end{minipage}\hspace{15pt}\begin{minipage}{0.02\linewidth} 
    44     \rule{1pt}{\rulelenght} 
    45   \end{minipage}\hspace{ 5pt}\begin{minipage}{\abstractwidth} 
    46     \begin{abstract} 
    47       \input{abstract} 
    48     \end{abstract} 
    49   \end{minipage} 
    50  
    51   \vfill 
    52  
    53   \begin{center} 
    54     \Large 
    55     \href{http://www.cmcc.it          }{ \includegraphics[height=1cm]{logos/CMCC} } \hspace{0.25cm} 
    56     \href{http://www.cnrs.fr          }{ \includegraphics[height=1cm]{logos/CNRS} } \hspace{0.25cm} 
    57     \href{http://www.mercator-ocean.fr}{ \includegraphics[height=1cm]{logos/MOI}  } \hspace{0.25cm} 
    58     \href{http://www.metoffice.gov.uk }{ \includegraphics[height=1cm]{logos/UKMO} } \hspace{0.25cm} 
    59     \href{http://nerc.ukri.org        }{ \includegraphics[height=1cm]{logos/NERC} } \\ 
    60     \medskip 
    61     \slshape 
    62     {C}ommunity \hspace{1.5em} {O}cean \hspace{1.5em} {M}odel \\ 
    63   \end{center} 
     57   \begin{center} 
     58      \Large 
     59      \CMCC{\includegraphics[height=1cm]{CMCC}} \hspace{0.25cm} 
     60      \CNRS{\includegraphics[height=1cm]{CNRS}} \hspace{0.25cm} 
     61       \MOI{\includegraphics[height=1cm]{MOI} } \hspace{0.25cm} 
     62      \UKMO{\includegraphics[height=1cm]{UKMO}} \hspace{0.25cm} 
     63      \NERC{\includegraphics[height=1cm]{NERC}}                 \\ 
     64      \medskip 
     65      \slshape 
     66         {C}ommunity \hspace{1.5em} {O}cean \hspace{1.5em} {M}odel 
     67   \end{center} 
    6468 
    6569\end{titlepage} 
    6670 
    67 \restoregeometry 
     71%\restoregeometry 

  • NEMO/branches/2020/dev_r14116_HPC-04_mcastril_Mixed_Precision_implementation_final/doc/latex/global/highlighting.tex

    r14113 r14644  
     1%% ================================================================================================= 
    12%% Syntax highlighting configuration 
    2 %% ============================================================================== 
    3  
    4 \usepackage[outputdir=../build, chapter, newfloat]{minted} 
     3%% ================================================================================================= 
    54 
    65%% Global highlighting style 
    7 \definecolor{bg}{HTML}{f8f8f8} 
     6\definecolor{bg}{HTML}{f8f8f8} %% ? 
    87\usemintedstyle{emacs} 
    9 \setminted{bgcolor=bg, fontsize=\scriptsize, breaklines} 
    10 \setminted[xml]{style=borland} %% Specific per language 
     8\setminted{bgcolor=bg,fontsize=\scriptsize,breaklines} 
     9\setminted[xml]{style=borland} %% Specific style for XML 
     10 
     11%% Inline 
     12\newmintinline[forcode]{fortran}{bgcolor=,fontsize=auto} %% \forcode{...} 
     13\newmintinline[xmlcode]{xml}{    bgcolor=,fontsize=auto} %% \xmlcode{...} 
     14\newmintinline[snippet]{console}{bgcolor=,fontsize=auto} %% \snippet{...} 
    1115 
    1216%% Oneliner 
    13 \newmint[forline]{fortran}{}   % \forline|...| 
    14 \newmint[xmlline]{xml}{}       % \xmlline|...| 
    15 \newmint[cmd]{console}{}       % \cmd|...| 
     17\newmint[forline]{fortran}{} %% \forline|...| 
     18\newmint[xmlline]{xml    }{} %% \xmlline|...| 
     19\newmint[cmd]{    console}{} %% \cmd|...| 
    1620 
    1721%% Multi-lines 
    18 \newminted[forlines]{fortran}{}   % \begin{forlines} 
    19 \newminted[xmllines]{xml}{}       % \begin{xmllines} 
    20 \newminted[cmds]{console}{}       % \begin{cmds} 
    21 \newminted[clines]{c}{}           % \begin{clines} 
     22\newminted[forlines]{fortran}{} %% \begin{forlines} 
     23\newminted[xmllines]{xml    }{} %% \begin{xmllines} 
     24\newminted[cmds]{    console}{} %% \begin{cmds} 
     25\newminted[clines]{  c      }{} %% \begin{clines} 
    2226 
    23 %% File 
     27%% File (namelist or module) 
    2428\newmintedfile[forfile]{fortran}{} 
    25  
    26 %% Inline 
    27 \newmintinline[forcode]{fortran}{bgcolor=, fontsize=auto}   % \forcode{...} 
    28 \newmintinline[xmlcode]{xml}{    bgcolor=, fontsize=auto}   % \xmlcode{...} 
    29 \newmintinline[snippet]{console}{bgcolor=, fontsize=auto}   % \snippet{...} 
    3029 
    3130%% Namelists inclusion 
    3231\newcommand{\nlst}[1]{\forfile{../../../namelists/#1}} 
     32 

  • NEMO/branches/2020/dev_r14116_HPC-04_mcastril_Mixed_Precision_implementation_final/doc/latex/global/info_page.tex

    r14113 r14644  
     1%% ================================================================================================= 
     2%% Back cover 
     3%% ================================================================================================= 
    14 
    2 \thispagestyle{plain} 
     5%% Disclaimer 
     6%% ================================================================================================= 
    37 
    4 %% ================================================================ 
    5 %% Disclaimer 
    6 %% ================================================================ 
    78\subsubsection*{Disclaimer} 
    89 
    910Like all components of the modelling framework, 
    10 the \engine\ core engine is developed under the \href{http://www.cecill.info}{CECILL license}, 
     11the \eng\ core engine is developed under the \href{http://www.cecill.info}{CECILL license}, 
    1112which is a French adaptation of the GNU GPL (\textbf{G}eneral \textbf{P}ublic \textbf{L}icense). 
    1213Anyone may use it freely for research purposes, and is encouraged to 
    … …  
    2021The authors assume no responsibility for problems, errors, or incorrect usage of \NEMO. 
    2122 
    22 %% ================================================================ 
    2323%% External resources 
    24 %% ================================================================ 
     24%% ================================================================================================= 
     25 
    2526\subsubsection*{Other resources} 
    2627\label{resources} 
    2728 
    2829Additional information can be found on: 
     30 
    2931\begin{itemize} 
    30 \item \faWordpress\ the \href{http://www.nemo-ocean.eu}{website} of the project detailing several 
    31   associated applications and an exhaustive users bibliography 
    32 \item \faCodeFork\ the \href{http://forge.ipsl.jussieu.fr/nemo}{development platform} of 
    33   the model with the code repository for the shared reference and some main resources 
    34   (wiki, ticket system, forums, \ldots) \\ 
    35   \faGithub\ the \href{http://github.com/NEMO-ocean/NEMO-examples} 
    36   {repository of the demonstration cases} for research or training 
    37 \item \faCloudDownload\ the \href{http://zenodo.org/communities/nemo-ocean}{online archive} 
    38   delivering the publications issued by the consortium (manuals, reports, datasets, \ldots) 
    39 \item \faEnvelope\ two mailing lists: 
    40   the \href{http://listes.ipsl.fr/sympa/info/nemo-newsletter}{newsletter} for 
    41   top-down communications from the project 
    42   (announcements, calls, job opportunities, \ldots) 
    43   and the \href{http://listes.ipsl.fr/sympa/info/nemo-forge}{forge updates} 
    44   (commits, tickets and forums) 
     32   \item \faWordpress\ the \href{http://www.nemo-ocean.eu}{website} of the project detailing 
     33      several associated applications and an exhaustive users bibliography 
     34   \item \faCodeFork\ the \href{http://forge.ipsl.jussieu.fr/nemo}{development platform} of 
     35      the model with the code repository for the shared reference and some main resources 
     36      (wiki, ticket system, forums, \ldots) \\ 
     37      \faGithub\ the \href{http://github.com/NEMO-ocean/NEMO-examples} 
     38      {repository of the demonstration cases} for research or training 
     39   \item \faCloudDownload\ the \href{http://zenodo.org/communities/nemo-ocean}{online archive} 
     40      delivering the publications issued by the consortium (manuals, reports, datasets, \ldots) 
     41   \item \faEnvelope\ two mailing lists: 
     42      the \href{http://listes.ipsl.fr/sympa/info/nemo-newsletter}{newsletter} for 
     43      top-down communications from the project (announcements, calls, job opportunities, \ldots) 
     44      and the \href{http://listes.ipsl.fr/sympa/info/nemo-forge}{forge updates} 
     45      (commits, tickets and forums) 
    4546\end{itemize} 
    4647 
    47 %% ================================================================ 
    4848%% Citation 
    49 %% ================================================================ 
     49%% ================================================================================================= 
     50 
    5051\subsubsection*{Citation} 
    5152 
    … …  
    5556 
    5657\begin{sloppypar} 
    57   ``{\bfseries \heading}\ifdef{\subheading}{ -- \subheading}{}'', 
    58   {\em Scientific Notes of Climate Modelling Center}, \textbf{\ipslnum} --- ISSN 1288-1619, 
    59   Institut Pierre-Simon Laplace (IPSL), 
    60   \href{https://doi.org/10.5281/zenodo.\zid}{doi:10.5281/zenodo.\zid} 
     58   ``{\bfseries \hdg}\ifdef{\shdg}{ -- \shdg}{}'', 
     59   {\em Scientific Notes of Climate Modelling Center}, \textbf{\ipsl} --- ISSN 1288-1619, 
     60   Institut Pierre-Simon Laplace (IPSL), 
     61   \href{https://doi.org/10.5281/zenodo.\zid}{doi:10.5281/zenodo.\zid} 
    6162\end{sloppypar} 
    6263 
    6364\begin{figure}[b] 
    64   \begin{minipage}[c]{0.7\textwidth} 
    65     \small 
    66     \ttfamily{ 
    67       Scientific Notes of Climate Modelling Center \\ 
    68       ISSN 1288-1619                               \\ 
    69       Institut Pierre-Simon Laplace (IPSL) 
    70     } 
    71   \end{minipage} 
    72   \hfill 
    73   \begin{minipage}[c]{0.25\textwidth} 
    74     \href{http://www.cmc.ipsl.fr}{\includegraphics[width=\textwidth]{logos/IPSL_master}} 
    75   \end{minipage} 
     65 
     66   \begin{minipage}[c]{0.7\textwidth} 
     67      \small 
     68      \ttfamily{ 
     69         Scientific Notes of Climate Modelling Center \\ 
     70         ISSN 1288-1619                               \\ 
     71         Institut Pierre-Simon Laplace (IPSL) 
     72      } 
     73   \end{minipage} 
     74   \hfill %% Don't insert void line between `minipage` envs 
     75   \begin{minipage}[c]{0.25\textwidth} 
     76      \href{http://www.cmc.ipsl.fr}{\includegraphics[width=\textwidth]{IPSL_master}} 
     77   \end{minipage} 
     78 
    7679\end{figure} 

  • NEMO/branches/2020/dev_r14116_HPC-04_mcastril_Mixed_Precision_implementation_final/doc/latex/global/latexmk.pl

    r14113 r14644  
     1## Defaults 
     2#$silent   = 1; 
     3$pdf_mode = 5; 
    14 
    2 ## Defaults 
    3 $do_cd    = 1;   ## Change to the directory of the main source file 
    4 $silent   = 1;   ## Less verbosity 
     5## Using relative paths 
     6$ENV{'openout_any'} = 'a'       ; 
     7$do_cd              = 1         ; 
     8$out_dir            = '../build'; 
    59 
    6 ## Use of 'build' relative directory 
    7 $ENV{'openout_any'}='a'; 
    8 $out_dir = '../build'; 
    9  
    10 ## Global option 
    11 set_tex_cmds( '-shell-escape' ); 
    12  
    13 $makeindex = "makeindex %O -s ../../global/index -o $out_dir/%D $out_dir/%S"; 
     10## Custom cmds 
     11set_tex_cmds('-shell-escape -file-line-error -interaction=nonstopmode'); 
     12#set_tex_cmds('-shell-escape -file-line-error'); 
     13$makeindex = 'makeindex %O -s %R.ist -o %D %S'; 
     14## %D: Destination file (.ind for index) 
     15## %O: Options 
     16## %R: Root filename (${model}_manual) 
     17## %S: Source file      (.idx for index) 

  • NEMO/branches/2020/dev_r14116_HPC-04_mcastril_Mixed_Precision_implementation_final/doc/latex/global/new_cmds.tex

    r14113 r14644  
    1 %% Global custom commands: \newcommand{<name>}[<args>][<first argument value>]{<code>} 
    2 %% ============================================================================== 
     1%% ================================================================================================= 
     2%% Global custom commands 
     3%% ================================================================================================= 
    34 
    4 %% Same slanted font for NEMO and its core engines 
    5 \newcommand{\NEMO  }{\textsl{NEMO}} 
    6 \newcommand{\OPA   }{\textsl{OPA}} 
    7 \newcommand{\SIcube}{\textsl{SI$^3$}} 
    8 \newcommand{\TOP   }{\textsl{TOP}} 
    9 \newcommand{\PISCES}{\textsl{PISCES}} 
     5%% \newcommand{<name>}[<args>][<first argument value>]{<code>} 
     6 
     7%% Same font for NEMO and its core engines 
     8\newcommand{\NEMO   }{\textsl{NEMO}} 
     9\newcommand{\OPA    }{\textsl{OPA}} 
     10\newcommand{\SIcube }{\textsl{SI$^3$}} 
     11\newcommand{\TOP    }{\textsl{TOP}} 
     12\newcommand{\PISCES }{\textsl{PISCES}} 
    1013\newcommand{\NEMOVAR}{\textsl{NEMOVAR}} 
    1114 
    12 %% Links for external components 
    13 \newcommand{\AGRIF}{\href{http://agrif.imag.fr}{AGRIF}} 
     15%% URL links for consortium institutes and external components 
     16\newcommand{\CMCC }{\href{http://www.cmcc.it}          } 
     17\newcommand{\CNRS }{\href{http://www.cnrs.fr}          } 
     18\newcommand{\MOI  }{\href{http://www.mercator-ocean.fr}} 
     19\newcommand{\UKMO }{\href{http://www.metoffice.gov.uk} } 
     20\newcommand{\NERC }{\href{http://nerc.ukri.org}        } 
     21\newcommand{\AGRIF}{\href{http://agrif.imag.fr                  }{AGRIF}} 
     22\newcommand{\BFM  }{\href{http://bfm-community.eu               }{BFM}} 
    1423\newcommand{\CICE }{\href{http://github.com/CICE-Consortium/CICE}{CICE}} 
    15 \newcommand{\OASIS}{\href{http://portal.enes.org/oasis}{OASIS}} 
    16 \newcommand{\XIOS }{\href{http://forge.ipsl.jussieu.fr/ioserver}{XIOS}} 
     24\newcommand{\OASIS}{\href{http://portal.enes.org/oasis          }{OASIS}} 
     25\newcommand{\XIOS }{\href{http://forge.ipsl.jussieu.fr/ioserver }{XIOS}} 
    1726 
    1827%% Fortran in small capitals 
    … …  
    2231%% Common aliases 
    2332\renewcommand{\deg}[1][]{\ensuremath{^{\circ}#1}} 
     33\newcommand{\eg    }{\ensuremath{e.g.}} 
     34\newcommand{\ie    }{\ensuremath{i.e.}} 
    2435\newcommand{\zstar }{\ensuremath{z^\star}} 
    2536\newcommand{\sstar }{\ensuremath{s^\star}} 
    2637\newcommand{\ztilde}{\ensuremath{\tilde z}} 
    2738\newcommand{\stilde}{\ensuremath{\tilde s}} 
    28 \newcommand{\ie}{\ensuremath{i.e.}} 
    29 \newcommand{\eg}{\ensuremath{e.g.}} 
    30  
    31 %% Inline maths 
    32 \newcommand{\fractext}[2]{\textstyle \frac{#1}{#2}} 
    33 \newcommand{\rdt}{\Delta t} 
    3439 
    3540%% Gurvan's comments 
    3641\newcommand{\cmtgm}[1]{} 
    3742 
    38 %% Maths 
     43%% Maths: reduce equation 
     44\newcommand{\fractext}[2]{\textstyle\frac{#1}{#2}} 
    3945\newcommand{\lt}{\left} 
     46\newcommand{\pd}[2][]{\ensuremath{\frac{\partial #1}{\partial #2}}} 
     47\newcommand{\rdt}{\Delta t} 
    4048\newcommand{\rt}{\right} 
    41 \newcommand{\vect}[1]{\ensuremath{ \mathbf{#1} }} 
    42 \newcommand{\pd}[2][]{\ensuremath{\frac{\partial #1}{\partial #2}}} 
    43  
    44 %% Convert chapter/section headings to lowercase 
    45 \renewcommand{\chaptermark}[1]{\markboth{#1}{}} 
    46 \renewcommand{\sectionmark}[1]{\markright{#1}{}} 
     49\newcommand{\vect}[1][]{\ensuremath{\mathbf{#1}}} 
    4750 
    4851%% Retrieve month name 
    4952\renewcommand{\today}{ 
    50   \ifcase \month\or January\or February\or March\or 
    51                     April\or   May\or      June\or 
    52                     July\or    August\or   September\or 
    53                     October\or November\or December 
     53  \ifcase \month\or   January\or February\or    March\or    April\or 
     54                          May\or     June\or     July\or   August\or 
     55                    September\or  October\or November\or December 
    5456  \fi, \number \year 
    5557} 
    5658 
    57 %% Link to orcid profile 
    58 \newcommand{\orcid}[1]{\href{http://orcid.org/#1}{\textcolor{orcidcolor}\aiOrcidSquare}} 
     59%% Custom aliases 
     60\newcommand{\cf}{\ensuremath{C\kern-0.14em f}} 
     61\newcommand{\rML}[1][i]{\ensuremath{_{\mathrm{ML}\,#1}}} 
     62\newcommand{\rMLt}[1][i]{\tilde{r}_{\mathrm{ML}\,#1}} 
     63\newcommand{\triad}[6][]{\ensuremath{{}_{#2}^{#3}{\mathbb{#4}_{#1}}_{#5}^{\,#6}}} 
     64\newcommand{\triadd}[5]{\ensuremath{{}_{#1}^{#2}{\mathbb{#3}}_{#4}^{\,#5}}} 
     65\newcommand{\triadt}[5]{\ensuremath{{}_{#1}^{#2}{\tilde{\mathbb{#3}}}_{#4}^{\,#5}}} 
     66\newcommand{\rtriad}[2][]{\ensuremath{\triad[#1]{i}{k}{#2}{i_p}{k_p}}} 
     67\newcommand{\rtriadt}[1]{\ensuremath{\triadt{i}{k}{#1}{i_p}{k_p}}} 
    5968 
    60 %% Workaround for \listoffigures 
    61 \DeclareRobustCommand{\triad}[6][]{\ensuremath{ {}_{#2}^{#3} { \mathbb{#4}_{#1} }_{#5}^{\,#6} }} 
    62  
    63 %% New command for ToC 
    64 \newcommand{\chaptertoc}[1][Table of contents]{% 
    65   \thispagestyle{empty} 
    66   \etocsettocstyle{\addsec*{#1}}{}% 
    67   \localtableofcontents% 
     69%% New command for ToC (?) 
     70\newcommand{\chaptertoc}[1][Table of contents]{ 
     71  \etocsettocstyle{\addsec*{#1}}{} 
     72  \localtableofcontents 
    6873  \vfill 
    6974} 
     75 
     76%% ORCID links 
     77\newcommand{\orcid}[1]{\href{http://orcid.org/#1}{\textcolor{orcidclr}\aiOrcidSquare}} 

  • NEMO/branches/2020/dev_r14116_HPC-04_mcastril_Mixed_Precision_implementation_final/doc/latex/global/packages.tex

    r14113 r14644  
     1%% ================================================================================================= 
     2%% Packages 
     3%% ================================================================================================= 
    14 
    2 %% LaTeX packages in use 
    3 %% ============================================================================== 
     5%% Document class 
     6\usepackage[footsepline=0.25pt,headsepline=0.25pt]{scrlayer-scrpage} %% KOMA-script 
    47 
    5 %% 'hyperref' pkg is loaded at the end of the preamble for higher compatibility 
    6  
    7 %% KOMA-script 
    8 \usepackage[footsepline=0.25pt, headsepline=0.25pt]{scrlayer-scrpage} 
    9  
    10 %% customization (layout, header/footer styles & contents, background) 
    11 \usepackage{draftwatermark} 
    12 \usepackage[margin = 2cm]{geometry} 
    13 \usepackage[pages = some]{background}   %% 'some' for title page 
    14 \usepackage[Bjornstrup]{fncychap} 
     8%% Customisation (cover page, chapter headings and mark of draft copy) 
     9\usepackage[margin=2cm]{geometry} %% Why 2cm margin? Load geometry before background! 
     10\usepackage[pages=some]{background} %% 'some' for title page 
     11\usepackage[scale=15,color=pink]{draftwatermark} 
     12\usepackage[Bjornstrup]{fncychap} %% Chapter style 
    1513 
    1614%% Fonts 
    1715\usepackage{fontspec} 
    18 %% Issue with fontawesome pkg: path to FontAwesome.otf has to be hard-coded 
    19 \defaultfontfeatures{ 
    20     Path = /home/nicolas/.local/texlive/2020/texmf-dist/fonts/opentype/public/fontawesome/ 
    21 } 
    22 \usepackage{academicons, fontawesome, newtxtext} 
     16%% Issue with path to 'FontAwesome.otf' 
     17\defaultfontfeatures{Path=/usr/local/texlive/2020/texmf-dist/fonts/opentype/public/fontawesome/} 
     18\usepackage{academicons,fontawesome} 
    2319 
    2420%% Formatting 
    2521\usepackage[inline]{enumitem} 
    26 \usepackage{etoc, tabularx, xcolor} 
     22\usepackage{etoc,tabularx,xcolor} 
    2723 
    2824%% Graphics 
    29 \usepackage{caption, graphicx, grffile} 
     25\usepackage{caption} 
     26\graphicspath{{../../../badges/}{../figures/}{../../../logos/}} 
    3027 
    3128%% Labels 
    32 \usepackage{lastpage, natbib} 
     29\usepackage{lastpage,natbib} 
     30%\usepackage{natbib,pageslts} 
    3331 
    34 %% Mathematics 
    35 \usepackage{amsmath, amssymb, mathtools} 
     32%% Mathematics: 'amsmath' is loaded by 'mathtools' 
     33\usepackage{mathtools,amssymb} 
    3634 
    3735%% Versatility 
    3836\usepackage{subfiles} 
    3937 
    40 %% Configuration 
    41 \graphicspath{ {../../../} {../figures/} } 
     38%% Source code listings 
     39\usepackage[cachedir=cache,outputdir=../build,chapter,newfloat]{minted} 
     40%% chapter? newfloat? 
     41 
     42%% Indexing and cross-referencing, loaded at the end for higher compatibility 
     43\usepackage{hyperref,imakeidx} 
    4244 
    4345%% Missing utmr8a font 
    4446\usepackage{times} 
    45  
    46 \usepackage{hyperref}   %% links 

  • NEMO/branches/2020/dev_r14116_HPC-04_mcastril_Mixed_Precision_implementation_final/doc/latex/global/styles.tex

    r14113 r14644  
    1  
     1%% ================================================================================================= 
    22%% Styles 
    3 %% ============================================================================== 
     3%% ================================================================================================= 
    44 
    55%% Colors 
    6 \setmanualcolor 
    7 \colorlet{manualcolorshaded}{manualcolor!60} 
    8 \definecolor{orcidcolor}{HTML}{A6CE39} 
     6\definecolor{orcidclr}{HTML}{A6CE39} 
     7\definecolor{manclr}{cmyk}{\clr} %% \clr defined for each manual from local settings.tex 
     8\colorlet{manclrshd}{manclr!60} %% Derived color for chapter heading, see below 
     9 
     10%% Cover page 
     11\backgroundsetup{ 
     12   firstpage=true,scale=1,angle=0,opacity=1, 
     13   contents ={ 
     14      \begin{tikzpicture}[remember picture,overlay] 
     15         \path[fill=manclr] (-0.5\paperwidth,7) rectangle (0.5\paperwidth,10); 
     16      \end{tikzpicture} 
     17    } 
     18} 
    919 
    1020%% Page layout 
    11 \pagestyle{scrheadings} 
     21%\pagestyle{scrheadings} 
     22%\renewcommand{\chapterpagestyle}{empty} 
     23\renewcommand{\chaptermark}[1]{\markboth{ #1}{}} %% Convert mark to lowercase 
     24\renewcommand{\sectionmark}[1]{\markright{#1}{}} %%    "     ""  ""     "   
     25\ohead{} %% Clear default headings 
     26\lohead{Chap. \thechapter\  \leftmark} 
     27\rehead{Sect. \thesection\ \rightmark} 
     28\ifoot{Page \thepage\ of \pageref*{LastPage}} 
     29%\ifoot[\pagemark]{Page \thepage\ of \lastpageref*{pagesLTS.arabic}} 
     30\ofoot{\eng\ Reference Manual} 
    1231\addtokomafont{pagehead}{  \sffamily              } 
    1332\addtokomafont{pagefoot}{  \sffamily \footnotesize} 
    1433\addtokomafont{pagenumber}{\sffamily \slshape     } 
    15 \addtokomafont{chapter}{\color{white}} 
    16 \ohead{} \ofoot{}   %% Clear defaults 
     34%\addtokomafont{chapter}{\color{white}} 
    1735 
    18 %% Caption 
    19 \captionsetup{font = footnotesize, justification = justified} 
     36%% Cross-referencing 
     37\hypersetup{ 
     38   pdftitle=\hdg,pdfauthor=Gurvan Madec and NEMO System Team, 
     39   pdfsubject=Reference manual of NEMO modelling framework,pdfkeywords=ocean circulation modelling, 
     40   colorlinks,allcolors=manclr 
     41} 
     42\renewcommand{\appendixautorefname}{appendix}          %% `\autoref` uncapitalization 
     43\renewcommand{\equationautorefname}{equation}          %%     ""            "" 
     44\renewcommand{\figureautorefname  }{figure}            %%     ""            "" 
     45\renewcommand{\listingname        }{namelist}          %%     ""            "" 
     46\renewcommand{\listlistingname    }{List of Namelists} %%     ""            "" 
     47\renewcommand{\tableautorefname   }{table}             %%     ""            "" 
    2048 
    21 %% Footnote 
     49%% Misc. (caption and footnote) 
     50\captionsetup{font=footnotesize,justification=justified} 
    2251\renewcommand{\thefootnote}{\fnsymbol{footnote}} 
    2352 
    … …  
    2857\renewcommand{\bibpostamble}{  \end{multicols}   } 
    2958 
    30 %% Catcodes 
     59%% Catcodes (between `\makeatletter` and `\makeatother`) 
    3160\makeatletter 
    3261 
    33 %% Prevent error with tikz and namelist inclusion 
    34 \global\let\tikz@ensure@dollar@catcode=\relax 
    35  
    36 %% First page 
    37 \backgroundsetup{ 
    38   firstpage = true, 
    39   scale = 1, angle = 0, opacity = 1, 
    40   contents = { 
    41     \begin{tikzpicture}[remember picture, overlay] 
    42       \path [fill = manualcolor] (-0.5\paperwidth, 7) rectangle (0.5\paperwidth, 10); 
    43     \end{tikzpicture} 
    44   } 
     62%% Apply manual color for chap. headings (original snippets from fncychap.sty) 
     63%% !!! Let trailing percent sign to avoid space insertion 
     64\renewcommand{\DOCH}{% %% Upper box with chapter number 
     65   \settowidth{\py}{\CNoV\thechapter}% 
     66   \addtolength{\py}{-10pt}% %% Amount of space by which the number is shifted right 
     67   \fboxsep=0pt% 
     68   \colorbox{manclr}{\rule{0pt}{40pt}\parbox[b]{\textwidth}{\hfill}}% 
     69   \kern-\py\raise20pt% 
     70   \hbox{\color{manclrshd}\CNoV\thechapter}\\ 
     71} 
     72\renewcommand{\DOTI}[1]{% %% Lower box with chapter title 
     73   \nointerlineskip\raggedright% 
     74   \fboxsep=\myhi% 
     75   \vskip-1ex% 
     76   \colorbox{manclr}{\parbox[t]{\mylen}{\color{white}\CTV\FmTi{#1}}}\par\nobreak% 
     77   \vskip 40\p@% 
     78} 
     79\renewcommand{\DOTIS}[1]{% %% Box for unumbered chapter 
     80   \fboxsep=0pt% 
     81   \colorbox{manclr}{\rule{0pt}{40pt}\parbox[b]{\textwidth}{\hfill}}\\ 
     82   \nointerlineskip\raggedright% 
     83   \fboxsep=\myhi% 
     84   \vskip-1ex% %% Remove white 1pt line 
     85   \colorbox{manclr}{\parbox[t]{\mylen}{\color{white}\CTV\FmTi{#1}}}\par\nobreak% 
     86   \vskip 40\p@% 
    4587} 
    4688 
    47 %% Apply engine color for chapter headings: tweaking snippets from fncychap.sty 
    48 \renewcommand{\DOCH}{% 
    49   \settowidth{\py}{\CNoV\thechapter} 
    50   \addtolength{\py}{-10pt}      % Amount of space by which the 
    51 %                                  % number is shifted right 
    52   \fboxsep=0pt% 
    53   \colorbox{manualcolor}{\rule{0pt}{40pt}\parbox[b]{\textwidth}{\hfill}}% 
    54   \kern-\py\raise20pt% 
    55   \hbox{\color{manualcolorshaded}\CNoV\thechapter}\\% 
    56 } 
    57 \renewcommand{\DOTI}[1]{% 
    58   \nointerlineskip\raggedright% 
    59   \fboxsep=\myhi% 
    60   \vskip-1ex% 
    61   \colorbox{manualcolor}{\parbox[t]{\mylen}{\color{white}\CTV\FmTi{#1}}}\par\nobreak% 
    62   \vskip 40\p@% 
    63 } 
    64 \renewcommand{\DOTIS}[1]{% 
    65   \fboxsep=0pt 
    66   \colorbox{manualcolor}{\rule{0pt}{40pt}\parbox[b]{\textwidth}{\hfill}}\\% 
    67   \nointerlineskip\raggedright% 
    68   \fboxsep=\myhi% 
    69   \vskip-1ex% Remove white 1pt line 
    70   \colorbox{manualcolor}{\parbox[t]{\mylen}{\color{white}\CTV\FmTi{#1}}}\par\nobreak% 
    71   \vskip 40\p@% 
    72 } 
    73  
    74 %% Temporary fix 
    75 \def\set@curr@file#1{% 
    76   \begingroup 
    77     \escapechar\m@ne 
    78     \xdef\@curr@file{\expandafter\string\csname #1\endcsname}% 
    79   \endgroup 
    80 } 
    81 \def\quote@name#1{"\quote@@name#1\@gobble""} 
    82 \def\quote@@name#1"{#1\quote@@name} 
    83 \def\unquote@name#1{\quote@@name#1\@gobble"} 
    84  
    8589\makeatother 

  • NEMO/branches/2020/dev_r14116_HPC-04_mcastril_Mixed_Precision_implementation_final/doc/latex/global/todonotes.tex

    r11187 r14644  
    1 \usepackage[]{todonotes} 
     1%% ================================================================================================= 
     2%% Notes 
     3%% ================================================================================================= 
     4 
     5\usepackage{todonotes} 
    26 
    37\newcounter{ubcomment} 
    4 \newcommand{\ubcomment}[2][]{% 
    5 \refstepcounter{ubcomment}% 
    6 {% 
    7 \todo[linecolor=black,backgroundcolor={green!40!},size=\footnotesize]{% 
    8 \textbf{Fixme: UB [\uppercase{#1}\theubcomment]:}~#2}% 
    9 }} 
    10 \newcommand{\ubcommentinline}[2][]{% 
    11 \refstepcounter{ubcomment}% 
    12 {% 
    13 \todo[linecolor=black,inline,backgroundcolor={green!40!},size=\footnotesize]{% 
    14 \textbf{Fixme: UB [\uppercase{#1}\theubcomment]:}~#2}% 
     8 
     9\newcommand{\ubcomment         }[2][]{ 
     10\refstepcounter{ubcomment} 
     11{ 
     12\todo[linecolor=black,       backgroundcolor={green!40!},size=\footnotesize ]{ 
     13\textbf{Fixme: UB [\uppercase{#1}\theubcomment]:}~#2} 
    1514}} 
    1615 
    17 \newcommand{\ubcommentmultiline}[2]{% 
    18 \refstepcounter{ubcomment}% 
    19 {% 
    20 \todo[linecolor=black,inline,caption={\textbf{{Fixme: UB} 
    21     [\theubcomment] #1}} ,backgroundcolor={green!40!},size=\footnotesize]{% 
    22 \textbf{Fixme: UB [\theubcomment]:}~#2}% 
     16\newcommand{\ubcommentinline   }[2][]{ 
     17\refstepcounter{ubcomment} 
     18{ 
     19\todo[linecolor=black,inline,backgroundcolor={green!40!},size=\footnotesize ]{ 
     20\textbf{Fixme: UB [\uppercase{#1}\theubcomment]:}~#2} 
     21}} 
     22 
     23\newcommand{\ubcommentmultiline}[2]{ 
     24\refstepcounter{ubcomment} 
     25{ 
     26\todo[linecolor=black,inline,backgroundcolor={green!40!},size=\footnotesize, 
     27      caption={\textbf{{Fixme: UB} [\theubcomment] #1}}                     ]{ 
     28\textbf{Fixme: UB [              \theubcomment]:}~#2} 
    2329}} 
    2430 
Note: See TracChangeset for help on using the changeset viewer.