Metadata-Version: 2.1
Name: scpi_pkg
Version: 0.2.1
Summary: The package computes point estimates and prediction intervals for Synthetic Control methods as proposed in Cattaneo, Feng, and Titiunik (2021).
Home-page: https://nppackages.github.io/scpi/
Author: Filippo Palomba
Author-email: fpalomba@princeton.edu
License: UNKNOWN
Project-URL: Bug Tracker, https://nppackages.github.io/scpi/
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE

# SCPI_PKG

The `scpi_pkg` package provides Python implementations of estimation and inference procedures for Synthetic Control methods.


## Authors
 
Matias D. Cattaneo (<cattaneo@princeton.edu>)

Yingjie Feng (<fengyj@sem.tsinghua.edu.cn>)

Filippo Palomba (<fpalomba@princeton.edu>)

Rocio Titiunik (<titiunik@princeton.edu>)

## Website

https://nppackages.github.io/scpi/

## Installation

To install/update use pip
```
pip install scpi_pkg
```

# Usage
```
from from scpi_pkg.scdata import scdata
from scpi_pkg.scest import scest
from scpi_pkg.scpi import scpi
from scpi_pkg.scplot import scplot
```

- Replication: [Germany reunification example](https://github.com/nppackages/scpi/blob/main/Python/scpi_illustration.py).

## Dependencies

- cvxpy           (>= 1.1.18)
- dask            (>= 2021.04.0)
- nlopt           (>= 2.7.0)
- numpy           (>= 1.20.1)
- pandas          (>= 1.2.4)
- plotnine        (>= 0.8.0)
- scikit-learn    (>= 0.24.1)
- scipy           (>= 1.7.1)
- statsmodels     (>= 0.12.2)

## References

For overviews and introductions, see [nppackages website](https://nppackages.github.io/).

### Software and Implementation

- Cattaneo, Feng, Palomba, and Titiunik (2022) [scpi: Uncertainty Quantification for Synthetic Control Estimators](https://arxiv.org/abs/2202.05984).


### Technical and Methodological

- Cattaneo, Feng, and Titiunik (2021): [Prediction Intervals for Synthetic Control Methods](https://cattaneo.princeton.edu/papers/Cattaneo-Feng-Titiunik_2021_JASA.pdf).<br>
_Journal of the American Statistical Association_.

- Cattaneo, Feng, Palomba, and Titiunik (2022): Uncertainty Quantification in Synthetic Controls with Staggered Treatment Adoption, working paper.

<br><br>


