grocery-sim
  • Home
  • Theory
  • Analysis catalog
  • Exemplar analyses
  • PyPI

On this page

  • What this is
  • Install
  • Where to go from here
  • Links
  • Report an issue

grocery-sim

A structural microsimulation of a small neighborhood grocery store — with a fully known causal ground truth

What this is

grocery-sim simulates one or three years in the life of a small neighborhood grocery store — customers, an owner, a calendar of weather and macroeconomic shocks, a daily market, and a full paper trail (receipts, invoices, a ledger, a tax filing). Every number in the output is the residue of somebody choosing something: a customer choosing between two cartons of milk, an owner deciding where to open before a single customer has walked through the door, deciding later whether to hire or expand under capital he cannot afford to lose.

Nothing here is sampled from a convenient distribution and called a business. Every figure has a traceable, documented cause — which is exactly what makes it possible to grade an analysis, not just admire it.

Install

pip install grocery-sim
from grocery_sim import GroceryStoreSimulation

sim = GroceryStoreSimulation()
sim.setup({})       # the published one-year baseline, unmodified
sim.simulate()

sim.data()           # in-memory tables (receipts, invoices, ledger, ...)
sim.db()             # the same tables behind a DuckDB connection
sim.erd()            # a Mermaid ER diagram of this run's schema
sim.describe()       # a business-case brief: a fictional owner narrating
                      # this run's real events and results

Where to go from here

  • Theory — the intuition behind the construction: why the world is split into decisions and scripts, and why that split is what lets a counterfactual be exactly true instead of merely estimated.
  • Analysis catalog — the layered set of questions this data is built to answer, from cleaning the paperwork through structural, causal, and predictive modeling.
  • Exemplar analyses — worked examples on real generated arms, added over time.

Links

  • PyPI package
  • Source repository
  • The theoretical paper (PDF)
  • Report an issue