Skip to content
Snippets Groups Projects
Commit 74345e51 authored by Tomas Lovato's avatar Tomas Lovato
Browse files

specify packages needed to compile manuals and fix two minor typos

parent 426fb9cc
No related branches found
No related tags found
1 merge request!7Added key_single to coding rules
Pipeline #1399 passed with stage
in 6 minutes and 4 seconds
......@@ -6,6 +6,8 @@ This repository collects NEMO documentation manuals in LaTeX format.
- TOP interface for passive tracers
- SI3 sea ice model
To generate the manual(s) PDF it is necessary to install the [LateX](https://www.latex-project.org/) typesetting system and the python package [pygments](https://pygments.org/).
## Cloning with submodules
This repository uses the `namelists` and `gallery` documentation projects as git `submodules`.
......@@ -31,7 +33,8 @@ Probably the easiest is to go directly to the CI/CD pipeline tab (from the left
### Manual build
Regular contributors to the reference manuals are likely to maintain LaTex build environments on their local resources [ TODO: add description of LaTeX packages required to build manuals ]. The `manual_build.sh` script can be used to generate the PDF version of manual(s) in a local environment as follows:
Regular contributors to the reference manuals are likely to maintain LaTex build environments on their local resources.
The `manual_build.sh` script can be used to generate the PDF version of manual(s) in a local environment as follows:
```
./manual_build.sh [-c] [-p] [-r version ] manual_name
......
......@@ -16,7 +16,7 @@ It can be supplemented by the \textcolor{gray}{``white ocean''} for sea-ice \{th
brine inclusions and subgrid-scale thickness variations (\SIcube), and also by
the \textcolor{green}{``green ocean''} for \{on,off\}line oceanic tracers transport and
biogeochemical processes (\TOP-\PISCES).
External alternative models can be used instead of the core engines (\eg \BFM).
External alternative models can be used instead of the core engines (e.g. \BFM).
Regarding the numerics, main features include versatile data assimilation interface,
agile diagnostics generation thanks to \XIOS\ software,
ocean-atmosphere coupling via the \OASIS\ library, and
......
......@@ -91,7 +91,7 @@ fi
# Echo current font path
fontawesome=`grep defaultfontfeatures latex/global/packages.tex | sed -e 's/.*=\(.*\)}/\1/'`
echo "Fontawesome path is $fontawesome \n"
echo "Fontawesome path is $fontawesome"
# Source shared functions
. tools/shr_func.sh
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment