Electrification.fetch_etz_codes

Electrification.fetch_etz_codes(update=False, pickle_it=False, data_dir=None, verbose=False)

Fetch OLE section codes for national network energy tariff zones from source web page.

Parameters

  • update (bool) – whether to do an update check (for the package data), defaults to False

  • pickle_it (bool) – whether to save the data as a pickle file, defaults to False

  • data_dir (str or None) – name of a folder where the pickle file is to be saved, defaults to None

  • verbose (bool or int) – whether to print relevant information in console, defaults to False

Returns

OLE section codes for national network energy tariff zones

Return type

dict

Example:

>>> from pyrcs.line_data import Electrification

>>> elec = Electrification()

>>> # etz_ole_dat = elec.fetch_etz_codes(update=True, verbose=True)
>>> etz_ole_dat = elec.fetch_etz_codes()

>>> type(etz_ole_dat)
dict
>>> list(etz_ole_dat.keys())
['National network energy tariff zones', 'Last updated date']

>>> print(elec.TariffZonesKey)
National network energy tariff zones

>>> tariff_zone_codes = etz_ole_dat[elec.TariffZonesKey]

>>> type(tariff_zone_codes)
dict
>>> list(tariff_zone_codes.keys())
['Railtrack', 'Notes', 'Network Rail']