Create a study with scenarios

from relativities import Program, Study, scenario

program = Program.load("effective://example-ca-ppa")
book = program.example_book


@scenario("Collision deductible {deductible}")
def collision_deductible(book, deductible=1_000):
    """Raise each collision deductible below `deductible` to `deductible`."""

    def raised(coverages):
        lower = coverages["coverage_id"].eq("collision") & coverages["deductible"].lt(deductible)
        return coverages.assign(deductible=coverages["deductible"].mask(lower, deductible))

    return book.with_tables(coverages=raised)


study = Study(book, scenarios=[collision_deductible, collision_deductible(deductible=2_000)])
study.scenarios  # ('baseline', 'Collision deductible 1000', 'Collision deductible 2000')

changed = study.book("Collision deductible 1000")
changed.coverages.query("coverage_id == 'collision'")["deductible"].value_counts().sort_index()
# deductible
# 1000    137122
# 2000      4815

from relativities import fill

sampled = Study(book, scenarios=[collision_deductible], fill={"vehicles.annual_mileage": fill.like("garaging_postal_code")}, draws=10, seed=7)
sampled.scenarios, sampled.draws  # (('baseline', 'Collision deductible 1000'), 10)