aboutsummaryrefslogtreecommitdiff
path: root/reproduce/config/pipeline/LOCAL.mk.in
blob: e5a9f965dc74c3ef9f66bc8694d4a35301adf06c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
# Top-level user specific directories. Note the points below:
#
# - The VALUES to these directories are initially JUST PLACE-HOLDERS!
#   Please correct them based on your system.
#
# - The directories don't need to necessarily exist. If they do not exist,
#   they will be created and the necessary data will be downloaded into
#   them. Ofcourse provided that you have write permissions and an internet
#   connection.
#
# - Do not use the tilde expansion `~' or variables for your home
#   directory. Please use the full address, for example
#   `/home/your-user-name'.
#
# - An ending forward-slash `/' is NOT necessary. In the pipeline, all
#   these variables will be followed by a `/', so if you put a `/' at the
#   end of the value here, you will see a `//' in the printed outputs
#   during the processing. This has no technical problem, but can make
#   reading the outputs harder and is thus not recommended.





# Input data
# ----------
#
# This is where the input data (with the same file-name standard as the
# online webpage) are stored. If this directory doesn't exist, or it
# doesn't contain the files (with the correct file-name formats), it will
# be created and the images will be downloaded. See
# `reproduce/config/pipeline/web.mk', for the URLs containing the expected
# inputs for each survey.
SURVEY = reproduce/SURVEY





# Build directory
# ---------------
#
# This is where the intermediate outputs of each step are kept.
#
# Why a separate build directory? So the source and configuration files for
# this reproduction pipeline do not get crowded by all the
# intermediate/derivative files. Also to make synchronization and backups
# more easy: the contents of the build directory do not need to be backed
# up since they can be reproduced and they can be large.
BDIR = reproduce/BDIR





# Make the final PDF?
# -------------------
#
# During the testing a pipeline, it is usually not necessary to build
# the PDF file (which makes a lot of output lines on the command-line
# and can make it hard to find the commands and possible errors (and
# their outputs). Also, in some cases, only the produced results may
# be of interest and not the final PDF, so LaTeX (and its necessary
# packages) may not be installed.
#
# If this variable is given any string, a PDF will be made with
# LaTeX. Otherwise, a notice will just printed that for now, no PDF
# will be created.
BUILD-FINAL-PDF = yes