.. _quickstart:

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:

.. code-block:: python

    >>> 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(...)

.. invisible-altair-plot::

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

    df = load_seattle_sales()
    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,
    )
    chart = plot_index(hpi, smooth=True).properties(title="Example Index", width=600)

.. toctree::
   :maxdepth: 1
   :caption: Quick Start
   :hidden:

   Basic Usage <self>
   data_format
   available_methods
   next_steps