empire.input_client package#

Submodules#

empire.input_client.client module#

class empire.input_client.client.BaseClient#

Bases: object

DEFAULT_SKIPROWS = None#
DEFAULT_STARTROW = None#
DEFAULT_USECOLS = None#
validate()#

Validate if the Excel file has the expected sheet names.

class empire.input_client.client.EmpireInputClient(dataset_path, engine='openpyxl')#

Bases: object

A unified interface (facade) for accessing various input clients related to the Empire dataset.

Parameters:

  • dataset_path (Path) – Base directory containing all datasets.

  • engine (str) – Engine to use for reading/writing Excel files. Default is “openpyxl”.

Variables:

  • dataset_path (Path) – The base directory containing all datasets.

  • engine (str) – The engine for reading/writing Excel files. Default is “openpyxl”.

  • sets (SetsClient) – Client for managing ‘Sets’ data.

  • generator (GeneratorClient) – Client for managing ‘Generator’ data.

  • nodes (NodeClient) – Client for managing ‘Node’ data.

  • transmission (TransmissionClient) – Client for managing ‘Transmission’ data.

  • storage (StorageClient) – Client for managing ‘Storage’ data.

  • general (GeneralClient) – Client for managing ‘General’ data.

class empire.input_client.client.GeneralClient(file, engine='openpyxl')#

Bases: BaseClient

Parameters:

engine (str) –

DEFAULT_SKIPROWS = 2#
DEFAULT_STARTROW = 2#
DEFAULT_USECOLS = [0, 1]#
get_co2_cap()#
get_co2_price()#
get_season_scale()#
set_co2_cap(df)#
Parameters:

df (DataFrame) –

set_co2_price(df)#
Parameters:

df (DataFrame) –

set_season_scale(df)#
Parameters:

df (DataFrame) –

class empire.input_client.client.GeneratorClient(file, engine='openpyxl')#

Bases: BaseClient

Parameters:

  • file (Path) –

  • engine (str) –

DEFAULT_SKIPROWS = 2#
DEFAULT_STARTROW = 2#
DEFAULT_USECOLS = [0, 1, 2]#
get_capital_costs()#
get_ccs_cost_ts_variable()#
get_co2_content()#
get_efficiency()#
get_fixed_om_costs()#
get_fuel_costs()#
get_generator_type_availability()#
get_initial_capacity()#
get_lifetime()#
get_max_built_capacity()#
get_max_installed_capacity()#
get_ramp_rate()#
get_ref_initial_capacity()#
get_scale_factor_initial_capacity()#
get_variable_om_costs()#
set_capital_costs(df)#
Parameters:

df (DataFrame) –

set_ccs_cost_ts_variable(df)#
Parameters:

df (DataFrame) –

set_co2_content(df)#
Parameters:

df (DataFrame) –

set_efficiency(df)#
Parameters:

df (DataFrame) –

set_fixed_om_costs(df)#
Parameters:

df (DataFrame) –

set_fuel_costs(df)#
Parameters:

df (DataFrame) –

set_generator_type_availability(df)#
Parameters:

df (DataFrame) –

set_initial_capacity(df)#
Parameters:

df (DataFrame) –

set_lifetime(df)#
Parameters:

df (DataFrame) –

set_max_built_capacity(df)#
Parameters:

df (DataFrame) –

set_max_installed_capacity(df)#
Parameters:

df (DataFrame) –

set_ramp_rate(df)#
Parameters:

df (DataFrame) –

set_ref_initial_capacity(df)#
Parameters:

df (DataFrame) –

set_scale_factor_initial_capacity(df)#
Parameters:

df (DataFrame) –

set_variable_om_costs(df)#
Parameters:

df (DataFrame) –

class empire.input_client.client.NodeClient(file, engine='openpyxl')#

Bases: BaseClient

Parameters:

  • file (Path) –

  • engine (str) –

DEFAULT_SKIPROWS = 2#
DEFAULT_STARTROW = 2#
DEFAULT_USECOLS = [0, 1, 2]#
get_electric_annual_demand()#
get_hydro_generators_max_annual_production()#
get_node_lost_load_cost()#
set_electric_annual_demand(df)#
Parameters:

df (DataFrame) –

set_hydro_generators_max_annual_production(df)#
Parameters:

df (DataFrame) –

set_node_lost_load_cost(df)#
Parameters:

df (DataFrame) –

class empire.input_client.client.SetsClient(file, engine='openpyxl')#

Bases: BaseClient

Parameters:

engine (str) –

DEFAULT_SKIPROWS = 0#
DEFAULT_STARTROW = 0#
DEFAULT_USECOLS = [0]#
get_coordinates()#
get_directional_lines()#
get_generators()#
get_generators_of_node()#
get_generators_of_technology()#
get_horizon()#
get_line_type()#
get_line_type_of_directional_lines()#
get_nodes()#
get_offshore_nodes()#
get_storage()#
get_storage_of_nodes()#
get_technology()#
set_coordinates(df)#
Parameters:

df (DataFrame) –

set_directional_lines(df)#
Parameters:

df (DataFrame) –

set_generators(df)#
Parameters:

df (DataFrame) –

set_generators_of_node(df)#
Parameters:

df (DataFrame) –

set_generators_of_technology(df)#
Parameters:

df (DataFrame) –

set_horizon(df)#
Parameters:

df (DataFrame) –

set_line_type(df)#
Parameters:

df (DataFrame) –

set_line_type_of_directional_lines(df)#
Parameters:

df (DataFrame) –

set_nodes(df)#
Parameters:

df (DataFrame) –

set_offshore_nodes(df)#
Parameters:

df (DataFrame) –

set_storage(df)#
Parameters:

df (DataFrame) –

set_storage_of_nodes(df)#
Parameters:

df (DataFrame) –

set_technology(df)#
Parameters:

df (DataFrame) –

class empire.input_client.client.StorageClient(file, engine='openpyxl')#

Bases: BaseClient

Parameters:

engine (str) –

DEFAULT_SKIPROWS = 2#
DEFAULT_STARTROW = 2#
DEFAULT_USECOLS = [0, 1]#
get_energy_capital_cost()#
get_energy_fixed_om_cost()#
get_energy_max_built_capacity()#
get_energy_max_installed_capacity()#
get_initial_energy_capacity()#
get_initial_power_capacity()#
get_lifetime()#
get_power_capital_cost()#
get_power_fixed_om_cost()#
get_power_max_built_capacity()#
get_power_max_installed_capacity()#
get_storage_bleed_efficiency()#
get_storage_charge_efficiency()#
get_storage_discharge_efficiency()#
get_storage_initial_energy_level()#
get_storage_power_to_energy()#
set_energy_capital_cost(df)#
Parameters:

df (DataFrame) –

set_energy_fixed_om_cost(df)#
Parameters:

df (DataFrame) –

set_energy_max_built_capacity(df)#
Parameters:

df (DataFrame) –

set_energy_max_installed_capacity(df)#
Parameters:

df (DataFrame) –

set_initial_energy_capacity(df)#
Parameters:

df (DataFrame) –

set_initial_power_capacity(df)#
Parameters:

df (DataFrame) –

set_lifetime(df)#
Parameters:

df (DataFrame) –

set_power_capital_cost(df)#
Parameters:

df (DataFrame) –

set_power_fixed_om_cost(df)#
Parameters:

df (DataFrame) –

set_power_max_built_capacity(df)#
Parameters:

df (DataFrame) –

set_power_max_installed_capacity(df)#
Parameters:

df (DataFrame) –

set_storage_bleed_efficiency(df)#
Parameters:

df (DataFrame) –

set_storage_charge_efficiency(df)#
Parameters:

df (DataFrame) –

set_storage_discharge_efficiency(df)#
Parameters:

df (DataFrame) –

set_storage_initial_energy_level(df)#
Parameters:

df (DataFrame) –

set_storage_power_to_energy(df)#
Parameters:

df (DataFrame) –

class empire.input_client.client.TransmissionClient(file, engine='openpyxl')#

Bases: BaseClient

Parameters:

  • file (Path) –

  • engine (str) –

DEFAULT_SKIPROWS = 2#
DEFAULT_STARTROW = 2#
DEFAULT_USECOLS = [0, 1, 2]#
get_initial_capacity()#
get_length()#
get_lifetime()#
get_line_efficiency()#
get_max_built_capacity()#
get_max_install_capacity_raw()#
get_type_capital_cost()#
get_type_fixed_om_cost()#
set_initial_capacity(df)#
Parameters:

df (DataFrame) –

set_length(df)#
Parameters:

df (DataFrame) –

set_lifetime(df)#
Parameters:

df (DataFrame) –

set_line_efficiency(df)#
Parameters:

df (DataFrame) –

set_max_built_capacity(df)#
Parameters:

df (DataFrame) –

set_max_install_capacity_raw(df)#
Parameters:

df (DataFrame) –

set_type_capital_cost(df)#
Parameters:

df (DataFrame) –

set_type_fixed_om_cost(df)#
Parameters:

df (DataFrame) –

empire.input_client.sheets_structure module#

Module contents#