pytrnsys_process.process.data_structures.ProcessingResults#

class pytrnsys_process.process.data_structures.ProcessingResults(processed_count: int = 0, error_count: int = 0, failed_simulations: ~typing.List[str] = <factory>, failed_scenarios: dict[str, ~typing.List[str]] = <factory>)[source]#

Results from processing one or more simulations.

processed_count#

Number of successfully processed simulations

Type:

int

error_count#

Number of simulations that failed to process

Type:

int

failed_simulations#

List of simulation names that failed to process

Type:

List[str]

failed_scenarios#

Dictionary mapping simulation names to lists of failed scenario names

Type:

dict[str, List[str]]

simulations#

Dictionary mapping simulation names to processed Simulation objects

Example

>>> results = ProcessingResults()
>>> results.processed_count = 5
>>> results.error_count = 1
>>> results.failed_simulations = ['sim_001']
>>> results.failed_scenarios = {'sim_002': ['scenario_1']}
__init__(processed_count: int = 0, error_count: int = 0, failed_simulations: ~typing.List[str] = <factory>, failed_scenarios: dict[str, ~typing.List[str]] = <factory>) None#

Methods

__init__([processed_count, error_count, ...])

Attributes

processed_count: int = 0#
error_count: int = 0#
failed_simulations: List[str]#
failed_scenarios: dict[str, List[str]]#
__init__(processed_count: int = 0, error_count: int = 0, failed_simulations: ~typing.List[str] = <factory>, failed_scenarios: dict[str, ~typing.List[str]] = <factory>) None#