Electrification.collect_ohns_codes¶

Electrification.collect_ohns_codes(confirmation_required=True, verbose=False)[source]¶

Collect codes for overhead line electrification neutral sections (OHNS) from source web page.

Parameters

confirmation_required (bool) – whether to require users to confirm and proceed, defaults to True
verbose (bool or int) – whether to print relevant information in console as the function runs, defaults to False

Returns

OHNS codes

Return type

dict or None

Example:

>>> from pyrcs.line_data import Electrification

>>> elec = Electrification()

>>> ohns_dat = elec.collect_ohns_codes(confirmation_required=False)

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

>>> print(ohns_dat['National network neutral sections'].head())
    ELR         OHNS Name  Mileage    Tracks Dates
0  ARG1        Rutherglen   0m 3ch
1  ARG2   Finnieston East  4m 23ch      Down
2  ARG2   Finnieston West  4m 57ch        Up
3  AYR1  Shields Junction  0m 68ch    Up Ayr
4  AYR1  Shields Junction  0m 69ch  Down Ayr