Skip to content

emod_campaign

EMODCampaign

Class representing an EMOD Campaign. It contains: - events: a list of events for the given campaign - name: campaign name - extra_parameters: parameters set by the user that will be added to the campaign JSON

Source code in emodpy/campaign/emod_campaign.py 
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
class EMODCampaign:
    """
    Class representing an EMOD Campaign.
    It contains:
    - events: a list of events for the given campaign
    - name: campaign name
    - extra_parameters: parameters set by the user that will be added to the campaign JSON
    """

    def __init__(self, name="Campaign", events=None, **kwargs):
        self.events = [] if events is None else events
        self.name = name
        self.use_defaults = 1  # Use_Defaults is set to 1. Use_Defaults = 0 does not work well.
        self.extra_parameters = kwargs

    def __len__(self):
        return len(self.events)

    @property
    def json(self):
        """
        Property to transform the object in JSON
        """
        return json.dumps({
            "Campaign_Name": self.name,
            "Events": self.events,
            "Use_Defaults": self.use_defaults,
            **self.extra_parameters
        })

    @staticmethod
    def load_from_file(filename: str) -> 'EMODCampaign':
        """
        Load a campaign from a JSON file.

        Args:
            filename: Path to the campaign file

        Returns: an initialized `EMODCampaign` instance

        """

        with open(filename, 'r') as fp:
            data = json.load(fp)
        return EMODCampaign.load_from_dict(data)

    @staticmethod
    def load_from_dict(data: Dict) -> 'EMODCampaign':
        """
        Create a campaign object from a dict.
        Args:
            data: The dictionary containing the data

        Returns: an initialized `EMODCampaign` instance

        """
        name = data.pop("Campaign_Name", "Unnamed Campaign")
        events = data.pop("Events", [])
        use_default = data.pop("Use_Defaults", None)  # Remove Use_Defaults from the dict, Use_Defaults is set to 1 in the class.
        if use_default == 0 or use_default is False:
            warnings.warn("You have Use_Defaults = 0, this may not work well. Use_Defaults is set to 1 in the class.")
        extra_parameters = data
        return EMODCampaign(name=name, events=events, **extra_parameters)

    def clear(self) -> None:
        """
        Clear all campaign events
        """
        self.events.clear()

    def get_events_at(self, timestep: int) -> List[Dict]:
        """
        Get a list of events happening at the specified timestep.
        Does not take into account recurrence and only consider start timestep.
        Args:
            timestep: selected timestep

        Returns: list of events

        """
        return list(filter(lambda e: e.get("Start_Day", None) == timestep, self.events))

    def get_events_with_name(self, name: str) -> List[Dict]:
        """
        Get a list of events with the given name.
        This search is based on the `Event_Name` key of events.
        Args:
            name: Name of the events

        Returns: list of events

        """
        return list(filter(lambda e: e.get("Event_Name", None) == name, self.events))

    def add_event(self, event: Dict) -> None:
        """
        Add the given event to the campaign event.
        Args:
            event: The event to add
        """
        self.events.append(event)

    def add_events(self, events: List[Dict]) -> None:
        """
        Add a list of events to the campaign events.
        Args:
            events: List of events to add
        """
        self.events.extend(events)

    def __repr__(self):
        out = f"Campaign {self.name}\n"
        out += "Events:\n"
        for event in self.events:
            out += f"  - {event.get('Event_Name', 'Unnamed event')}\n"
            out += f"    Timestep {event.get('Start_Day', 'N/A')} / {event['Event_Coordinator_Config']['Intervention_Config']['class']}\n"

        return out

json property

Property to transform the object in JSON

add_event(event)

Add the given event to the campaign event. Args: event: The event to add

Source code in emodpy/campaign/emod_campaign.py 
100
101
102
103
104
105
106
def add_event(self, event: Dict) -> None:
    """
    Add the given event to the campaign event.
    Args:
        event: The event to add
    """
    self.events.append(event)

add_events(events)

Add a list of events to the campaign events. Args: events: List of events to add

Source code in emodpy/campaign/emod_campaign.py 
108
109
110
111
112
113
114
def add_events(self, events: List[Dict]) -> None:
    """
    Add a list of events to the campaign events.
    Args:
        events: List of events to add
    """
    self.events.extend(events)

clear()

Clear all campaign events

Source code in emodpy/campaign/emod_campaign.py 
70
71
72
73
74
def clear(self) -> None:
    """
    Clear all campaign events
    """
    self.events.clear()

get_events_at(timestep)

Get a list of events happening at the specified timestep. Does not take into account recurrence and only consider start timestep. Args: timestep: selected timestep

Returns: list of events

Source code in emodpy/campaign/emod_campaign.py 
76
77
78
79
80
81
82
83
84
85
86
def get_events_at(self, timestep: int) -> List[Dict]:
    """
    Get a list of events happening at the specified timestep.
    Does not take into account recurrence and only consider start timestep.
    Args:
        timestep: selected timestep

    Returns: list of events

    """
    return list(filter(lambda e: e.get("Start_Day", None) == timestep, self.events))

get_events_with_name(name)

Get a list of events with the given name. This search is based on the Event_Name key of events. Args: name: Name of the events

Returns: list of events

Source code in emodpy/campaign/emod_campaign.py 
88
89
90
91
92
93
94
95
96
97
98
def get_events_with_name(self, name: str) -> List[Dict]:
    """
    Get a list of events with the given name.
    This search is based on the `Event_Name` key of events.
    Args:
        name: Name of the events

    Returns: list of events

    """
    return list(filter(lambda e: e.get("Event_Name", None) == name, self.events))

load_from_dict(data) staticmethod

Create a campaign object from a dict. Args: data: The dictionary containing the data

Returns: an initialized EMODCampaign instance

Source code in emodpy/campaign/emod_campaign.py 
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
@staticmethod
def load_from_dict(data: Dict) -> 'EMODCampaign':
    """
    Create a campaign object from a dict.
    Args:
        data: The dictionary containing the data

    Returns: an initialized `EMODCampaign` instance

    """
    name = data.pop("Campaign_Name", "Unnamed Campaign")
    events = data.pop("Events", [])
    use_default = data.pop("Use_Defaults", None)  # Remove Use_Defaults from the dict, Use_Defaults is set to 1 in the class.
    if use_default == 0 or use_default is False:
        warnings.warn("You have Use_Defaults = 0, this may not work well. Use_Defaults is set to 1 in the class.")
    extra_parameters = data
    return EMODCampaign(name=name, events=events, **extra_parameters)

load_from_file(filename) staticmethod

Load a campaign from a JSON file.

Parameters:

Name Type Description Default
filename str

Path to the campaign file

 required

Returns: an initialized EMODCampaign instance

Source code in emodpy/campaign/emod_campaign.py 
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
@staticmethod
def load_from_file(filename: str) -> 'EMODCampaign':
    """
    Load a campaign from a JSON file.

    Args:
        filename: Path to the campaign file

    Returns: an initialized `EMODCampaign` instance

    """

    with open(filename, 'r') as fp:
        data = json.load(fp)
    return EMODCampaign.load_from_dict(data)