GeoSC Documentation

GeoSC is an end-to-end Python toolkit and installed CLI for planning, running, and interpreting geo-level marketing lift tests with synthetic-control methods. It supports data-driven market selection, power analysis, lift estimation, diagnostics, plots, and reporting from one reproducible workflow.

This docs tree is organised according to the Diataxis framework.

Choose Your Install Path

• Start with Quick Start if you want the supported install paths and a first CLI run.
• Use the installed geosc CLI as the primary operational interface.
• Use repo-local example assets such as data-config/ only when you are working from a source checkout.
• For maintainer release and artifact-building workflow, see the repository RELEASE.md.

Tutorials

Learning-oriented. Start here for the supported install modes, packaged vs source-checkout usage, and a first CLI run.

How-To Guides

Task-oriented. Step-by-step guides for achieving specific goals:

• Run the End-to-End Pipeline
• Evaluate Donor Quality
• Use Shapemaps
• Run Power Analysis
• Run Causal Inference
• Use the Python API

Reference

Information-oriented. Technical descriptions of the machinery and how to operate it:

• CLI Reference
• Python API Reference
• Configuration YAML Reference
• Vendored Code Policy (SparseSC)

Explanation & Methodology

Understanding-oriented. Deep dives into the mathematics, statistics, and methodology:

• Interpreting Results
• Mathematical Formalism of Synthetic Controls (Methodology)
• Methodology & Advanced Topics
• Comparison to Other Methods
• Frequently Asked Questions (FAQ)