Skip to article frontmatterSkip to article content
Site not loading correctly?

This may be due to an incorrect BASE_URL configuration. See the MyST Documentation for reference.

API reference

SPMForecast calculates thresholds from the bundled artifact. The package also provides geography assignment, equivalence scales and optional adapters.

TaskInterface
Load the current artifact and calculate a unitSPMForecast, load_forecast, SPMUnit
Resolve county assignment or inspect a year’s areasForecast geography methods
Scale already classified adult/child countsspm_equivalence_scale
Preserve or reconstruct resource-unit membershipspm_unit_id and partition comparison
Read published national source valuesget_published_thresholds
Apply thresholds inside PolicyEngineCanonical provider and country configuration
Apply and summarize actual FramesMicrocosm integration
Execute native classification and arithmeticActual Axiom core integration

The quickstart also covers the installed CLI. The artifact contract describes schema-2 forecasts and their source metadata.