CausalPy 0.8.0__tar.gz → 0.9.0__tar.gz

{causalpy-0.8.0 → causalpy-0.9.0}/CausalPy.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: CausalPy
-Version: 0.8.0
+Version: 0.9.0
 Summary: Causal inference for quasi-experiments in Python
 Author-email: Ben Vincent <ben.vincent@pymc-labs.com>
 License:                                  Apache License
@@ -224,29 +224,34 @@ Classifier: Topic :: Scientific/Engineering :: Mathematics
 Requires-Python: >=3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: arviz>=0.14.0
+Requires-Dist: arviz<1.0,>=0.14.0
 Requires-Dist: graphviz
 Requires-Dist: ipython!=8.7.0
+Requires-Dist: jinja2
 Requires-Dist: matplotlib>=3.5.3
-Requires-Dist: numpy<2.4
+Requires-Dist: numpy
 Requires-Dist: pandas
 Requires-Dist: patsy
-Requires-Dist: pymc>=5.15.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
 Requires-Dist: statsmodels
 Requires-Dist: xarray>=v2022.11.0
 Requires-Dist: pymc-extras>=0.3.0
+Provides-Extra: forecast
+Requires-Dist: pymc-forecast[extras]<0.3,>=0.2; extra == "forecast"
 Provides-Extra: dev
-Requires-Dist: pre-commit; extra == "dev"
+Requires-Dist: prek; extra == "dev"
 Requires-Dist: twine; extra == "dev"
-Requires-Dist: interrogate; extra == "dev"
 Requires-Dist: codespell; extra == "dev"
 Requires-Dist: nbformat; extra == "dev"
 Requires-Dist: nbconvert; extra == "dev"
+Requires-Dist: PyYAML; extra == "dev"
 Provides-Extra: docs
 Requires-Dist: ipykernel; extra == "docs"
+Requires-Dist: maketables; extra == "docs"
 Requires-Dist: pymc-marketing>=0.13.1; extra == "docs"
 Requires-Dist: daft-pgm; extra == "docs"
 Requires-Dist: linkify-it-py; extra == "docs"
@@ -261,52 +266,86 @@ 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: sphinxcontrib-bibtex>=2.7.0; extra == "docs"
 Requires-Dist: sphinx-notfound-page; extra == "docs"
 Requires-Dist: ipywidgets; extra == "docs"
 Requires-Dist: sphinx-design; extra == "docs"
 Requires-Dist: sphinx-togglebutton; extra == "docs"
+Requires-Dist: nbformat; extra == "docs"
+Requires-Dist: nbconvert; extra == "docs"
+Requires-Dist: Pillow; extra == "docs"
+Requires-Dist: PyYAML; extra == "docs"
+Requires-Dist: sphinxext-rediraffe; extra == "docs"
 Provides-Extra: lint
-Requires-Dist: interrogate; extra == "lint"
-Requires-Dist: pre-commit; extra == "lint"
+Requires-Dist: prek; extra == "lint"
 Requires-Dist: ruff; extra == "lint"
 Requires-Dist: mypy; extra == "lint"
 Provides-Extra: test
 Requires-Dist: pytest; extra == "test"
 Requires-Dist: pytest-cov; extra == "test"
+Requires-Dist: diff-cover; extra == "test"
 Requires-Dist: codespell; extra == "test"
 Requires-Dist: nbformat; extra == "test"
 Requires-Dist: nbconvert; extra == "test"
 Requires-Dist: papermill; extra == "test"
+Requires-Dist: pymc-forecast[extras]<0.3,>=0.2; extra == "test"
 Dynamic: license-file
 
 <div align="center">
-  <a href="https://github.com/pymc-labs/CausalPy"><img width="60%" src="https://raw.githubusercontent.com/pymc-labs/CausalPy/main/docs/source/_static/logo.png"></a>
+  <a href="https://github.com/pymc-labs/CausalPy"><img width="40%" src="https://raw.githubusercontent.com/pymc-labs/CausalPy/main/docs/source/_static/logo.png"></a>
 </div>
 
 ----
 
+[![PyPI version](https://badge.fury.io/py/CausalPy.svg)](https://badge.fury.io/py/CausalPy)
+[![conda-forge](https://img.shields.io/conda/vn/conda-forge/causalpy.svg?color=green)](https://anaconda.org/conda-forge/causalpy)
+[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+
 ![Build Status](https://github.com/pymc-labs/CausalPy/actions/workflows/ci.yml/badge.svg?branch=main)
 [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
-[![PyPI version](https://badge.fury.io/py/CausalPy.svg)](https://badge.fury.io/py/CausalPy)
-![GitHub Repo stars](https://img.shields.io/github/stars/pymc-labs/causalpy?style=social)
+[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)
+[![codecov](https://codecov.io/gh/pymc-labs/CausalPy/branch/main/graph/badge.svg?token=FDKNAY5CZ9)](https://codecov.io/gh/pymc-labs/CausalPy)
+
+![GitHub Repo stars](https://img.shields.io/github/stars/pymc-labs/causalpy?style=flat)
 ![Read the Docs](https://img.shields.io/readthedocs/causalpy)
+[![Downloads](https://static.pepy.tech/badge/causalpy)](https://pepy.tech/project/causalpy)
 ![PyPI - Downloads](https://img.shields.io/pypi/dm/causalpy)
-![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
+<!-- docs-start -->
+
+# Causal Inference for Quasi-Experiments
+
+**Research-grade causal inference workflows** for quasi-experimental designs in Python.
+
+CausalPy helps you estimate causal effects with transparent assumptions, uncertainty-aware modeling, and reproducible outputs:
+
+- **Quasi-experimental methods:** Difference-in-differences, synthetic control, regression discontinuity, interrupted time series, instrumental variables, and more
+- **Bayesian-first estimation** via [PyMC](https://www.pymc.io/) with full uncertainty quantification, plus traditional OLS via [scikit-learn](https://scikit-learn.org)
+- **Decision-ready outputs:** Effect summaries with credible intervals (HDI), practical significance (ROPE), and publication-quality plots
 
-A Python package focussing on causal inference in quasi-experimental settings. The package allows for sophisticated Bayesian model fitting methods to be used in addition to traditional OLS.
+## 📞 [**Book a consulting call**](https://calendly.com/benjamin-vincent/causalpy)
+
+CausalPy is built and maintained by [PyMC Labs](https://www.pymc-labs.com). If your team is exploring a consulting engagement for lift testing, complex or high-stakes causal work, you can book an introductory call. _These calls are for consulting inquiries only. For technical usage questions and free community support, please use GitHub Discussions and the documentation below._
+
+## Help and documentation
+
+- Ask usage questions in [GitHub Discussions Q&A](https://github.com/pymc-labs/CausalPy/discussions/categories/q-a) so the issue tracker stays focused on bugs and enhancements.
+- Report bugs and feature requests in [Issues](https://github.com/pymc-labs/CausalPy/issues)
+- Browse detailed guides in the [documentation](https://causalpy.readthedocs.io)
 
 ## Installation
 
 To get the latest release:
+
 ```bash
 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`.
+or via conda:
+
+```bash
+conda install causalpy -c conda-forge
+```
 
 Alternatively, if you want the very latest version of the package you can install from GitHub:
 
@@ -314,6 +353,10 @@ Alternatively, if you want the very latest version of the package you can instal
 pip install git+https://github.com/pymc-labs/CausalPy.git
 ```
 
+## AI Agent Skills
+
+CausalPy includes agent skills that teach AI coding assistants how to use the library for causal inference. Skills are available via [Decision AI Hub](https://hub.decision.ai) and live in `causalpy/skills/` in the source tree.
+
 ## Quickstart
 
 ```python
@@ -325,7 +368,7 @@ df = (
     cp.load_data("drinking")
     .rename(columns={"agecell": "age"})
     .assign(treated=lambda df_: df_.age > 21)
-    )
+)
 
 # Run the analysis
 result = cp.RegressionDiscontinuity(
@@ -334,32 +377,52 @@ result = cp.RegressionDiscontinuity(
     running_variable_name="age",
     model=cp.pymc_models.LinearRegression(),
     treatment_threshold=21,
-    )
+)
 
-# Visualize outputs
-fig, ax = result.plot();
+# Visualize the causal effect at the threshold
+fig, ax = result.plot()
 
-# Get a results summary
+# Get a results summary with posterior estimates
 result.summary()
-
-plt.show()
 ```
 
-## Roadmap
-
-Plans for the repository can be seen in the [Issues](https://github.com/pymc-labs/CausalPy/issues).
+The `result.plot()` visualizes the regression discontinuity design, showing the estimated jump at the treatment threshold. The `result.summary()` prints posterior estimates of the causal effect with uncertainty intervals.
 
 ## Videos
+
 Click on the thumbnail below to watch a video about CausalPy on YouTube.
+
 [![Youtube video thumbnail image](https://img.youtube.com/vi/gV6wzTk3o1U/maxresdefault.jpg)](https://www.youtube.com/watch?v=gV6wzTk3o1U)
 
-## Features
+## When CausalPy is a good fit
+
+- You have a plausible quasi-experimental design (threshold rule, policy change, staggered rollout, geo lift, etc.)
+- You want uncertainty-aware estimates and diagnostics, not only point estimates
+- You need reproducible analysis artifacts for review and communication
+
+## When CausalPy is not a fit
+
+- You need causal discovery from weakly identified observational data
+- You want fully automated "black box" causal answers without specifying assumptions
+- You primarily need production workflow tooling (pipelines, governance, multi-user collaboration)
+
+## Methods and Workflows
 
-CausalPy has a broad range of quasi-experimental methods for causal inference:
+CausalPy provides methods for common causal inference decision contexts:
 
-| Method	| Description |
+| Decision context | Methods |
+|------------------|---------|
+| Focussed testing on certain units (geos, products) | Synthetic control, Geographical lift |
+| Evaluate before/after changes, launches, policy changes | Differences in Differences, Staggered DiD, Interrupted time series |
+| Exploit cutoff rules, score-based eligibility (credit, age) | Regression discontinuity, Regression kink |
+| Can't randomize, correct for selection | Instrumental variables, Inverse propensity weighting |
+| Group differences, control for covariates | ANCOVA |
+
+### Available methods
+
+| Method | Description |
 |-|-|
-| Synthetic control | Constructs a synthetic version of the treatment group from a weighted combination of control units. Used for causal inference in comparative case studies when a single unit is treated, and there are multiple control units.|
+| Synthetic control | Constructs a synthetic version of the treatment group from a weighted combination of control units. Used for causal inference in comparative case studies when a single unit is treated, and there are multiple control units. |
 | 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. |
@@ -370,26 +433,40 @@ CausalPy has a broad range of quasi-experimental methods for causal inference:
 | Instrumental variable regression | Addresses endogeneity by using an instrument variable that is correlated with the endogenous explanatory variable but uncorrelated with the error term. Used when explanatory variables are correlated with the error term, providing consistent estimates of causal effects. |
 | Inverse Propensity Score Weighting | Weights observations by the inverse of the probability of receiving the treatment. Used in causal inference to create a synthetic sample where the treatment assignment is independent of measured covariates, helping to adjust for confounding variables in observational studies. |
 
-## License
+## Diagnostics-first by design
 
-[Apache License 2.0](LICENSE)
+CausalPy emphasizes transparent, uncertainty-aware outputs for rigorous causal analysis:
 
----
+- **Effect summaries:** Every experiment provides `effect_summary()` returning decision-ready statistics with both tabular and prose formats
+- **Uncertainty quantification:** Bayesian models report HDI (Highest Density Intervals); OLS models report confidence intervals
+- **Practical significance:** ROPE (Region of Practical Equivalence) analysis to assess whether effects exceed meaningful thresholds
+- **Direction testing:** Tail probabilities (e.g., P(effect > 0)) for directional inference
 
-## Getting Help
+## Citing CausalPy
 
-Have questions about using CausalPy? We're here to help!
+If you use CausalPy in your research, please cite it. A Zenodo DOI for stable releases is planned. In the meantime, you can cite the repository:
 
-- **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
+```bibtex
+@software{causalpy,
+  author = {{PyMC Labs}},
+  title = {CausalPy: Causal inference for quasi-experiments in Python},
+  url = {https://github.com/pymc-labs/CausalPy},
+  year = {2026}
+}
+```
 
-Please use GitHub Discussions for general questions rather than opening issues, so we can keep the issue tracker focused on bugs and enhancements.
+## Roadmap
+
+Plans for the repository can be seen in the [Issues](https://github.com/pymc-labs/CausalPy/issues).
+
+## License
 
-## Support
+[Apache License 2.0](https://github.com/pymc-labs/CausalPy/blob/main/LICENSE)
 
-<img src="https://raw.githubusercontent.com/pymc-labs/CausalPy/main/docs/source/_static/pymc-labs-log.png" align="right" width="50%" />
+## Thanks to our contributors
 
-This repository is supported by [PyMC Labs](https://www.pymc-labs.com).
+<a href="https://github.com/pymc-labs/CausalPy/graphs/contributors">
+  <img src="https://raw.githubusercontent.com/pymc-labs/CausalPy/main/docs/source/_static/contributors.svg" alt="CausalPy contributors" />
+</a>
 
-If you are interested in seeing what PyMC Labs can do for you, then please email [ben.vincent@pymc-labs.com](mailto:ben.vincent@pymc-labs.com). We work with companies at a variety of scales and with varying levels of existing modeling capacity. We also run corporate workshop training events and can provide sessions ranging from introduction to Bayes to more advanced topics.
+The contributor image is regenerated weekly by a GitHub Actions workflow (`.github/workflows/contributors.yml`) that opens a PR when the contributor list changes.

{causalpy-0.8.0 → causalpy-0.9.0}/CausalPy.egg-info/SOURCES.txt

@@ -7,9 +7,14 @@ CausalPy.egg-info/dependency_links.txt
 CausalPy.egg-info/requires.txt
 CausalPy.egg-info/top_level.txt
 causalpy/__init__.py
+causalpy/constants.py
 causalpy/custom_exceptions.py
 causalpy/date_utils.py
+causalpy/formula_utils.py
+causalpy/maketables_adapters.py
+causalpy/pipeline.py
 causalpy/plot_utils.py
+causalpy/pymc_forecast_models.py
 causalpy/pymc_models.py
 causalpy/reporting.py
 causalpy/skl_models.py
@@ -17,29 +22,33 @@ causalpy/transforms.py
 causalpy/utils.py
 causalpy/variable_selection_priors.py
 causalpy/version.py
+causalpy/checks/__init__.py
+causalpy/checks/bandwidth.py
+causalpy/checks/base.py
+causalpy/checks/convex_hull.py
+causalpy/checks/leave_one_out.py
+causalpy/checks/mccrary.py
+causalpy/checks/outcome_falsification.py
+causalpy/checks/persistence.py
+causalpy/checks/placebo_in_space.py
+causalpy/checks/placebo_in_time.py
+causalpy/checks/pre_treatment_placebo.py
+causalpy/checks/prior_sensitivity.py
 causalpy/data/AJR2001.csv
 causalpy/data/GDP_in_dollars_billions.csv
 causalpy/data/PISA18sampleScale.csv
 causalpy/data/__init__.py
-causalpy/data/ancova_generated.csv
 causalpy/data/banks.csv
+causalpy/data/california_prop99.csv
 causalpy/data/data_nevo.csv
 causalpy/data/datasets.py
 causalpy/data/deaths_and_temps_england_wales.csv
-causalpy/data/did.csv
 causalpy/data/drinking.csv
-causalpy/data/geolift1.csv
-causalpy/data/geolift_multi_cell.csv
-causalpy/data/gt_social_media_data.csv
-causalpy/data/its.csv
-causalpy/data/its_simple.csv
 causalpy/data/lalonde.csv
 causalpy/data/nets_df.csv
 causalpy/data/nhefs.csv
-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
@@ -47,12 +56,28 @@ 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/model_adapter.py
+causalpy/experiments/panel_regression.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_difference_in_differences.py
+causalpy/skills/__init__.py
+causalpy/steps/__init__.py
+causalpy/steps/estimate_effect.py
+causalpy/steps/report.py
+causalpy/steps/sensitivity.py
+causalpy/templates/report.html
+scripts/_ast_introspection.py
+scripts/check_architecture_inventory.py
+scripts/check_public_exports.py
+scripts/check_rediraffe_redirects.py
+scripts/generate_gallery.py
+scripts/generate_plots.py
+scripts/validate_docstring_lists.py
 scripts/validate_notebooks.py
 scripts/run_notebooks/injected.py
 scripts/run_notebooks/runner.py

{causalpy-0.8.0 → causalpy-0.9.0}/CausalPy.egg-info/requires.txt

@@ -1,11 +1,13 @@
-arviz>=0.14.0
+arviz<1.0,>=0.14.0
 graphviz
 ipython!=8.7.0
+jinja2
 matplotlib>=3.5.3
-numpy<2.4
+numpy
 pandas
 patsy
-pymc>=5.15.1
+pymc<6,>=5.15.1
+pytensor<3,>=2.38.1
 scikit-learn>=1
 scipy
 seaborn>=0.11.2
@@ -14,15 +16,16 @@ xarray>=v2022.11.0
 pymc-extras>=0.3.0
 
 [dev]
-pre-commit
+prek
 twine
-interrogate
 codespell
 nbformat
 nbconvert
+PyYAML
 
 [docs]
 ipykernel
+maketables
 pymc-marketing>=0.13.1
 daft-pgm
 linkify-it-py
@@ -37,22 +40,31 @@ sphinx-copybutton
 sphinx-rtd-theme
 sphinx-sitemap
 statsmodels
-sphinxcontrib-bibtex
+sphinxcontrib-bibtex>=2.7.0
 sphinx-notfound-page
 ipywidgets
 sphinx-design
 sphinx-togglebutton
+nbformat
+nbconvert
+Pillow
+PyYAML
+sphinxext-rediraffe
+
+[forecast]
+pymc-forecast[extras]<0.3,>=0.2
 
 [lint]
-interrogate
-pre-commit
+prek
 ruff
 mypy
 
 [test]
 pytest
 pytest-cov
+diff-cover
 codespell
 nbformat
 nbconvert
 papermill
+pymc-forecast[extras]<0.3,>=0.2