Saltar a contenido

API Python — Tools del pipeline

Referencia exacta de flags, argumentos y exit codes de las tools Python del pipeline Belico. Es el complemento de la Referencia de la CLI (CLI pública FASE D) — acá viven los scripts de tools/ que orquestan adquisición, cómputo, producción y validación.

Fuente canónica

Esta página migra de docs/shared/API_REFERENCE.md. Para el contexto de uso de cada tool ver docs/shared/TOOLS.md.


Boot & Setup

boot_status.py

python tools/boot_status.py

EXIT CODES:
  0  OK
  1  Error crítico (Engram down, deps faltantes)

init_project.py

python tools/init_project.py [--name NAME] [--domain DOMAIN] [--quartile Q]

EXIT CODES:
  0  OK
  1  Error de input

setup_csl.ps1

.\tools\setup_csl.ps1 [-Verify]

OPTIONS:
  -Verify   Solo verifica, no descarga

Data Acquisition

peer_downloader.py

python tools/peer_downloader.py --rsn RSN [RSN ...] --out DIR [OPTIONS]

OPTIONS:
  --rsn RSN [...]   Record Sequence Numbers (obligatorio)
  --out DIR         Carpeta destino (obligatorio)
  --email EMAIL     Override PEER_EMAIL del .env
  --password PASS   Override PEER_PASSWORD del .env

EXAMPLE:
  python tools/peer_downloader.py --rsn 766 1158 4517 --out db/excitation/records/

fetch_domain_data.py

python tools/fetch_domain_data.py --domain DOMAIN [--source S] [--verify] [--list-sources]

EXIT CODES:
  0  OK
  1  Adapter falló / credenciales faltantes

select_ground_motions.py

python tools/select_ground_motions.py [--mw MIN MAX] [--rrup MIN MAX] [--vs30 MIN MAX] [--n N] [--out CSV]

EXAMPLE:
  python tools/select_ground_motions.py --mw 6.5 7.5 --rrup 0 50 --n 11

Compute

research_director.py

python tools/research_director.py [--config PATH] [--profile NAME] [--dry-run]

EXIT CODES:
  0  Campaña completa, convergencia OK
  1  Divergencia / error de solver

compute_statistics.py

python tools/compute_statistics.py --quartile q1|q2|q3|q4 [--alpha 0.05] [--bootstrap-n 10000] [--input DIR]

EXIT CODES:
  0  Gate 2 pass (p < alpha)
  1  No significativo (aumentar N)

generate_compute_manifest.py

python tools/generate_compute_manifest.py [--domain D] [--design-sources F1,F2,...] [--emulation] [--guardian]

EXIT CODES:
  0  all_design_sources_exist: true
  1  Faltan fuentes → IMPLEMENT bloqueado

Paper Production

plot_figures.py

python tools/plot_figures.py --domain DOMAIN [--quartile Q] [--only FIG_ID] [--format pdf,png]

EXAMPLE:
  python tools/plot_figures.py --domain structural --quartile q2

style_calibration.py

python tools/style_calibration.py --venue VENUE --paper-id ID [--year Y] [--n 5] [--save-md]

EXIT CODES:
  0  OK
  1  API error / 0 papers encontrados

generate_bibtex.py

python tools/generate_bibtex.py [--domain D] [--categories C1,C2] [--out articles/references.bib]

Validation

validate_submission.py

python tools/validate_submission.py DRAFT [--diagnose] [--suggest-trace] [--skip-ai] [--json] [--force]

EXIT CODES:
  0  Todos los gates pass
  1  Al menos un ERROR
  2  HARD BLOCK (no compilable)

verify_citations.py

python tools/verify_citations.py DRAFT [--bib PATH] [--out JSON]

EXIT CODES:
  0  Todas verified
  1  Al menos una suspect/invalid
  2  Al menos una retracted

Citation & Discovery

find_top_sources.py

python tools/find_top_sources.py --query "TEXT" [--quartile Q] [--n 20] [--min-year Y] [--exclude-retracted] [--out JSON]

EXIT CODES:
  0  ≥1 resultado
  1  0 resultados

check_novelty.py

python tools/check_novelty.py --keywords "K1, K2, K3" [--save] [--deep] [--max-results 50]

EXIT CODES:
  0  ORIGINAL
  1  INCREMENTAL
  2  DUPLICATE

literature_rag.py

python tools/literature_rag.py {search|embed|query|export} [OPTIONS]

EXAMPLES:
  python tools/literature_rag.py search --query "SHM ML" --n 100
  python tools/literature_rag.py query --q "cómo detectar grietas"
  python tools/literature_rag.py export --bibtex out.bib

Compilation

compile_paper.sh / .ps1

bash tools/compile_paper.sh DRAFT [--template ieee|elsevier|conference|plain] [--institution INST] [--force]

EXIT CODES:
  0  PDF generado
  1  validate_submission falló
  2  Pandoc/LaTeX falló

Para el catálogo completo de tools navegables ver Catálogo · Tools. El listado exhaustivo de scripts (Patent Engine, Archive, Audit, shell scripts) vive en docs/shared/API_REFERENCE.md.