Quick Start

This guide will help you get started with hpiPy quickly.

Basic Usage

Here’s a simple example of creating a house price index using repeat sales data:

>>> from hpipy.datasets import load_seattle_sales
>>> from hpipy.price_index import RepeatTransactionIndex
>>> from hpipy.utils.plotting import plot_index

# Load your sales data.
>>> df = load_seattle_sales()

# Create an index.
>>> hpi = RepeatTransactionIndex.create_index(
...     trans_data=df,
...     prop_id="pinx",
...     trans_id="sale_id",
...     price="sale_price",
...     date="sale_date",
...     periodicity="M",
...     estimator="robust",
...     log_dep=True,
...     smooth=True,
... )

# Visualize the index.
>>> plot_index(hpi, smooth=True).properties(title="Example Index", width=600)
alt.LayerChart(...)