Quick Start

The quickest way to see the package workflow is to run the synthetic example config.

source .venv/bin/activate
python runme.py examples/config.yaml

The example config points to examples/example_tracker.csv and writes outputs to:

output/example_geo_sales_uplift/

The example is intentionally small. It should complete and write the full artefact set, but it is not expected to be reportable because readiness is directional.

Check the config

marketbayesmeta-check-config examples/config.yaml

Run the config

marketbayesmeta-run examples/config.yaml

Review the result

Start with:

  • analysis_report.md
  • run_status.json
  • readiness.csv
  • diagnostics.csv
  • prior_diagnostics.csv
  • effect_preparation.csv
  • ppc.csv

The relevant question is not just whether the run completed. It is whether run_status.reportable is true after reviewing diagnostics, readiness, uncertainty provenance, and sensitivity outputs.