armin/party2d
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

Make data setup entry point no-option

Browse Source
This commit is contained in:
aseimel
2026-06-15 15:02:05 +02:00
parent 7313b1a3dc
commit 9a16f3232f
4 changed files with 11 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+1 -1
View File
@@ -39,7 +39,7 @@ The setup workflow never overwrites committed files in `data/`. See `data-setup/
Run the full source-data setup workflow with: Run the full source-data setup workflow with:
```bash ```bash
bash data-setup/run_data_setup.sh --full-test bash data-setup/run_data_setup.sh
``` ```
This downloads script-accessible source files, checks required local files, rebuilds model-ready inputs locally, and writes a comparison report. Manifesto Project requires your own API key, and the Morgan OCR/transcription file can be provided on request. This downloads script-accessible source files, checks required local files, rebuilds model-ready inputs locally, and writes a comparison report. Manifesto Project requires your own API key, and the Morgan OCR/transcription file can be provided on request.
data-setup/README.md
+5 -5
View File
@@ -49,19 +49,19 @@ _local/reports/ # comparison reports
## Commands ## Commands
Run the setup script with one explicit option: Run the full source-data setup workflow with:
```bash ```bash
bash data-setup/run_data_setup.sh <option> bash data-setup/run_data_setup.sh
``` ```
Available options: Maintenance options:
- `--dry-run` — check setup scripts only. - `--dry-run` — check setup scripts only.
- `--download-only` — download script-accessible sources. - `--download-only` — download script-accessible sources.
- `--build-test` — rebuild model-ready inputs from existing local sources. - `--build-test` — rebuild model-ready inputs from existing local sources.
- `--compare` — compare regenerated inputs with committed `data/` inputs. - `--compare` — compare regenerated inputs with committed `data/` inputs.
- `--full-test` — download, rebuild, and compare locally. - no option — download, rebuild, and compare locally.
Minimal check: Minimal check:
@@ -111,7 +111,7 @@ bash data-setup/run_data_setup.sh --compare
Full local source test: Full local source test:
```bash ```bash
bash data-setup/run_data_setup.sh --full-test bash data-setup/run_data_setup.sh
``` ```
The comparison writes `_local/reports/input_comparison.md`. Replacing committed inputs, if ever needed, is a separate manual decision and is not done by these scripts. The comparison writes `_local/reports/input_comparison.md`. Replacing committed inputs, if ever needed, is a separate manual decision and is not done by these scripts.
data-setup/run_data_setup.sh
+4 -5
View File
@@ -3,23 +3,22 @@ set -euo pipefail
usage() { usage() {
cat >&2 <<'EOF' cat >&2 <<'EOF'
Usage: bash data-setup/run_data_setup.sh <option> Usage: bash data-setup/run_data_setup.sh
Options: Optional maintenance modes:
--dry-run check setup scripts only --dry-run check setup scripts only
--download-only download source files where scriptable --download-only download source files where scriptable
--build-test rebuild inputs from existing local sources --build-test rebuild inputs from existing local sources
--compare compare regenerated inputs with committed data/ --compare compare regenerated inputs with committed data/
--full-test download, rebuild, and compare locally
EOF EOF
} }
if [ "$#" -ne 1 ]; then if [ "$#" -gt 1 ]; then
usage usage
exit 1 exit 1
fi fi
MODE="$1" MODE="${1:---full-test}"
repo_root="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd -P)" repo_root="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd -P)"
cd "$repo_root" cd "$repo_root"
docs/RAW_DATA_SOURCES.md
+1 -1
View File
@@ -78,7 +78,7 @@ bash data-setup/check_raw_data.sh
After restricted/manual files are in place, run the full local rebuild and comparison test with: After restricted/manual files are in place, run the full local rebuild and comparison test with:
```bash ```bash
bash data-setup/run_data_setup.sh --full-test bash data-setup/run_data_setup.sh
``` ```
The generated files remain under `_local/generated-inputs/`. They are compared to The generated files remain under `_local/generated-inputs/`. They are compared to