Socio-economic surplus

class trident_extras.post_processing.socio_economic_surplus.Entry(source: str, value: float)

Bases: object

__init__(source: str, value: float) → None

source: str

value: float

class trident_extras.post_processing.socio_economic_surplus.AreaReport(area_name: str = '', entries: Dict[trident_extras.post_processing.socio_economic_surplus.Category, List[trident_extras.post_processing.socio_economic_surplus.Entry]] = <factory>)

Bases: object

__init__(area_name: str = '', entries: ~typing.Dict[~trident_extras.post_processing.socio_economic_surplus.Category, ~typing.List[~trident_extras.post_processing.socio_economic_surplus.Entry]] = <factory>) → None

area_name: str = ''

entries: Dict[Category, List[Entry]]

get_total(category: Category) → float

property socio_economic_surplus: float

class trident_extras.post_processing.socio_economic_surplus.SocioEconomicSurplusReport(run_id: str, scenario_id: str, start_time_us: datetime.datetime, end_time_us: datetime.datetime, unit: str, conversion_rate: int, area_reports: dict[str, trident_extras.post_processing.socio_economic_surplus.AreaReport] = <factory>)

Bases: object

__init__(run_id: str, scenario_id: str, start_time_us: ~datetime.datetime, end_time_us: ~datetime.datetime, unit: str, conversion_rate: int, area_reports: dict[str, ~trident_extras.post_processing.socio_economic_surplus.AreaReport] = <factory>) → None

area_reports: dict[str, AreaReport]

property consumer_surplus: float

property consumption: float

conversion_rate: int

property dump_load: float

end_time_us: datetime

export_to_csv(path: str, overwrite_existing=False) → str

property producer_surplus: float

property production: float

property production_cost: float

property pump_consumption: float

property rationing: float

property reservoir_filling: float

run_id: str

scenario_id: str

property socio_economic_surplus: float

start_time_us: datetime

to_ascii_table() → str: Formats the report into a ascii table, which can be directly printed

to_dict() → dict

property transmission_congestion_rent: float

property transmission_loss: float

unit: str

trident_extras.post_processing.socio_economic_surplus.calc_socio_economic_surplus(rc: RunConfig, lm: LogicalModel, input_ds: DataStore, result_ds: DataStore) → SocioEconomicSurplusReport: Calculates the socio-economic surplus for a ngltm run