Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

Calculate a household under several policies in one call on Modal (v2 household functions)

Abierto
  • ¿Algo no está bien?
#902 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

@anth-volk ya está trabajando en esto.

Desde el 22/10/2026.

  • #903 de @anth-volk — abierto

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
20/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
python
Área
api, backend

Línea de trabajo

Start by reading the open pull request #903, which is already working on this issue. The issue describes the v2 household functions, version manifest, release validation, and image checks, but does not name specific files or tests. Done means both country functions, manifest and validation changes, and the pre-merge image check meet the listed behavior.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

What

Add Modal functions that calculate one household under several policies in one call, for the US and the UK, in the versioned v2 Modal application:

  • A versioned household contract: a household in the Public API's situation shape, with optional axes; one to ten policies per request, so a baseline and its reform are calculated together; a schema version; the PolicyEngine.py bundle the caller expects; an optional SPM selection; and an option to add every missing variable, as the Public API's /calculate-full route does. The result carries each policy's calculated household, warnings and SPM receipt, the applied SPM selection and the bundle provenance, or a typed failure.
  • calculate_household_us and calculate_household_uk, which reproduce the Public API's household calculation (input preparation, unrecognized-input errors and their order, deprecated-input warnings, value formatting, SPM handling) and run in their own image with no datasets and no secrets, sized for large households with axes.
  • Schema version 2 of the v2 version manifest, which records for each country whether it can run economy reports and which function calculates its households. The comparison adapter gives the report coordinator only countries marked economy-capable.
  • Release validation that calls each household function with a small household before the manifest names it.
  • The pre-merge image check builds every v2 image (report coordinator, country workers, household functions) and imports their entry points.

Why

Household calculations run inside the Public API's web process today. Moving them to Modal lets the Simulation Entrypoint calculate and store households the same way it handles economy reports, and computes a baseline and its reform in a single call. Nothing calls these functions yet: they are deployed but unused until the Simulation Entrypoint gains household routes.

Lenguaje dominante
Python
Estrellas
1
Forks
1
Merge medio
1 d 16 h
PR fusionados (30 d)
61

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de PolicyEngine/policyengine-sim-api

Todos los issues de PolicyEngine/policyengine-sim-api

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.