summaryrefslogtreecommitdiffhomepage
path: root/pipeline/config.sh
blob: 04c4bfd0768d677f6a85999cf64837f9ee953977 (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
# Where everything is, and where the output goes.
#
# Every path is a variable with a default, and the defaults assume the layout
# these repositories are developed in: each project cloned beside the others,
# and this one among them. Nothing here reaches outside those clones, so a
# different arrangement needs only this file changed.
#
# Override any of them in the environment:
#
#   OUT=/tmp/my-run sh pipeline/run.sh
#
# shellcheck shell=sh

# this repository
WRITERS=${WRITERS:-$(cd "$(dirname "$0")/.." && pwd)}

# the sibling repositories, by their own names. A clone puts each under its
# short name; where they sit relative to each other is the only local fact.
SIBLINGS=${SIBLINGS:-$(cd "$WRITERS/.." && pwd)}
OCDA_LIB=${OCDA_LIB:-$SIBLINGS/sisudoc-ocda-lib}
SSP_READER=${SSP_READER:-$SIBLINGS/sisudoc-ssp-reader}
DB_READER=${DB_READER:-$SIBLINGS/sisudoc-ocda-db-reader}

# the abstraction artefacts to read: a directory holding .ssp files, and for
# each of them a .ocda.db and, where there is one, a .sisupod beside it. This
# is what spine writes with --abstraction --ocda-db --pod2; see pipeline/README.
ARTEFACTS=${ARTEFACTS:-}

# where the output goes. One directory per stage, so a run can be looked at.
OUT=${OUT:-./pipeline-out}

# the tools a pdf needs. Absent, the typst stage is skipped and says so.
TYPST=${TYPST:-typst}

# how many documents to run. Empty means all of them; a number takes the first
# n, which is what to use while looking at something.
LIMIT=${LIMIT:-}