The cumulative program

Each host ships a cumulative program named <HOST>_cumulative.py (for Galileo SSI, GO_0xxx_cumulative.py). It walks the volume tree and concatenates the per-volume index and geometry tables into cumulative tables that span the whole collection, writing a matching label for each. Under the hood it calls create_cumulative_indexes().

Run it after the index and geometry programs, from inside the host directory (see Installation and setup).

Synopsis

python <HOST>_cumulative.py [options] output_dir

Positional arguments

Argument	Description
`output_dir`	Directory in which to write the cumulative files. This is a dedicated cumulative volume directory (e.g. `.../GO_0xxx/GO_0999/`); its parent is taken as the volume tree to concatenate.

The path argument is expanded for environment variables.

Options

Option	Description
`--exclude VOL [VOL ...]`, `-e`	Volume IDs to skip while concatenating. Repeatable list. Default: the host’s configured exclusions (the cumulative directory itself, e.g. `GO_0999`).
`--volumes VOL [VOL ...]`, `-vv`	Concatenate only these volume IDs. Repeatable list.
`--labels`, `-l`	Generate the cumulative labels only, from existing cumulative tables.
`--pattern PATTERN`, `-p`	Glob pattern used to select files.
`--task-output FILE`, `-to`	Write a task-queue file and perform no processing. See Distributed (cloud) runs.
`-h`, `--help`	Show the help message and exit.

Example

Build the cumulative tables for Galileo SSI, then for one volume only:

cd src/metadata_tools/hosts/GO_0xxx
python GO_0xxx_cumulative.py "$RMS_METADATA_TEST/GO_0xxx/GO_0999/"
python GO_0xxx_cumulative.py "$RMS_METADATA_TEST/GO_0xxx/GO_0999/" -vv GO_0017

Results

The program writes one cumulative table per table kind into output_dir, named with the cumulative directory’s volume ID (e.g. GO_0999_supplemental_index.tab, GO_0999_body_summary.tab, GO_0999_inventory.csv), each with a matching .lbl label. Table kinds for which no per-volume tables are found are skipped.