policyengine 3.0.0__py3-none-any.whl → 3.1.1__py3-none-any.whl

policyengine/models/report.py

@@ -1,10 +0,0 @@
-import uuid
-from datetime import datetime
-
-from pydantic import BaseModel, Field
-
-
-class Report(BaseModel):
-    id: str = Field(default_factory=lambda: str(uuid.uuid4()))
-    label: str
-    created_at: datetime | None = None

policyengine/models/report_element.py

@@ -1,36 +0,0 @@
-import uuid
-from datetime import datetime
-from typing import Literal
-
-from pydantic import BaseModel, Field
-
-
-class ReportElement(BaseModel):
-    id: str = Field(default_factory=lambda: str(uuid.uuid4()))
-    label: str
-    type: Literal["chart", "markdown"]
-
-    # Data source
-    data_table: Literal["aggregates"] | None = None  # Which table to pull from
-
-    # Chart configuration
-    chart_type: (
-        Literal["bar", "line", "scatter", "area", "pie", "histogram"] | None
-    ) = None
-    x_axis_variable: str | None = None  # Column name from the table
-    y_axis_variable: str | None = None  # Column name from the table
-    group_by: str | None = None  # Column to group/split series by
-    color_by: str | None = None  # Column for color mapping
-    size_by: str | None = None  # Column for size mapping (bubble charts)
-
-    # Markdown specific
-    markdown_content: str | None = None
-
-    # Metadata
-    report_id: str | None = None
-    user_id: str | None = None
-    position: int | None = None
-    visible: bool | None = True
-    custom_config: dict | None = None  # Additional chart-specific config
-    created_at: datetime | None = None
-    updated_at: datetime | None = None

policyengine/models/user.py

@@ -1,14 +0,0 @@
-import uuid
-from datetime import datetime
-
-from pydantic import BaseModel, Field
-
-
-class User(BaseModel):
-    id: str = Field(default_factory=lambda: str(uuid.uuid4()))
-    username: str
-    first_name: str | None = None
-    last_name: str | None = None
-    email: str | None = None
-    created_at: datetime | None = None
-    updated_at: datetime | None = None

policyengine/models/versioned_dataset.py

@@ -1,12 +0,0 @@
-from uuid import uuid4
-
-from pydantic import BaseModel, Field
-
-from .model import Model
-
-
-class VersionedDataset(BaseModel):
-    id: str = Field(default_factory=lambda: str(uuid4()))
-    name: str
-    description: str
-    model: Model | None = None

policyengine/utils/charts.py

@@ -1,286 +0,0 @@
-"""Chart formatting utilities for PolicyEngine."""
-
-import plotly.graph_objects as go
-from IPython.display import HTML
-
-COLOUR_SCHEMES = {
-    "teal": {
-        "primary": "#319795",
-        "secondary": "#38B2AC",
-        "tertiary": "#4FD1C5",
-        "light": "#81E6D9",
-        "lighter": "#B2F5EA",
-        "lightest": "#E6FFFA",
-        "dark": "#2C7A7B",
-        "darker": "#285E61",
-        "darkest": "#234E52",
-    },
-    "blue": {
-        "primary": "#0EA5E9",
-        "secondary": "#0284C7",
-        "tertiary": "#38BDF8",
-        "light": "#7DD3FC",
-        "lighter": "#BAE6FD",
-        "lightest": "#E0F2FE",
-        "dark": "#026AA2",
-        "darker": "#075985",
-        "darkest": "#0C4A6E",
-    },
-    "gray": {
-        "primary": "#6B7280",
-        "secondary": "#9CA3AF",
-        "tertiary": "#D1D5DB",
-        "light": "#E2E8F0",
-        "lighter": "#F2F4F7",
-        "lightest": "#F9FAFB",
-        "dark": "#4B5563",
-        "darker": "#344054",
-        "darkest": "#101828",
-    },
-}
-
-DEFAULT_COLOURS = [
-    COLOUR_SCHEMES["teal"]["primary"],
-    COLOUR_SCHEMES["blue"]["primary"],
-    COLOUR_SCHEMES["teal"]["secondary"],
-    COLOUR_SCHEMES["blue"]["secondary"],
-    COLOUR_SCHEMES["teal"]["tertiary"],
-    COLOUR_SCHEMES["blue"]["tertiary"],
-    COLOUR_SCHEMES["gray"]["dark"],
-    COLOUR_SCHEMES["teal"]["dark"],
-]
-
-
-def add_fonts() -> HTML:
-    """Return HTML to add Google Fonts for Roboto and Roboto Mono."""
-    return HTML("""
-    <link rel="preconnect" href="https://fonts.googleapis.com">
-    <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
-    <link href="https://fonts.googleapis.com/css2?family=Roboto:wght@300;400;500;700&family=Roboto+Mono:wght@400;500&display=swap" rel="stylesheet">
-    """)
-
-
-def format_figure(
-    fig: go.Figure,
-    title: str | None = None,
-    x_title: str | None = None,
-    y_title: str | None = None,
-    colour_scheme: str = "teal",
-    show_grid: bool = True,
-    show_legend: bool = True,
-    height: int | None = None,
-    width: int | None = None,
-) -> go.Figure:
-    """Apply consistent formatting to a Plotly figure.
-
-    Args:
-        fig: The Plotly figure to format
-        title: Optional title for the chart
-        x_title: Optional x-axis title
-        y_title: Optional y-axis title
-        colour_scheme: Colour scheme name (teal, blue, gray)
-        show_grid: Whether to show gridlines
-        show_legend: Whether to show the legend
-        height: Optional figure height in pixels
-        width: Optional figure width in pixels
-
-    Returns:
-        The formatted figure
-    """
-
-    colours = COLOUR_SCHEMES.get(colour_scheme, COLOUR_SCHEMES["teal"])
-
-    # Update traces with colour scheme
-    for i, trace in enumerate(fig.data):
-        if hasattr(trace, "marker"):
-            trace.marker.color = DEFAULT_COLOURS[i % len(DEFAULT_COLOURS)]
-        if hasattr(trace, "line"):
-            trace.line.color = DEFAULT_COLOURS[i % len(DEFAULT_COLOURS)]
-            trace.line.width = 2
-
-    # Base layout settings
-    layout_updates = {
-        "font": {
-            "family": "Roboto, sans-serif",
-            "size": 14,
-            "color": COLOUR_SCHEMES["gray"]["darkest"],
-        },
-        "plot_bgcolor": "white",
-        "paper_bgcolor": "white",
-        "showlegend": show_legend,
-        "hovermode": "x unified",
-        "hoverlabel": {
-            "bgcolor": "white",
-            "font": {"family": "Roboto Mono, monospace", "size": 12},
-            "bordercolor": colours["light"],
-        },
-    }
-
-    # Add title if provided
-    if title:
-        layout_updates["title"] = {
-            "text": title,
-            "font": {
-                "family": "Roboto, sans-serif",
-                "size": 20,
-                "color": COLOUR_SCHEMES["gray"]["darkest"],
-                "weight": 500,
-            },
-        }
-
-    # Configure axes
-    axis_config = {
-        "showgrid": show_grid,
-        "gridcolor": COLOUR_SCHEMES["gray"]["light"],
-        "gridwidth": 1,
-        "zeroline": True,
-        "zerolinecolor": COLOUR_SCHEMES["gray"]["lighter"],
-        "zerolinewidth": 1,
-        "tickfont": {
-            "family": "Roboto Mono, monospace",
-            "size": 11,
-            "color": COLOUR_SCHEMES["gray"]["primary"],
-        },
-        "titlefont": {
-            "family": "Roboto, sans-serif",
-            "size": 14,
-            "color": COLOUR_SCHEMES["gray"]["dark"],
-        },
-        "linecolor": COLOUR_SCHEMES["gray"]["light"],
-        "linewidth": 1,
-        "showline": True,
-        "mirror": False,
-    }
-
-    layout_updates["xaxis"] = axis_config.copy()
-    layout_updates["yaxis"] = axis_config.copy()
-
-    if x_title:
-        layout_updates["xaxis"]["title"] = x_title
-    if y_title:
-        layout_updates["yaxis"]["title"] = y_title
-
-    layout_updates["showlegend"] = len(fig.data) > 1 and show_legend
-
-    # Set dimensions if provided
-    if height:
-        layout_updates["height"] = height
-    if width:
-        layout_updates["width"] = width
-
-    fig.update_layout(**layout_updates)
-
-    fig.update_xaxes(title_font_color=COLOUR_SCHEMES["gray"]["primary"])
-    fig.update_yaxes(title_font_color=COLOUR_SCHEMES["gray"]["primary"])
-
-    # Add text annotations to bars in bar charts
-    if any(isinstance(trace, go.Bar) for trace in fig.data):
-        for trace in fig.data:
-            if isinstance(trace, go.Bar):
-                trace.texttemplate = "%{y:,.0f}"
-                trace.textposition = "outside"
-                trace.textfont = {
-                    "family": "Roboto Mono, monospace",
-                    "size": 11,
-                    "color": COLOUR_SCHEMES["gray"]["primary"],
-                }
-
-    return fig
-
-
-def create_bar_chart(
-    data: dict[str, list],
-    x: str,
-    y: str,
-    title: str | None = None,
-    colour_scheme: str = "teal",
-    **kwargs,
-) -> go.Figure:
-    """Create a formatted bar chart.
-
-    Args:
-        data: Dictionary with data for the chart
-        x: Column name for x-axis
-        y: Column name for y-axis
-        title: Optional chart title
-        colour_scheme: Colour scheme to use
-        **kwargs: Additional arguments for format_figure
-
-    Returns:
-        Formatted bar chart figure
-    """
-    fig = go.Figure(
-        data=[
-            go.Bar(
-                x=data[x],
-                y=data[y],
-                marker_color=COLOUR_SCHEMES[colour_scheme]["primary"],
-                marker_line_color=COLOUR_SCHEMES[colour_scheme]["dark"],
-                marker_line_width=1,
-                hovertemplate=f"{x}: "
-                + "%{x}<br>"
-                + f"{y}: "
-                + "%{y:,.0f}<extra></extra>",
-            )
-        ]
-    )
-
-    return format_figure(
-        fig,
-        title=title,
-        x_title=x,
-        y_title=y,
-        colour_scheme=colour_scheme,
-        **kwargs,
-    )
-
-
-def create_line_chart(
-    data: dict[str, list],
-    x: str,
-    y: str | list[str],
-    title: str | None = None,
-    colour_scheme: str = "teal",
-    **kwargs,
-) -> go.Figure:
-    """Create a formatted line chart.
-
-    Args:
-        data: Dictionary with data for the chart
-        x: Column name for x-axis
-        y: Column name(s) for y-axis (can be a list for multiple lines)
-        title: Optional chart title
-        colour_scheme: Colour scheme to use
-        **kwargs: Additional arguments for format_figure
-
-    Returns:
-        Formatted line chart figure
-    """
-    traces = []
-    y_columns = y if isinstance(y, list) else [y]
-
-    for i, y_col in enumerate(y_columns):
-        traces.append(
-            go.Scatter(
-                x=data[x],
-                y=data[y_col],
-                mode="lines+markers",
-                name=y_col,
-                line=dict(
-                    color=DEFAULT_COLOURS[i % len(DEFAULT_COLOURS)], width=2
-                ),
-                marker=dict(size=6),
-                hovertemplate=f"{y_col}: " + "%{y:,.0f}<extra></extra>",
-            )
-        )
-
-    fig = go.Figure(data=traces)
-
-    return format_figure(
-        fig,
-        title=title,
-        x_title=x,
-        y_title=y_columns[0] if len(y_columns) == 1 else None,
-        colour_scheme=colour_scheme,
-        **kwargs,
-    )

policyengine/utils/compress.py

@@ -1,20 +0,0 @@
-import pickle
-from typing import Any
-
-import blosc
-
-
-def compress_data(data: Any) -> bytes:
-    """Compress data using blosc after pickling."""
-    pickled_data = pickle.dumps(data)
-    compressed_data = blosc.compress(
-        pickled_data, typesize=8, cname="zstd", clevel=9, shuffle=blosc.SHUFFLE
-    )
-    return compressed_data
-
-
-def decompress_data(compressed_data: bytes) -> Any:
-    """Decompress data using blosc and then unpickle."""
-    decompressed_data = blosc.decompress(compressed_data)
-    data = pickle.loads(decompressed_data)
-    return data

policyengine/utils/datasets.py

@@ -1,71 +0,0 @@
-import pandas as pd
-
-from policyengine.models import Dataset
-
-
-def create_uk_dataset(
-    dataset: str = "enhanced_frs_2023_24.h5",
-    year: int = 2029,
-):
-    from policyengine_uk import Microsimulation
-
-    from policyengine.models.policyengine_uk import policyengine_uk_model
-
-    sim = Microsimulation(
-        dataset="hf://policyengine/policyengine-uk-data/" + dataset
-    )
-    sim.default_calculation_period = year
-
-    tables = {
-        "person": pd.DataFrame(sim.dataset[year].person),
-        "benunit": pd.DataFrame(sim.dataset[year].benunit),
-        "household": pd.DataFrame(sim.dataset[year].household),
-    }
-
-    return Dataset(
-        id="uk",
-        name="UK",
-        description="A representative dataset for the UK, based on the Family Resources Survey.",
-        year=year,
-        model=policyengine_uk_model,
-        data=tables,
-    )
-
-
-def create_us_dataset(
-    dataset: str = "enhanced_cps_2024.h5",
-    year: int = 2024,
-):
-    from policyengine_us import Microsimulation
-
-    from policyengine.models.policyengine_us import policyengine_us_model
-
-    sim = Microsimulation(
-        dataset="hf://policyengine/policyengine-us-data/" + dataset
-    )
-    sim.default_calculation_period = year
-
-    known_variables = sim.input_variables
-
-    tables = {
-        "person": pd.DataFrame(),
-        "marital_unit": pd.DataFrame(),
-        "tax_unit": pd.DataFrame(),
-        "spm_unit": pd.DataFrame(),
-        "family": pd.DataFrame(),
-        "household": pd.DataFrame(),
-    }
-
-    for variable in known_variables:
-        entity = sim.tax_benefit_system.variables[variable].entity.key
-        if variable in sim.tax_benefit_system.variables:
-            tables[entity][variable] = sim.calculate(variable)
-
-    return Dataset(
-        id="us",
-        name="US",
-        description="A representative dataset for the US, based on the Current Population Survey.",
-        year=year,
-        model=policyengine_us_model,
-        data=tables,
-    )

policyengine-3.0.0.dist-info/RECORD

@@ -1,47 +0,0 @@
-policyengine/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-policyengine/__pycache__/__init__.cpython-313.pyc,sha256=clYnHZ_Xv6c59J6BFYQDwmN-_Lo22ATcTO_WNkrUwoY,175
-policyengine/database/__init__.py,sha256=-Xl7G0dfYoAVZwPyhpUsEd8XNAzIbbUIv8wM7h5Mpmo,1641
-policyengine/database/aggregate.py,sha256=4r3C8avxhCb8NJBHViA2kgWL82cqR55voJIqJNh4SbI,911
-policyengine/database/baseline_parameter_value_table.py,sha256=9R3W5ZMhNkgDfUPpkBFE587KBGu3gDFfdr16k-6dDZA,2107
-policyengine/database/baseline_variable_table.py,sha256=AdpKhkrC1lhakT1bu5JYtwvMm6aUS2EP33cX3LvsPhk,1385
-policyengine/database/database.py,sha256=EIeyubFp-pY-bG1IRz9LxlpiUARrN9Hw4fNHk1-Az7w,9168
-policyengine/database/dataset_table.py,sha256=L1I6HUHfc8JHLhY-Ew4OrLkWs2kQwJFlwGqstfzK4pE,1297
-policyengine/database/dynamic_table.py,sha256=6RH8mP1NnFJzs1wB5qYbRQDsk6ZoMKh8pzgaxUnpZ1k,1045
-policyengine/database/link.py,sha256=RuxH9fLNreHns3k3SLIGhnZXMXzz7x2Y0yWPN0Qo0Sg,2941
-policyengine/database/model_table.py,sha256=YRV7DNxXAJ4go1i1hcEV8TE1I8-WRwcpS5-hokn-uhE,742
-policyengine/database/model_version_table.py,sha256=yf2WtCA7kWCd0yOs_ZNXjivPJvUG3QtLf_9CCaLu85U,811
-policyengine/database/parameter_table.py,sha256=Ch-pMOPTcUpKyhd9eIWVEr2pLJxMTP9mcvCe8cPaAP8,980
-policyengine/database/parameter_value_table.py,sha256=Qg3edb44qTNw9iJjg9gXXAPPWQDE3ER5GUtkAI-dwvg,1891
-policyengine/database/policy_table.py,sha256=G-RdGh3zWGIVqGYfnQHXNL0ICxYIe21ITY_EhWKIzYU,1040
-policyengine/database/report_element_table.py,sha256=Cdo-056O9yZJhHfXUu59Z0K5KZqAbEMKvygEDRIkpg0,1516
-policyengine/database/report_table.py,sha256=KqMTkYs_hNyb3FZsIjHDu6rX742qNZi33qZOBGhDaf8,536
-policyengine/database/simulation_table.py,sha256=d8F9Tp8EGv6Mb6sba4UomrCaVilRRs_bl7pl808Gn4k,1697
-policyengine/database/user_table.py,sha256=y2kRjLr4t04mnyI3EEHVsuinYWUZsOdY8vECSUCUDaI,745
-policyengine/database/versioned_dataset_table.py,sha256=WUU7Ed651JLkv3GJmEInbFJChIEaaRIdddKzYFgcRu8,770
-policyengine/models/__init__.py,sha256=ue_8jZnnZZwrEet5kxX3MFIJXyb2qhYQ6pDUJlNonfM,1199
-policyengine/models/aggregate.py,sha256=0RgvJl9UFKNha8t_FuJR34L2Du6VY-Wm0cwCRyIns4E,3135
-policyengine/models/baseline_parameter_value.py,sha256=np7ysyuccqv6oR1PM0cJkozx1cTyw25m6gm3tz9_dfQ,355
-policyengine/models/baseline_variable.py,sha256=hFMTmJngSwm0b3ZC941JWdLZjQpZnuHx79jgFVxYuJg,267
-policyengine/models/dataset.py,sha256=VMPabDHPTm1XlEUKZn8IaK6iMOee_arcfXOm2bXFx_Y,466
-policyengine/models/dynamic.py,sha256=PZvJqXPG-Zpk2LS2TRiZuR0o_mZwm9cz81mbrC7U1P0,475
-policyengine/models/model.py,sha256=puNMRHnPR2GriwU1yqQn2UuASJsOI5YmM8xRYdxVuPc,4554
-policyengine/models/model_version.py,sha256=j9wUCuGSvae2cVkkozUMzKMoqdWIqpSvij4J6NlgObo,341
-policyengine/models/parameter.py,sha256=eOpHXi2aXh8Eqpt0WWmFvWvI5HCEa4PrTcn-W03vpK0,276
-policyengine/models/parameter_value.py,sha256=oFxMwUpb8zU0U4V6HtI7XUXfxbdG1FPDIzaeNpCxjg0,363
-policyengine/models/policy.py,sha256=FjpBR1Dr_9S_3kpQb8Q6qKdcrfRheh1F2h3wLBKgw5g,530
-policyengine/models/policyengine_uk.py,sha256=aKbr-TSXL0GSrpFAZs9r7JAFrpKlgZruSh_C0VybR5M,4028
-policyengine/models/policyengine_us.py,sha256=wOjtdSmEZ4CKSkfFz4N81QOHd9r2_IGDHrjVbheV-vY,3761
-policyengine/models/report.py,sha256=g1iykmUMcgeuX1IECb9kU1GETbxtAg3KRSodM4t2Zco,225
-policyengine/models/report_element.py,sha256=rbGxh4FR25frTMOijbYsPW_wljQQp5opfJYv14hnh4U,1193
-policyengine/models/simulation.py,sha256=sZIZtojah9cPkLSEBclJFZFh-_ICIgeYM-WA3sQ7UtA,903
-policyengine/models/user.py,sha256=oKkYLBt7GiTaA5Nh_O6CyYoC-E9sS3ACzCOGMJF3xnk,361
-policyengine/models/versioned_dataset.py,sha256=TYBYEKghMNQWvrn7SdsW2rl47ZZoleoWHP2gTxGqpNE,249
-policyengine/utils/charts.py,sha256=8wfJmHBbVhpx80sTUpMsigdKFoQuEjQhiUkz_6jDBwo,8201
-policyengine/utils/compress.py,sha256=6J2LE8EedPQsK4TnhoPRFe4kO8AmRIs04fdsllsszzk,561
-policyengine/utils/datasets.py,sha256=EXyJ-4pfkd70fSVaQH2eHa3BQYIC1o3gCQzlcXdz_d8,1977
-policyengine-3.0.0.dist-info/licenses/LICENSE,sha256=hIahDEOTzuHCU5J2nd07LWwkLW7Hko4UFO__ffsvB-8,34523
-policyengine-3.0.0.dist-info/METADATA,sha256=viH80P24ygDMLfWIMiMDjdg_jmBPxME9wycA23qNxdw,41860
-policyengine-3.0.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-policyengine-3.0.0.dist-info/entry_points.txt,sha256=pg1qc3ESZ9CE7kHUQpJtLDLJeWvvdNERRF5W7zrMmgM,67
-policyengine-3.0.0.dist-info/top_level.txt,sha256=_23UPobfkneHQkpJ0e0OmDJfhCUfoXj_F2sTckCGOH4,13
-policyengine-3.0.0.dist-info/RECORD,,

policyengine-3.0.0.dist-info/entry_points.txt

@@ -1,2 +0,0 @@
-[console_scripts]
-pe-migrate = policyengine.migrations.runner:main