empire.output_client package

Submodules

empire.output_client.client module

class empire.output_client.client.EmpireOutputClient(output_path)

Bases: object

A output client for to the Empire dataset.

Note that API calls are cached, and changes to underlying dataset will not be detected by the client.

Parameters:

output_path (Path) –

get_curtailed_operational()

Retrieve the curtailment for each node, period, hour and RES technology.

Returns:

A DataFrame containing the curtailed operational data.

Return type:

DataFrame

get_curtailed_production()

Retrieve the expected annual curtailment for each node and period.

Returns:

A DataFrame containing the curtailed production data.

Return type:

DataFrame

get_europe_plot_generator_annual_production()

Retrieve the expected annual production of generators in each period. Values in GWh.

Returns:

A DataFrame containing the annual production of generators.

Return type:

DataFrame

get_europe_plot_generator_installed_capacity()

Retrieve the installed capacity of generators in each period. Values in MW.

Returns:

A DataFrame containing the installed capacity of generators.

Return type:

DataFrame

get_europe_plot_storage_annual_discharge()

Retrieve the expected annual discharge of storages in each period. Values in GWh.

Returns:

A DataFrame containing the annual discharge of storages.

Return type:

DataFrame

get_europe_plot_storage_installed_capacity()

Retrieve the installed capacity of storages in each period. Values in MW.

Returns:

A DataFrame containing the installed capacity of storages.

Return type:

DataFrame

get_europe_plot_storage_installed_energy()

Retrieve the installed energy of storages in each period. Values in GWh(?).

Returns:

A DataFrame containing the installed capacity of storages.

Return type:

DataFrame

get_europe_summary_emission_and_energy()

Retrieve emission and energy data from the Europe summary.

Returns:

DataFrame containing the data.

Return type:

DataFrame

get_europe_summary_generator_types()

Retrieve generator types data from the Europe summary.

Returns:

DataFrame containing the data.

Return type:

DataFrame

get_europe_summary_storage_types()

Retrieve storage types data from the Europe summary.

Returns:

DataFrame containing the data.

Return type:

DataFrame

get_generators_values()

Retrieve values for generators in the nodes.

Returns:

A DataFrame containing the generator values.

Return type:

DataFrame

get_node_operational_values(node=None)

Retrieve operational values for a specific node.

Parameters:

node (str | None) – The node to filter by. Defaults to None.

Returns:

A DataFrame containing the operational values for the specified node.

Return type:

DataFrame

get_objective()

Retrieve the objective value of the model.

Returns:

The objective value as a float.

Raises:

ValueError – If unable to parse the objective value from the file.

Return type:

float

get_storage_values()

Retrieve values for storages in the nodes.

Returns:

A DataFrame containing the storage values.

Return type:

DataFrame

get_transmission_operational(node=None)

Retrieve operational transmission data, optionally filtered by a specific node.

Parameters:

node (str | None) – The node to filter by. Defaults to None.

Returns:

A DataFrame containing the operational transmission data.

Return type:

DataFrame

get_transmission_values()

Retrieve values of transmission lines between nodes.

Returns:

A DataFrame containing the transmission values.

Return type:

DataFrame

class empire.output_client.client.ResultFile(curtailed_prod: str = 'results_output_curtailed_prod.csv', curtailed_operational: str = 'results_output_curtailed_operational.csv', transmision_operational: str = 'results_output_transmision_operational.csv', stor: str = 'results_output_stor.csv', operational: str = 'results_output_Operational.csv', transmision: str = 'results_output_transmision.csv', objective: str = 'results_objective.csv', europe_plot: str = 'results_output_EuropePlot.csv', europe_summary: str = 'results_output_EuropeSummary.csv', gen: str = 'results_output_gen.csv')

Bases: object

Parameters:

• curtailed_prod (str) –

• curtailed_operational (str) –

• transmision_operational (str) –

• stor (str) –

• operational (str) –

• transmision (str) –

• objective (str) –

• europe_plot (str) –

• europe_summary (str) –

• gen (str) –

curtailed_operational: str = 'results_output_curtailed_operational.csv'

curtailed_prod: str = 'results_output_curtailed_prod.csv'

europe_plot: str = 'results_output_EuropePlot.csv'

europe_summary: str = 'results_output_EuropeSummary.csv'

gen: str = 'results_output_gen.csv'

objective: str = 'results_objective.csv'

operational: str = 'results_output_Operational.csv'

stor: str = 'results_output_stor.csv'

transmision: str = 'results_output_transmision.csv'

transmision_operational: str = 'results_output_transmision_operational.csv'

Module contents