emod_api.channelreports.channels module

Module for reading InsetChart.json channels.

class emod_api.channelreports.channels.Header(**kwargs)[source]

Bases: object

property num_channels: int
property dtk_version: str
property time_stamp: str
property report_type: str
property report_version: str
property step_size: int

>= 1

property start_time: int

>= 0

property num_time_steps: int

>= 1

as_dictionary() dict[source]
class emod_api.channelreports.channels.Channel(title, units, data)[source]

Bases: object

property title: str
property units: str
property data
as_dictionary() dict[source]
class emod_api.channelreports.channels.ChannelReport(filename: Optional[str] = None, **kwargs)[source]

Bases: object

property header: emod_api.channelreports.channels.Header
property dtk_version: str
property time_stamp: str
property report_type: str
property report_version: str

major.minor

property step_size: int

>= 1

property start_time: int

>= 0

property num_time_steps: int

> 0

property num_channels: int
property channel_names: list
property channels: dict

Channel objects keyed on channel name/title

as_dataframe()[source]
write_file(filename: str, indent: int = 0, separators=(',', ':'))[source]

Write inset chart to specified text file.