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_sub/chap_SBC.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_sub
Files:
1 added
1 copied

Legend:

Unmodified
Added
Removed

  • branches/2017/dev_merge_2017/DOC/tex_sub/chap_SBC.tex

    r9387 r9388  
    1111$\ $\newline    % force a new ligne 
    1212%---------------------------------------namsbc-------------------------------------------------- 
    13 \fortranfile{namelists/namsbc} 
     13\forfile{../namelists/namsbc} 
    1414%-------------------------------------------------------------------------------------------------------------- 
    1515$\ $\newline    % force a new ligne 
    … …  
    196196 
    197197The structure associated with an input variable contains the following information: 
    198 \begin{fortrancode} 
     198\begin{forlines} 
    199199!  file name  ! frequency (hours) ! variable  ! time interp. !  clim  ! 'yearly'/ ! weights  ! rotation ! land/sea mask !  
    200200!             !  (if <0  months)  !   name    !   (logical)  !  (T/F) ! 'monthly' ! filename ! pairing  ! filename      ! 
    201 \end{fortrancode} 
     201\end{forlines} 
    202202where  
    203203\begin{description}   
    … …  
    425425 
    426426%---------------------------------------namsbc_ana-------------------------------------------------- 
    427 \fortranfile{namelists/namsbc_sas} 
     427\forfile{../namelists/namsbc_sas} 
    428428%-------------------------------------------------------------------------------------------------------------- 
    429429 
    … …  
    486486 
    487487%---------------------------------------namsbc_ana-------------------------------------------------- 
    488 %\fortranfile{namelists/namsbc_ana} 
     488%\forfile{../namelists/namsbc_ana} 
    489489%-------------------------------------------------------------------------------------------------------------- 
    490490 
    … …  
    510510\label{SBC_flx} 
    511511%------------------------------------------namsbc_flx---------------------------------------------------- 
    512 \fortranfile{namelists/namsbc_flx}  
     512\forfile{../namelists/namsbc_flx}  
    513513%------------------------------------------------------------------------------------------------------------- 
    514514 
    … …  
    550550\label{SBC_blk_core} 
    551551%------------------------------------------namsbc_core---------------------------------------------------- 
    552 %\fortranfile{namelists/namsbc_core} 
     552%\forfile{../namelists/namsbc_core} 
    553553%------------------------------------------------------------------------------------------------------------- 
    554554 
    … …  
    615615\label{SBC_blk_clio} 
    616616%------------------------------------------namsbc_clio---------------------------------------------------- 
    617 %\fortranfile{namelists/namsbc_clio} 
     617%\forfile{../namelists/namsbc_clio} 
    618618%------------------------------------------------------------------------------------------------------------- 
    619619 
    … …  
    656656\label{SBC_blk_mfs} 
    657657%------------------------------------------namsbc_mfs---------------------------------------------------- 
    658 %\fortranfile{namelists/namsbc_mfs} 
     658%\forfile{../namelists/namsbc_mfs} 
    659659%---------------------------------------------------------------------------------------------------------- 
    660660 
    … …  
    695695\label{SBC_cpl} 
    696696%------------------------------------------namsbc_cpl---------------------------------------------------- 
    697 \fortranfile{namelists/namsbc_cpl}  
     697\forfile{../namelists/namsbc_cpl}  
    698698%------------------------------------------------------------------------------------------------------------- 
    699699 
    … …  
    734734\label{SBC_apr} 
    735735%------------------------------------------namsbc_apr---------------------------------------------------- 
    736 \fortranfile{namelists/namsbc_apr}  
     736\forfile{../namelists/namsbc_apr}  
    737737%------------------------------------------------------------------------------------------------------------- 
    738738 
    … …  
    770770 
    771771%------------------------------------------nam_tide--------------------------------------- 
    772 \fortranfile{namelists/nam_tide} 
     772\forfile{../namelists/nam_tide} 
    773773%----------------------------------------------------------------------------------------- 
    774774 
    … …  
    825825\label{SBC_rnf} 
    826826%------------------------------------------namsbc_rnf---------------------------------------------------- 
    827 \fortranfile{namelists/namsbc_rnf}  
     827\forfile{../namelists/namsbc_rnf}  
    828828%------------------------------------------------------------------------------------------------------------- 
    829829 
    … …  
    941941\label{SBC_isf} 
    942942%------------------------------------------namsbc_isf---------------------------------------------------- 
    943 \fortranfile{namelists/namsbc_isf} 
     943\forfile{../namelists/namsbc_isf} 
    944944%-------------------------------------------------------------------------------------------------------- 
    945945Namelist variable in \ngn{namsbc}, \np{nn\_isf}, controls the ice shelf representation used.  
    … …  
    10221022\label{SBC_iscpl} 
    10231023%------------------------------------------namsbc_iscpl---------------------------------------------------- 
    1024 \fortranfile{namelists/namsbc_iscpl} 
     1024\forfile{../namelists/namsbc_iscpl} 
    10251025%-------------------------------------------------------------------------------------------------------- 
    10261026Ice sheet/ocean coupling is done through file exchange at the restart step. NEMO, at each restart step,  
    … …  
    10601060\label{ICB_icebergs} 
    10611061%------------------------------------------namberg---------------------------------------------------- 
    1062 \fortranfile{namelists/namberg} 
     1062\forfile{../namelists/namberg} 
    10631063%------------------------------------------------------------------------------------------------------------- 
    10641064 
    … …  
    11321132\label{SBC_dcy} 
    11331133%------------------------------------------namsbc_rnf---------------------------------------------------- 
    1134 %\fortranfile{namelists/namsbc}  
     1134%\forfile{../namelists/namsbc}  
    11351135%------------------------------------------------------------------------------------------------------------- 
    11361136 
    … …  
    12091209\label{SBC_ssr} 
    12101210%------------------------------------------namsbc_ssr---------------------------------------------------- 
    1211 \fortranfile{namelists/namsbc_ssr}  
     1211\forfile{../namelists/namsbc_ssr}  
    12121212%------------------------------------------------------------------------------------------------------------- 
    12131213 
    … …  
    13291329\label{SBC_wave} 
    13301330%------------------------------------------namwave---------------------------------------------------- 
    1331 \fortranfile{namelists/namsbc_wave} 
     1331\forfile{../namelists/namsbc_wave} 
    13321332%------------------------------------------------------------------------------------------------------------- 
    13331333 
Note: See TracChangeset for help on using the changeset viewer.