emodpy.reporters.custom module

class emodpy.reporters.custom.ReportAgeAtInfectionHistogramPlugin(name: str = 'ReportPluginAgeAtInfectionHistogram', Enabled: bool = True, Reports: list = <factory>, dll_file: str = 'libReportAgeAtInfectionHistogram_plugin.dll', age_bins: list = <factory>, interval_years: int = <factory>)

Bases: CustomReporter

name: str = 'ReportPluginAgeAtInfectionHistogram'

dll_file: str = 'libReportAgeAtInfectionHistogram_plugin.dll'

Reports: list

age_bins: list

interval_years: int

class emodpy.reporters.custom.ReportHumanMigrationTracking(name: str = 'ReportHumanMigrationTracking', Enabled: bool = True, Reports: list = <factory>, dll_file: str = 'libhumanmigrationtracking.dll')

Bases: CustomReporter

The human migration tracking report is a CSV-formatted report that provides details about human travel during simulations. The finished report will provide one line for each surviving individual that migrates during the simulation. There are no special parameters that need to be configured to generate the report.

name: str = 'ReportHumanMigrationTracking'

dll_file: str = 'libhumanmigrationtracking.dll'

Reports: list

class emodpy.reporters.custom.ReportNodeDemographics(name: str = 'ReportNodeDemographics', Enabled: bool = True, Reports: list = <factory>, dll_file: str = 'libReportNodeDemographics.dll')

Bases: CustomReporter

The node demographics report is a CSV-formatted report that provides population information stratified by node. For each time step, the report will collect data on each node and age bin.

name: str = 'ReportNodeDemographics'

dll_file: str = 'libReportNodeDemographics.dll'

configure_report(age_bins=None, ip_key_to_collect='', stratify_by_gender=1)

Creates the report and sets up the parameters.

Parameters:

• age_bins – The Age Bins (in years) to aggregate within and report; an empty array implies ‘do not stratify by age.

• ip_key_to_collect – The name of the IndividualProperty key to stratify by; an empty string implies ‘do not stratify by IP.’

• stratify_by_gender – Set to true (1) to stratify by gender; a value of 0 will not stratify by gender.

Returns:

Nothing

class emodpy.reporters.custom.ReportEventCounter(name: str = 'ReportEventCounter', Enabled: bool = True, Reports: list = <factory>, dll_file: str = 'libreporteventcounter.dll')

Bases: CustomReporter

The event counter report is a JSON-formatted file that keeps track of how many of each event types occurs during a time step. The report produced is similar to the InsetChart.json channel report, where there is one channel for each event defined in the configuration file (config.json).

name: str = 'ReportEventCounter'

dll_file: str = 'libreporteventcounter.dll'

configure_report(duration_days=10000, event_trigger_list=None, nodes=None, report_description='', start_day=0)

Create the report and set up the parameters.

Parameters:

• duration_days – The duration of simulation days over which to report events.

• event_trigger_list – The list of event triggers for the events included in the report.

• nodes – The list of nodes in which to track the events, setting it to None or [] tracks all nodes.

• report_description – Name of the report (it augments the filename of the report). If multiple CSV reports are being generated, this allows the user to distinguish one report from another.

• start_day – The day to start collecting data for the report.

Returns:

Nothing