Merge branch 'main' into basic_ci

Author: juanitorduz

CONTRIBUTING.md

@@ -72,10 +72,34 @@ If there are autodoc issues/errors in remote builds of the docs, we need to add
 
 ## New releases [work in progress]
 
+### Test release to `test.pypi.org` (manual)
+
 1. Bump the release version in `causalpy/version.py`. This is automatically read by `setup.py` and `docs/config.py`.
-2. Update on pypi.org. In the root directory:
-  - `python setup.py sdist`
-  - update to pypi.org with `twine upload dist/*`
+2. Build locally and upload to test.pypi.org. _Note that this requires username and password for test.pypi.org_. In the root directory type the following:
+```bash
+rm -rf dist
+python setup.py sdist
+twine upload --repository testpypi dist/*
+```
+3. At this point the updated build is available on test.pypi.org. We can test that this is working as expected by installing (into a test environment) from test.pypi.org with
+
+```bash
+conda create -n causalpy-test python
+conda activate causalpy-test
+python3 -m pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/ causalpy
+```
+
+4. Now load a python or ipython session and follow the quickstart instructions to confirm things work.
+
+### Actual release to `pypi.org` (manual)
+
+1. Bump the release version (if not done in the previous step) in `causalpy/version.py`. This is automatically read by `setup.py` and `docs/config.py`.
+2. Build locally and upload to pypi.org. In the root directory:
+```bash
+rm -rf dist
+python setup.py sdist
+twine upload dist/*
+```
 3. Readthedocs:
   - Docs should be built remotely every time there is a pull request
   - See here https://docs.readthedocs.io/en/stable/tutorial/#versioning-documentation for versioning the docs

README.md

@@ -37,27 +37,23 @@ pip install git+https://github.com/pymc-labs/CausalPy.git
 ## Quickstart
 
 ```python
-from causalpy.pymc_experiments import RegressionDiscontinuity
-from causalpy.pymc_models import LinearRegression
-import pandas as pd
-import pathlib
+import causalpy as cp
 
 
 # Import and process data
-rd_data_path = pathlib.Path.cwd().parents[1] / "causalpy" / "data" / "drinking.csv"
 df = (
-    pd.read_csv(rd_data_path)[["agecell", "all", "mva", "suicide"]]
+    cp.load_data("drinking")
     .rename(columns={"agecell": "age"})
     .assign(treated=lambda df_: df_.age > 21)
     .dropna(axis=0)
     )
 
 # Run the analysis
-result = RegressionDiscontinuity(
+result = cp.pymc_experiments.RegressionDiscontinuity(
     df,
     formula="all ~ 1 + age + treated",
     running_variable_name="age",
-    prediction_model=LinearRegression(),
+    prediction_model=cp.pymc_models.LinearRegression(),
     treatment_threshold=21,
     )
 

causalpy/__init__.py

@@ -0,0 +1,10 @@
+import arviz as az
+
+import causalpy.pymc_experiments
+import causalpy.pymc_models
+import causalpy.skl_experiments
+import causalpy.skl_models
+
+from .data import load_data
+
+az.style.use("arviz-darkgrid")

causalpy/data/__init__.py

@@ -0,0 +1,4 @@
+"""Code for loading datasets."""
+from .datasets import load_data
+
+__all__ = ["load_data"]