reporters.py

add_5daily_reports(task, manifest, sim_start_year, num_year, tot_year=None, yr_plusone=True, age_bins=[0.5, 1, 2, 5, 10, 15, 20, 125], detection_threshold=0, prefix='FiveDaily_')

Adds 5 daily reports to the simulation task. Args: task: The simulation task object. manifest: The manifest object containing the necessary information. sim_start_year: The starting year of the simulation. num_year: The number of years to add monthly reports for. tot_year: The total number of years of the simulation. If None, it is set to num_year. yr_plusone: Whether to add an extra year to the reporting. If True, reports will cover num_year + 1 years. If False, reports will cover num_year years. age_bins: The age bins for reporting. prefix: The prefix to be used for the report filenames. Raises: ValueError: If num_year is greater than tot_year. Returns: None

Source code in EMOD\functions\reporters.py 
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
def add_5daily_reports(task, manifest, sim_start_year, num_year, tot_year=None,
                        yr_plusone=True, age_bins=[0.5, 1, 2, 5, 10, 15,20, 125], detection_threshold=0,
                        prefix='FiveDaily_'):
    """
    Adds 5 daily reports to the simulation task.
    Args:
        task: The simulation task object.
        manifest: The manifest object containing the necessary information.
        sim_start_year: The starting year of the simulation.
        num_year: The number of years to add monthly reports for.
        tot_year: The total number of years of the simulation.
                  If None, it is set to num_year.
        yr_plusone: Whether to add an extra year to the reporting.
                    If True, reports will cover num_year + 1 years.
                    If False, reports will cover num_year years.
        age_bins: The age bins for reporting.
        prefix: The prefix to be used for the report filenames.
    Raises:
        ValueError: If num_year is greater than tot_year.
    Returns:
        None
    """
    if tot_year is None:
        tot_year = num_year
    if (num_year > tot_year):
        raise ValueError('num_year must be <= tot_year')

    # Write separate monthly reports for each year
    for year in range(num_year):
        sim_year = tot_year - num_year + year
        start = yr_plusone + 365 * sim_year
        desc = prefix + '%d' % (sim_year + sim_start_year)
        add_malaria_summary_report(task, manifest, start_day=start, end_day=start + 365 - 1, age_bins=age_bins,
                                   max_number_reports = 366, reporting_interval=5, filename_suffix=desc, pretty_format=False,
                                   add_true_density=True, parasite_detection_threshold = detection_threshold)

add_annual_reports(task, manifest, sim_start_year, num_year, tot_year=None, yr_plusone=True, age_bins=[0.5, 1, 2, 5, 10, 15, 20, 125], detection_threshold=0, prefix='Annual_', ipfilter='')

Adds annual reports to the simulation task. Args: task: The simulation task object. manifest: The manifest object containing the necessary information. sim_start_year: The starting year of the simulation. num_year: The number of years to add monthly reports for. tot_year: The total number of years of the simulation. If None, it is set to num_year. yr_plusone: Whether to add an extra year to the reporting. If True, reports will cover num_year + 1 years. If False, reports will cover num_year years. age_bins: The age bins for reporting. prefix: The prefix to be used for the report filenames. Raises: ValueError: If num_year is greater than tot_year. Returns: None

Source code in EMOD\functions\reporters.py 
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
def add_annual_reports(task, manifest, sim_start_year, num_year, tot_year=None,
                       yr_plusone=True, age_bins=[0.5,1, 2, 5, 10, 15, 20, 125], detection_threshold=0,
                       prefix='Annual_', ipfilter=''):
    """
    Adds annual reports to the simulation task.
    Args:
        task: The simulation task object.
        manifest: The manifest object containing the necessary information.
        sim_start_year: The starting year of the simulation.
        num_year: The number of years to add monthly reports for.
        tot_year: The total number of years of the simulation.
                  If None, it is set to num_year.
        yr_plusone: Whether to add an extra year to the reporting.
                    If True, reports will cover num_year + 1 years.
                    If False, reports will cover num_year years.
        age_bins: The age bins for reporting.
        prefix: The prefix to be used for the report filenames.
    Raises:
        ValueError: If num_year is greater than tot_year.
    Returns:
        None
    """
    if tot_year is None:
        tot_year = num_year
    if (num_year > tot_year):
        raise ValueError('num_year must be <= tot_year')
    sim_year = tot_year - num_year
    start = yr_plusone + 365 * sim_year
    desc = prefix + '%dto%d' % (sim_year + sim_start_year, tot_year + sim_start_year - 1)

    # All years in one report file
    add_malaria_summary_report(task, manifest, start_day=start, end_day=start + (num_year * 365) - 1,
                               age_bins=age_bins, reporting_interval=365, max_number_reports = (tot_year + sim_start_year) - (sim_year + sim_start_year),
                               filename_suffix=desc, pretty_format=False,
                               add_true_density=True, parasite_detection_threshold = detection_threshold)

add_daily_reports(task, manifest, sim_start_year, num_year, tot_year=None, yr_plusone=True, age_bins=[0.5, 1, 2, 5, 10, 15, 20, 125], detection_threshold=0, prefix='Daily_')

Adds daily reports to the simulation task. Args: task: The simulation task object. manifest: The manifest object containing the necessary information. sim_start_year: The starting year of the simulation. num_year: The number of years to add monthly reports for. tot_year: The total number of years of the simulation. If None, it is set to num_year. age_bins: The age bins for reporting. prefix: The prefix to be used for the report filenames. Raises: ValueError: If num_year is greater than tot_year. Returns: None

Source code in EMOD\functions\reporters.py 
 4
 5
 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
def add_daily_reports(task, manifest, sim_start_year, num_year, tot_year=None,
                      yr_plusone=True, age_bins=[0.5, 1, 2, 5, 10, 15,20, 125], detection_threshold=0,
                        prefix='Daily_'):
    """
    Adds daily reports to the simulation task.
    Args:
        task: The simulation task object.
        manifest: The manifest object containing the necessary information.
        sim_start_year: The starting year of the simulation.
        num_year: The number of years to add monthly reports for.
        tot_year: The total number of years of the simulation.
                  If None, it is set to num_year.
        age_bins: The age bins for reporting.
        prefix: The prefix to be used for the report filenames.
    Raises:
        ValueError: If num_year is greater than tot_year.
    Returns:
        None
    """
    if tot_year is None:
        tot_year = num_year
    if (num_year > tot_year):
        raise ValueError('num_year must be <= tot_year')

    # Write separate monthly reports for each year
    for year in range(num_year):
        sim_year = tot_year - num_year + year
        start = yr_plusone + 365 * sim_year
        desc = prefix + '%d' % (sim_year + sim_start_year)
        add_malaria_summary_report(task, manifest, start_day=start, end_day=start + 365, age_bins=age_bins,
                                   max_number_reports = 366, reporting_interval=1, filename_suffix=desc, pretty_format=False,
                                   add_true_density=True, parasite_detection_threshold = detection_threshold)

add_monthly_reports(task, manifest, sim_start_year, num_year, tot_year=None, yr_plusone=True, age_bins=[0.5, 1, 2, 5, 10, 15, 20, 125], detection_threshold=0, prefix='Monthly_')

Adds monthly reports to the simulation task. Args: task: The simulation task object. manifest: The manifest object containing the necessary information. sim_start_year: The starting year of the simulation. num_year: The number of years to add monthly reports for. tot_year: The total number of years of the simulation. If None, it is set to num_year. yr_plusone: Whether to add an extra year to the reporting. If True, reports will cover num_year + 1 years. If False, reports will cover num_year years. age_bins: The age bins for reporting. prefix: The prefix to be used for the report filenames. Raises: ValueError: If num_year is greater than tot_year. Returns: None

Source code in EMOD\functions\reporters.py 
 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
def add_monthly_reports(task, manifest, sim_start_year, num_year, tot_year=None,
                        yr_plusone=True, age_bins=[0.5,1, 2, 5, 10, 15,20,125], detection_threshold=0,
                        prefix='Monthly_'):
    """
    Adds monthly reports to the simulation task.
    Args:
        task: The simulation task object.
        manifest: The manifest object containing the necessary information.
        sim_start_year: The starting year of the simulation.
        num_year: The number of years to add monthly reports for.
        tot_year: The total number of years of the simulation.
                  If None, it is set to num_year.
        yr_plusone: Whether to add an extra year to the reporting.
                    If True, reports will cover num_year + 1 years.
                    If False, reports will cover num_year years.
        age_bins: The age bins for reporting.
        prefix: The prefix to be used for the report filenames.
    Raises:
        ValueError: If num_year is greater than tot_year.
    Returns:
        None
    """
    if tot_year is None:
        tot_year = num_year
    if (num_year > tot_year):
        raise ValueError('num_year must be <= tot_year')

    # Write separate monthly reports for each year
    for year in range(num_year):
        sim_year = tot_year - num_year + year
        start = yr_plusone + 365 * sim_year
        desc = prefix + '%d' % (sim_year + sim_start_year)
        add_malaria_summary_report(task, manifest, start_day=start, end_day=start + 365 - 1, age_bins=age_bins,
                                   reporting_interval=30, filename_suffix=desc, pretty_format=False,
                                   add_true_density=True, parasite_detection_threshold = detection_threshold)