emodpy.campaign.utils module

emodpy.campaign.utils.set_event(broadcast_event: str, event_argument_name: str, campaign: <module 'emod_api.campaign' from '/home/docs/checkouts/readthedocs.org/user_builds/institute-for-disease-modeling-emodpy/envs/latest/lib/python3.9/site-packages/emod_api/campaign.py'>, optional: bool = True) → str

Set the event to the campaign module as a broadcast event and return the event name.

emodpy.campaign.utils.get_trigger_conditions(campaign: <module 'emod_api.campaign' from '/home/docs/checkouts/readthedocs.org/user_builds/institute-for-disease-modeling-emodpy/envs/latest/lib/python3.9/site-packages/emod_api/campaign.py'>, trigger_list: list[str]) → list[str]

Get the trigger conditions from the campaign module and return the trigger list.

emodpy.campaign.utils.do_nodes(schema_path, node_ids: list[int] | None = None)

Create and return a NodeSetConfig based on node_ids list.

Parameters:

• schema_path – Path to schema.json file.

• node_ids – a list of NodeIDs, defaults to None, which is NodeSetAll

Returns:

Well-configured NodeSetConfig