18_summarize_sivacor.sh - Generate the SIVACOR Part B

Description¶

Generates a SIVACOR-based Part B of the report from a SIVACOR TRO file (*/tro/tro-*.jsonld), by calling tools/generate_sivacor_partb.sh. By default it writes generated/REPLICATION-PartB-SIVACOR.md and leaves the report alone. It does not rerun author code.

28_sivacor_partb.sh calls it during ingest. Running it by hand makes sense when that step left the generated Part B waiting in generated/ because REPLICATION-PartB.md had already been edited.

Usage¶

./automations/18_summarize_sivacor.sh [-j tro.jsonld] [-d output_dir] [-o output.md] \
    [-r report.md] [-t template.md] [--replace-report] [--dry-run]

• -j, --jsonld - TRO file (default: the first */tro/tro-*.jsonld)

• -d, --output-dir - Output directory (default: generated)

• -o, --output - Output file (default: <output_dir>/REPLICATION-PartB-SIVACOR.md)

• -r, --report - Report to replace (default: REPLICATION-PartB.md)

• -t, --template - Report template (default: REPLICATION.md)

• --replace-report - Copy the result over REPLICATION-PartB.md; if that file does not exist, replace the Part B section of REPLICATION.md

• --dry-run - Show what would be written

Environment Variables¶

• PYTHON - Python command to use (default: python3, then python).

See generate_sivacor_partb.sh and get_sivacor_info.py for what the generated Part B contains.