Skip to content

Commit 8f0596f

Browse files
authored
Add README to manuscript (#134)
Add a README.md to manuscript with descriptions of the files inside manuscript folder and instructions on how to build the PDF through Makefile.
1 parent 3a2ed40 commit 8f0596f

File tree

1 file changed

+61
-0
lines changed

1 file changed

+61
-0
lines changed

manuscript/README.md

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
# LaTeX sources for the manuscript
2+
3+
This folder contains all the files needed to build two PDF versions of the
4+
manuscript using LaTeX: one for the preprint and another one for submitting
5+
*Geophysical Journal International*.
6+
The two main LaTeX documents are:
7+
8+
- `preprint.tex`: for building the preprint
9+
- `gji.tex`: for building the manuscript using the GJI template
10+
11+
These two files only contain a header and some configurations, but the content
12+
of the article is split in separate files, which are then imported directly
13+
into `preprint.tex` and `gji.tex`.
14+
The extra files are:
15+
16+
- `abstract.tex`: contains the text for the abstract
17+
- `content.tex`: contains the body of the paper, with sections, figures,
18+
equations, etc.
19+
- `appendix.tex`: contains the appendix.
20+
- `variables.tex`: defines some variables that contain additional information
21+
like the title of the manuscript, information about the authors, keywords
22+
and more.
23+
24+
The information about the references can be found inside `references.bib`,
25+
while the bibliography styles used for the preprint and the submission
26+
manuscript are inside `apalike-doi.bst` and `gji.bst`, respectively.
27+
28+
This folder also contains the files provided by GJI to build the manuscript
29+
using their template (`gji.cls`, `gji_extra.sty` and `times.sty`).
30+
31+
The figures of the article can be found under the `figs` directory.
32+
They are automatically created by the Jupyter notebooks inside the `notebooks`
33+
folder.
34+
These notebooks also store some numerical values that we include in the
35+
manuscript as LaTeX variables defined in files under the `results` folder.
36+
They are also automatically created by the notebooks.
37+
38+
## How to build the manuscript
39+
40+
In order to build the manuscript, you need to install a LaTeX distribution and
41+
the `latexmk` tool.
42+
43+
The `Makefile` has rules for building the PDF of the manuscript.
44+
45+
To build the preprint PDF, run:
46+
47+
```
48+
make preprint
49+
```
50+
51+
To build the PDF of the submission manuscript, run:
52+
53+
```
54+
make gji
55+
```
56+
57+
You can also ask for a word and figures count using:
58+
59+
```
60+
make word-count
61+
```

0 commit comments

Comments
 (0)