Skip to content

channel_report

ChannelReport

A class that can be used to convert an EMOD channel report/dictionary (i.e. InsetChart, DemographicsSummary, PropertyReport, etc) into a dataframe. A static method is provided to convert a dataframe to a channel report.

Source code in emodpy_hiv/plotting/channel_report.py 
  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
class ChannelReport:
    """
    A class that can be used to convert an EMOD channel report/dictionary
    (i.e. InsetChart, DemographicsSummary, PropertyReport, etc) into a
    dataframe. A static method is provided to convert a dataframe to a channel report.
    """
    def __init__(self, df: pd.DataFrame = None):
        self.json_data = self.convert_df_to_channel_report(df)

    def create_empty_channel_report(self):
        #  It would be really nice if we could include Start_Time & Simulation_Timestep
        # from the input files, but these are hardcoded for now.
        """
        Create the dictionary that has the right format for a channel report.

        Returns:
            (dict): A dictionary that has the header and an empty 'Channels' entry
        """
        report = {}
        report["Header"] = {}
        report["Header"]["DateTime"           ] = datetime.today().strftime('%Y-%m-%d') # noqa: E202
        report["Header"]["DTK_Version"        ] = "unknown"                             # noqa: E202
        report["Header"]["Report_Type"        ] = "InsetChart"                          # noqa: E202
        report["Header"]["Report_Version"     ] = "3.2"                                 # noqa: E202
        report["Header"]["Start_Time"         ] = 0                                     # noqa: E202
        report["Header"]["Simulation_Timestep"] = 365 / 12
        report["Header"]["Timesteps"          ] = 0                                     # noqa: E202
        report["Header"]["Channels"           ] = 0                                     # noqa: E202

        report["Channels"] = {}

        return report

    def add_channel(self, report, channel_name, values):
        """
        Add the values of the channel to the report

        Args:
            report (dict): a channel report formatted JSON dictionary
            channel_name (str): the name of the channel to add
            values (list): a list of integers or floats for that channel

        Returns:
            (dict): The updated dictionary with the channel added.
        """
        report["Channels"][channel_name] = {}
        report["Channels"][channel_name]["Units"] = ""
        report["Channels"][channel_name]["Data"] = values

        report["Header"]["Channels"] += 1

        return

    def convert_df_to_channel_report(self, df):
        """
        Convert the dataframe to a dictionary of the channel report format.

        Args:
            df (pd.DataFrame): a dataframe where the columns are the channels and there
                is a row for each time step

        Returns:
            (dict): A dictionary that contains the data from the dataframe and can be
                converted to a JSON channel report
        """
        report = self.create_empty_channel_report()

        for name, values in df.items():
            if name != "Time":
                self.add_channel(report, name, values.tolist())

        return report

    def save(self, filename):
        """
        Save this report data to a file.

        Args:
            filename (str): The name of the file (including path) to contain the data/JSON.
        """
        with open(filename, 'w') as file:
            json.dump(self.json_data, file, indent=4)
        return

    @staticmethod
    def convert_to_df(channel_report_dict, channels_to_extract=None):
        """
        Convert the input dictionary into a dataframe

        Args:
            channel_report_dict (dict):
                The name of the file (including path) to contain the data/JSON.

            channels_to_extract (list):
                A list of strings that are the channel names to extract from the
                JSON and put into the dataframe

        Returns:
            (pd.DataFrame): A dataframe where the columns are the channels of the report.
                An extra 'Time' column is added to the dataframe
        """
        dt             = channel_report_dict["Header"]["Simulation_Timestep"]  # noqa: E221
        start_time     = channel_report_dict["Header"]["Start_Time"]           # noqa: E221
        num_time_steps = channel_report_dict["Header"]["Timesteps"]

        result_dict = {"Time": start_time + (np.arange(num_time_steps) * dt)}

        if channels_to_extract is None:
            channels_to_extract = channel_report_dict["Channels"].keys()

        for channel_name in channels_to_extract:
            result_dict[channel_name] = channel_report_dict["Channels"][channel_name]["Data"]

        df = pd.DataFrame(result_dict)

        return df

add_channel(report, channel_name, values)

Add the values of the channel to the report

Parameters:

Name Type Description Default
report dict

a channel report formatted JSON dictionary

 required
channel_name str

the name of the channel to add

 required
values list

a list of integers or floats for that channel

 required

Returns:

Type Description
dict

The updated dictionary with the channel added.
Source code in emodpy_hiv/plotting/channel_report.py 
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
def add_channel(self, report, channel_name, values):
    """
    Add the values of the channel to the report

    Args:
        report (dict): a channel report formatted JSON dictionary
        channel_name (str): the name of the channel to add
        values (list): a list of integers or floats for that channel

    Returns:
        (dict): The updated dictionary with the channel added.
    """
    report["Channels"][channel_name] = {}
    report["Channels"][channel_name]["Units"] = ""
    report["Channels"][channel_name]["Data"] = values

    report["Header"]["Channels"] += 1

    return

convert_df_to_channel_report(df)

Convert the dataframe to a dictionary of the channel report format.

Parameters:

Name Type Description Default
df DataFrame

a dataframe where the columns are the channels and there is a row for each time step

 required

Returns:

Type Description
dict

A dictionary that contains the data from the dataframe and can be converted to a JSON channel report
Source code in emodpy_hiv/plotting/channel_report.py 
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
def convert_df_to_channel_report(self, df):
    """
    Convert the dataframe to a dictionary of the channel report format.

    Args:
        df (pd.DataFrame): a dataframe where the columns are the channels and there
            is a row for each time step

    Returns:
        (dict): A dictionary that contains the data from the dataframe and can be
            converted to a JSON channel report
    """
    report = self.create_empty_channel_report()

    for name, values in df.items():
        if name != "Time":
            self.add_channel(report, name, values.tolist())

    return report

convert_to_df(channel_report_dict, channels_to_extract=None) staticmethod

Convert the input dictionary into a dataframe

Parameters:

Name Type Description Default
channel_report_dict dict

The name of the file (including path) to contain the data/JSON.

 required
channels_to_extract list

A list of strings that are the channel names to extract from the JSON and put into the dataframe

 None

Returns:

Type Description
DataFrame

A dataframe where the columns are the channels of the report. An extra 'Time' column is added to the dataframe
Source code in emodpy_hiv/plotting/channel_report.py 
 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
@staticmethod
def convert_to_df(channel_report_dict, channels_to_extract=None):
    """
    Convert the input dictionary into a dataframe

    Args:
        channel_report_dict (dict):
            The name of the file (including path) to contain the data/JSON.

        channels_to_extract (list):
            A list of strings that are the channel names to extract from the
            JSON and put into the dataframe

    Returns:
        (pd.DataFrame): A dataframe where the columns are the channels of the report.
            An extra 'Time' column is added to the dataframe
    """
    dt             = channel_report_dict["Header"]["Simulation_Timestep"]  # noqa: E221
    start_time     = channel_report_dict["Header"]["Start_Time"]           # noqa: E221
    num_time_steps = channel_report_dict["Header"]["Timesteps"]

    result_dict = {"Time": start_time + (np.arange(num_time_steps) * dt)}

    if channels_to_extract is None:
        channels_to_extract = channel_report_dict["Channels"].keys()

    for channel_name in channels_to_extract:
        result_dict[channel_name] = channel_report_dict["Channels"][channel_name]["Data"]

    df = pd.DataFrame(result_dict)

    return df

create_empty_channel_report()

Create the dictionary that has the right format for a channel report.

Returns:

Type Description
dict

A dictionary that has the header and an empty 'Channels' entry
Source code in emodpy_hiv/plotting/channel_report.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
def create_empty_channel_report(self):
    #  It would be really nice if we could include Start_Time & Simulation_Timestep
    # from the input files, but these are hardcoded for now.
    """
    Create the dictionary that has the right format for a channel report.

    Returns:
        (dict): A dictionary that has the header and an empty 'Channels' entry
    """
    report = {}
    report["Header"] = {}
    report["Header"]["DateTime"           ] = datetime.today().strftime('%Y-%m-%d') # noqa: E202
    report["Header"]["DTK_Version"        ] = "unknown"                             # noqa: E202
    report["Header"]["Report_Type"        ] = "InsetChart"                          # noqa: E202
    report["Header"]["Report_Version"     ] = "3.2"                                 # noqa: E202
    report["Header"]["Start_Time"         ] = 0                                     # noqa: E202
    report["Header"]["Simulation_Timestep"] = 365 / 12
    report["Header"]["Timesteps"          ] = 0                                     # noqa: E202
    report["Header"]["Channels"           ] = 0                                     # noqa: E202

    report["Channels"] = {}

    return report

save(filename)

Save this report data to a file.

Parameters:

Name Type Description Default
filename str

The name of the file (including path) to contain the data/JSON.

 required
Source code in emodpy_hiv/plotting/channel_report.py 
80
81
82
83
84
85
86
87
88
89
def save(self, filename):
    """
    Save this report data to a file.

    Args:
        filename (str): The name of the file (including path) to contain the data/JSON.
    """
    with open(filename, 'w') as file:
        json.dump(self.json_data, file, indent=4)
    return