goals-scenario

goals-scenario runs scenario analysis with the leapfrog Goals model. Given a set of intervention scenarios and a directory of PJNZ files, it samples intervention parameters across simulations, runs the Goals model for each draw, and writes the results to HDF5 files.

Installation

Python (all platforms)

pip install avenir_goals_scenario

Windows standalone executable

A self-contained Windows .exe that does not require Python is attached to each GitHub release as goals-scenario-windows.zip. Download and unzip it, then run goals-scenario.exe directly from the extracted folder or add the folder to your PATH.

Usage

There are two ways to use it:

• CLI - drive runs from a JSON config file with the goals-scenario draw and goals-scenario run commands. See the CLI reference for full command documentation and config format.
• Python API - call run_scenario_analysis and draw_simulations directly from Python. See the API reference.