CausalPy 0.7.0__tar.gz → 0.8.1__tar.gz

{causalpy-0.7.0 → causalpy-0.8.1}/CausalPy.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: CausalPy
-Version: 0.7.0
+Version: 0.8.1
 Summary: Causal inference for quasi-experiments in Python
 Author-email: Ben Vincent <ben.vincent@pymc-labs.com>
 License:                                  Apache License
@@ -219,6 +219,7 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Topic :: Scientific/Engineering :: Mathematics
 Requires-Python: >=3.11
 Description-Content-Type: text/markdown
@@ -227,11 +228,11 @@ Requires-Dist: arviz>=0.14.0
 Requires-Dist: graphviz
 Requires-Dist: ipython!=8.7.0
 Requires-Dist: matplotlib>=3.5.3
-Requires-Dist: numpy
+Requires-Dist: numpy<2.4
 Requires-Dist: pandas
 Requires-Dist: patsy
-Requires-Dist: pymc>=5.15.1
-Requires-Dist: pymc-marketing>=0.13.1
+Requires-Dist: pymc<6,>=5.15.1
+Requires-Dist: pytensor<3,>=2.38.1
 Requires-Dist: scikit-learn>=1
 Requires-Dist: scipy
 Requires-Dist: seaborn>=0.11.2
@@ -247,6 +248,7 @@ Requires-Dist: nbformat; extra == "dev"
 Requires-Dist: nbconvert; extra == "dev"
 Provides-Extra: docs
 Requires-Dist: ipykernel; extra == "docs"
+Requires-Dist: pymc-marketing>=0.13.1; extra == "docs"
 Requires-Dist: daft-pgm; extra == "docs"
 Requires-Dist: linkify-it-py; extra == "docs"
 Requires-Dist: myst-nb<=1.0.0; extra == "docs"
@@ -258,6 +260,7 @@ Requires-Dist: sphinx_autodoc_defaultargs; extra == "docs"
 Requires-Dist: labs-sphinx-theme; extra == "docs"
 Requires-Dist: sphinx-copybutton; extra == "docs"
 Requires-Dist: sphinx-rtd-theme; extra == "docs"
+Requires-Dist: sphinx-sitemap; extra == "docs"
 Requires-Dist: statsmodels; extra == "docs"
 Requires-Dist: sphinxcontrib-bibtex; extra == "docs"
 Requires-Dist: sphinx-notfound-page; extra == "docs"
@@ -275,6 +278,7 @@ Requires-Dist: pytest-cov; extra == "test"
 Requires-Dist: codespell; extra == "test"
 Requires-Dist: nbformat; extra == "test"
 Requires-Dist: nbconvert; extra == "test"
+Requires-Dist: papermill; extra == "test"
 Dynamic: license-file
 
 <div align="center">
@@ -289,7 +293,7 @@ Dynamic: license-file
 ![GitHub Repo stars](https://img.shields.io/github/stars/pymc-labs/causalpy?style=social)
 ![Read the Docs](https://img.shields.io/readthedocs/causalpy)
 ![PyPI - Downloads](https://img.shields.io/pypi/dm/causalpy)
-![Interrogate](docs/source/_static/interrogate_badge.svg)
+![Interrogate](https://raw.githubusercontent.com/pymc-labs/CausalPy/interrogate-badges/interrogate_badge.svg)
 [![codecov](https://codecov.io/gh/pymc-labs/CausalPy/branch/main/graph/badge.svg?token=FDKNAY5CZ9)](https://codecov.io/gh/pymc-labs/CausalPy)
 
 # CausalPy
@@ -303,6 +307,8 @@ To get the latest release:
 pip install CausalPy
 ```
 
+If you run into installation issues with PyMC (e.g. BLAS or compilation), try the conda install: `conda install -c conda-forge causalpy`.
+
 Alternatively, if you want the very latest version of the package you can install from GitHub:
 
 ```bash
@@ -358,6 +364,7 @@ CausalPy has a broad range of quasi-experimental methods for causal inference:
 | Geographical lift | Measures the impact of an intervention in a specific geographic area by comparing it to similar areas without the intervention. Commonly used in marketing to assess regional campaigns. |
 | ANCOVA | Analysis of Covariance combines ANOVA and regression to control for the effects of one or more quantitative covariates. Used when comparing group means while controlling for other variables. |
 | Differences in Differences | Compares the changes in outcomes over time between a treatment group and a control group. Used in observational studies to estimate causal effects by accounting for time trends. |
+| Staggered Difference-in-Differences | Estimates event-time treatment effects when different units adopt treatment at different times, using an imputation approach that models untreated outcomes and compares observed outcomes to counterfactual predictions. |
 | Regression discontinuity | Identifies causal effects by exploiting a cutoff or threshold in an assignment variable. Used when treatment is assigned based on a threshold value of an observed variable, allowing comparison just above and below the cutoff. |
 | Regression kink designs | Focuses on changes in the slope (kinks) of the relationship between variables rather than jumps at cutoff points. Used to identify causal effects when treatment intensity changes at a threshold. |
 | Interrupted time series | Analyzes the effect of an intervention by comparing time series data before and after the intervention. Used when data is collected over time and an intervention occurs at a known point, allowing assessment of changes in level or trend. |
@@ -370,6 +377,16 @@ CausalPy has a broad range of quasi-experimental methods for causal inference:
 
 ---
 
+## Getting Help
+
+Have questions about using CausalPy? We're here to help!
+
+- **Questions & Help**: Visit our [GitHub Discussions Q&A](https://github.com/pymc-labs/CausalPy/discussions/categories/q-a) to ask questions and get help from the community
+- **Bug Reports & Feature Requests**: Open an [Issue](https://github.com/pymc-labs/CausalPy/issues) for bugs or feature requests
+- **Documentation**: Check out our [documentation](https://causalpy.readthedocs.io) for detailed guides and examples
+
+Please use GitHub Discussions for general questions rather than opening issues, so we can keep the issue tracker focused on bugs and enhancements.
+
 ## Support
 
 <img src="https://raw.githubusercontent.com/pymc-labs/CausalPy/main/docs/source/_static/pymc-labs-log.png" align="right" width="50%" />

{causalpy-0.7.0 → causalpy-0.8.1}/CausalPy.egg-info/SOURCES.txt

@@ -13,6 +13,7 @@ causalpy/plot_utils.py
 causalpy/pymc_models.py
 causalpy/reporting.py
 causalpy/skl_models.py
+causalpy/transforms.py
 causalpy/utils.py
 causalpy/variable_selection_priors.py
 causalpy/version.py
@@ -39,14 +40,19 @@ causalpy/data/regression_discontinuity.csv
 causalpy/data/schoolingReturns.csv
 causalpy/data/simulate_data.py
 causalpy/data/synthetic_control.csv
+causalpy/data/zipcodes_data.csv
 causalpy/experiments/__init__.py
 causalpy/experiments/base.py
 causalpy/experiments/diff_in_diff.py
 causalpy/experiments/instrumental_variable.py
 causalpy/experiments/interrupted_time_series.py
 causalpy/experiments/inverse_propensity_weighting.py
+causalpy/experiments/piecewise_its.py
 causalpy/experiments/prepostnegd.py
 causalpy/experiments/regression_discontinuity.py
 causalpy/experiments/regression_kink.py
 causalpy/experiments/staggered_did.py
-causalpy/experiments/synthetic_control.py
+causalpy/experiments/synthetic_control.py
+scripts/validate_notebooks.py
+scripts/run_notebooks/injected.py
+scripts/run_notebooks/runner.py

{causalpy-0.7.0 → causalpy-0.8.1}/CausalPy.egg-info/requires.txt

@@ -2,11 +2,11 @@ arviz>=0.14.0
 graphviz
 ipython!=8.7.0
 matplotlib>=3.5.3
-numpy
+numpy<2.4
 pandas
 patsy
-pymc>=5.15.1
-pymc-marketing>=0.13.1
+pymc<6,>=5.15.1
+pytensor<3,>=2.38.1
 scikit-learn>=1
 scipy
 seaborn>=0.11.2
@@ -24,6 +24,7 @@ nbconvert
 
 [docs]
 ipykernel
+pymc-marketing>=0.13.1
 daft-pgm
 linkify-it-py
 myst-nb<=1.0.0
@@ -35,6 +36,7 @@ sphinx_autodoc_defaultargs
 labs-sphinx-theme
 sphinx-copybutton
 sphinx-rtd-theme
+sphinx-sitemap
 statsmodels
 sphinxcontrib-bibtex
 sphinx-notfound-page
@@ -54,3 +56,4 @@ pytest-cov
 codespell
 nbformat
 nbconvert
+papermill

{causalpy-0.7.0 → causalpy-0.8.1}/CausalPy.egg-info/top_level.txt

@@ -1,2 +1,3 @@
 causalpy
 dist
+scripts

{causalpy-0.7.0 → causalpy-0.8.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: CausalPy
-Version: 0.7.0
+Version: 0.8.1
 Summary: Causal inference for quasi-experiments in Python
 Author-email: Ben Vincent <ben.vincent@pymc-labs.com>
 License:                                  Apache License
@@ -219,6 +219,7 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Topic :: Scientific/Engineering :: Mathematics
 Requires-Python: >=3.11
 Description-Content-Type: text/markdown
@@ -227,11 +228,11 @@ Requires-Dist: arviz>=0.14.0
 Requires-Dist: graphviz
 Requires-Dist: ipython!=8.7.0
 Requires-Dist: matplotlib>=3.5.3
-Requires-Dist: numpy
+Requires-Dist: numpy<2.4
 Requires-Dist: pandas
 Requires-Dist: patsy
-Requires-Dist: pymc>=5.15.1
-Requires-Dist: pymc-marketing>=0.13.1
+Requires-Dist: pymc<6,>=5.15.1
+Requires-Dist: pytensor<3,>=2.38.1
 Requires-Dist: scikit-learn>=1
 Requires-Dist: scipy
 Requires-Dist: seaborn>=0.11.2
@@ -247,6 +248,7 @@ Requires-Dist: nbformat; extra == "dev"
 Requires-Dist: nbconvert; extra == "dev"
 Provides-Extra: docs
 Requires-Dist: ipykernel; extra == "docs"
+Requires-Dist: pymc-marketing>=0.13.1; extra == "docs"
 Requires-Dist: daft-pgm; extra == "docs"
 Requires-Dist: linkify-it-py; extra == "docs"
 Requires-Dist: myst-nb<=1.0.0; extra == "docs"
@@ -258,6 +260,7 @@ Requires-Dist: sphinx_autodoc_defaultargs; extra == "docs"
 Requires-Dist: labs-sphinx-theme; extra == "docs"
 Requires-Dist: sphinx-copybutton; extra == "docs"
 Requires-Dist: sphinx-rtd-theme; extra == "docs"
+Requires-Dist: sphinx-sitemap; extra == "docs"
 Requires-Dist: statsmodels; extra == "docs"
 Requires-Dist: sphinxcontrib-bibtex; extra == "docs"
 Requires-Dist: sphinx-notfound-page; extra == "docs"
@@ -275,6 +278,7 @@ Requires-Dist: pytest-cov; extra == "test"
 Requires-Dist: codespell; extra == "test"
 Requires-Dist: nbformat; extra == "test"
 Requires-Dist: nbconvert; extra == "test"
+Requires-Dist: papermill; extra == "test"
 Dynamic: license-file
 
 <div align="center">
@@ -289,7 +293,7 @@ Dynamic: license-file
 ![GitHub Repo stars](https://img.shields.io/github/stars/pymc-labs/causalpy?style=social)
 ![Read the Docs](https://img.shields.io/readthedocs/causalpy)
 ![PyPI - Downloads](https://img.shields.io/pypi/dm/causalpy)
-![Interrogate](docs/source/_static/interrogate_badge.svg)
+![Interrogate](https://raw.githubusercontent.com/pymc-labs/CausalPy/interrogate-badges/interrogate_badge.svg)
 [![codecov](https://codecov.io/gh/pymc-labs/CausalPy/branch/main/graph/badge.svg?token=FDKNAY5CZ9)](https://codecov.io/gh/pymc-labs/CausalPy)
 
 # CausalPy
@@ -303,6 +307,8 @@ To get the latest release:
 pip install CausalPy
 ```
 
+If you run into installation issues with PyMC (e.g. BLAS or compilation), try the conda install: `conda install -c conda-forge causalpy`.
+
 Alternatively, if you want the very latest version of the package you can install from GitHub:
 
 ```bash
@@ -358,6 +364,7 @@ CausalPy has a broad range of quasi-experimental methods for causal inference:
 | Geographical lift | Measures the impact of an intervention in a specific geographic area by comparing it to similar areas without the intervention. Commonly used in marketing to assess regional campaigns. |
 | ANCOVA | Analysis of Covariance combines ANOVA and regression to control for the effects of one or more quantitative covariates. Used when comparing group means while controlling for other variables. |
 | Differences in Differences | Compares the changes in outcomes over time between a treatment group and a control group. Used in observational studies to estimate causal effects by accounting for time trends. |
+| Staggered Difference-in-Differences | Estimates event-time treatment effects when different units adopt treatment at different times, using an imputation approach that models untreated outcomes and compares observed outcomes to counterfactual predictions. |
 | Regression discontinuity | Identifies causal effects by exploiting a cutoff or threshold in an assignment variable. Used when treatment is assigned based on a threshold value of an observed variable, allowing comparison just above and below the cutoff. |
 | Regression kink designs | Focuses on changes in the slope (kinks) of the relationship between variables rather than jumps at cutoff points. Used to identify causal effects when treatment intensity changes at a threshold. |
 | Interrupted time series | Analyzes the effect of an intervention by comparing time series data before and after the intervention. Used when data is collected over time and an intervention occurs at a known point, allowing assessment of changes in level or trend. |
@@ -370,6 +377,16 @@ CausalPy has a broad range of quasi-experimental methods for causal inference:
 
 ---
 
+## Getting Help
+
+Have questions about using CausalPy? We're here to help!
+
+- **Questions & Help**: Visit our [GitHub Discussions Q&A](https://github.com/pymc-labs/CausalPy/discussions/categories/q-a) to ask questions and get help from the community
+- **Bug Reports & Feature Requests**: Open an [Issue](https://github.com/pymc-labs/CausalPy/issues) for bugs or feature requests
+- **Documentation**: Check out our [documentation](https://causalpy.readthedocs.io) for detailed guides and examples
+
+Please use GitHub Discussions for general questions rather than opening issues, so we can keep the issue tracker focused on bugs and enhancements.
+
 ## Support
 
 <img src="https://raw.githubusercontent.com/pymc-labs/CausalPy/main/docs/source/_static/pymc-labs-log.png" align="right" width="50%" />

{causalpy-0.7.0 → causalpy-0.8.1}/README.md

@@ -10,7 +10,7 @@
 ![GitHub Repo stars](https://img.shields.io/github/stars/pymc-labs/causalpy?style=social)
 ![Read the Docs](https://img.shields.io/readthedocs/causalpy)
 ![PyPI - Downloads](https://img.shields.io/pypi/dm/causalpy)
-![Interrogate](docs/source/_static/interrogate_badge.svg)
+![Interrogate](https://raw.githubusercontent.com/pymc-labs/CausalPy/interrogate-badges/interrogate_badge.svg)
 [![codecov](https://codecov.io/gh/pymc-labs/CausalPy/branch/main/graph/badge.svg?token=FDKNAY5CZ9)](https://codecov.io/gh/pymc-labs/CausalPy)
 
 # CausalPy
@@ -24,6 +24,8 @@ To get the latest release:
 pip install CausalPy
 ```
 
+If you run into installation issues with PyMC (e.g. BLAS or compilation), try the conda install: `conda install -c conda-forge causalpy`.
+
 Alternatively, if you want the very latest version of the package you can install from GitHub:
 
 ```bash
@@ -79,6 +81,7 @@ CausalPy has a broad range of quasi-experimental methods for causal inference:
 | Geographical lift | Measures the impact of an intervention in a specific geographic area by comparing it to similar areas without the intervention. Commonly used in marketing to assess regional campaigns. |
 | ANCOVA | Analysis of Covariance combines ANOVA and regression to control for the effects of one or more quantitative covariates. Used when comparing group means while controlling for other variables. |
 | Differences in Differences | Compares the changes in outcomes over time between a treatment group and a control group. Used in observational studies to estimate causal effects by accounting for time trends. |
+| Staggered Difference-in-Differences | Estimates event-time treatment effects when different units adopt treatment at different times, using an imputation approach that models untreated outcomes and compares observed outcomes to counterfactual predictions. |
 | Regression discontinuity | Identifies causal effects by exploiting a cutoff or threshold in an assignment variable. Used when treatment is assigned based on a threshold value of an observed variable, allowing comparison just above and below the cutoff. |
 | Regression kink designs | Focuses on changes in the slope (kinks) of the relationship between variables rather than jumps at cutoff points. Used to identify causal effects when treatment intensity changes at a threshold. |
 | Interrupted time series | Analyzes the effect of an intervention by comparing time series data before and after the intervention. Used when data is collected over time and an intervention occurs at a known point, allowing assessment of changes in level or trend. |
@@ -91,6 +94,16 @@ CausalPy has a broad range of quasi-experimental methods for causal inference:
 
 ---
 
+## Getting Help
+
+Have questions about using CausalPy? We're here to help!
+
+- **Questions & Help**: Visit our [GitHub Discussions Q&A](https://github.com/pymc-labs/CausalPy/discussions/categories/q-a) to ask questions and get help from the community
+- **Bug Reports & Feature Requests**: Open an [Issue](https://github.com/pymc-labs/CausalPy/issues) for bugs or feature requests
+- **Documentation**: Check out our [documentation](https://causalpy.readthedocs.io) for detailed guides and examples
+
+Please use GitHub Discussions for general questions rather than opening issues, so we can keep the issue tracker focused on bugs and enhancements.
+
 ## Support
 
 <img src="https://raw.githubusercontent.com/pymc-labs/CausalPy/main/docs/source/_static/pymc-labs-log.png" align="right" width="50%" />

{causalpy-0.7.0 → causalpy-0.8.1}/causalpy/__init__.py

@@ -16,6 +16,7 @@ import causalpy.pymc_models as pymc_models
 import causalpy.skl_models as skl_models
 import causalpy.variable_selection_priors as variable_selection_priors
 from causalpy.skl_models import create_causalpy_compatible_class
+from causalpy.transforms import ramp, step
 from causalpy.version import __version__
 
 from .data import load_data
@@ -23,26 +24,33 @@ from .experiments.diff_in_diff import DifferenceInDifferences
 from .experiments.instrumental_variable import InstrumentalVariable
 from .experiments.interrupted_time_series import InterruptedTimeSeries
 from .experiments.inverse_propensity_weighting import InversePropensityWeighting
+from .experiments.piecewise_its import PiecewiseITS
 from .experiments.prepostnegd import PrePostNEGD
 from .experiments.regression_discontinuity import RegressionDiscontinuity
 from .experiments.regression_kink import RegressionKink
 from .experiments.staggered_did import StaggeredDifferenceInDifferences
 from .experiments.synthetic_control import SyntheticControl
+from .utils import extract_lift_for_mmm, plot_correlations
 
 __all__ = [
     "__version__",
-    "DifferenceInDifferences",
     "create_causalpy_compatible_class",
+    "DifferenceInDifferences",
+    "extract_lift_for_mmm",
+    "plot_correlations",
     "InstrumentalVariable",
     "InterruptedTimeSeries",
     "InversePropensityWeighting",
     "load_data",
+    "PiecewiseITS",
     "PrePostNEGD",
     "pymc_models",
+    "ramp",
     "RegressionDiscontinuity",
     "RegressionKink",
     "skl_models",
     "StaggeredDifferenceInDifferences",
+    "step",
     "SyntheticControl",
     "variable_selection_priors",
 ]

{causalpy-0.7.0 → causalpy-0.8.1}/causalpy/custom_exceptions.py

@@ -21,6 +21,7 @@ class BadIndexException(Exception):
     index and an event, typically a treatment or intervention."""
 
     def __init__(self, message: str):
+        super().__init__(message)
         self.message = message
 
 
@@ -29,6 +30,7 @@ class FormulaException(Exception):
     formula"""
 
     def __init__(self, message: str):
+        super().__init__(message)
         self.message = message
 
 
@@ -36,4 +38,5 @@ class DataException(Exception):
     """Exception raised given when there is some error in user-provided dataframe"""
 
     def __init__(self, message: str):
+        super().__init__(message)
         self.message = message

{causalpy-0.7.0 → causalpy-0.8.1}/causalpy/data/datasets.py

@@ -40,6 +40,7 @@ DATASETS = {
     "pisa18": {"filename": "PISA18sampleScale.csv"},
     "nets": {"filename": "nets_df.csv"},
     "lalonde": {"filename": "lalonde.csv"},
+    "zipcodes": {"filename": "zipcodes_data.csv"},
     "nevo": {"filename": "data_nevo.csv"},
 }
 
@@ -80,6 +81,9 @@ def load_data(dataset: str) -> pd.DataFrame:
         - ``"pisa18"`` - PISA 2018 sample data
         - ``"nets"`` - National Supported Work Demonstration dataset
         - ``"lalonde"`` - LaLonde dataset for propensity score analysis
+        - ``"zipcodes"`` - Geo-experimentation zipcode data for comparative interrupted time
+          series analysis. Based on synthetic data from Juan Orduz's blog post on
+          `time-based regression for geo-experiments <https://juanitorduz.github.io/time_based_regression_pymc/>`_.
 
     Returns
     -------