Electrification.fetch_ohns_codes

Electrification.fetch_ohns_codes(update=False, pickle_it=False, data_dir=None, verbose=False)[source]

Fetch codes for overhead line electrification neutral sections (OHNS) from local backup.

Parameters

  • update (bool) – whether to check on update and proceed to update the package data, defaults to False

  • pickle_it (bool) – whether to replace the current package data with newly collected data, defaults to False

  • data_dir (str or None) – name of package data folder, defaults to None

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

Returns

OHNS codes

Return type

dict

Example:

>>> from pyrcs.line_data import Electrification

>>> elec = Electrification()

>>> ohns_dat = elec.fetch_ohns_codes()

>>> type(ohns_dat)
<class 'dict'>
>>> print(list(ohns_dat.keys()))
['National network neutral sections', 'Last updated date']