Electrification.fetch_ohns_codes

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

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

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

OHNS codes

Return type

dict

Example:

>>> from pyrcs.line_data import Electrification

>>> elec = Electrification()

>>> # ohns_dat = elec.fetch_ohns_codes(update=True, verbose=True)
>>> ohns_dat = elec.fetch_ohns_codes()

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

>>> print(elec.OhnsKey)
National network neutral sections

>>> o_codes = ohns_dat[elec.OhnsKey]

>>> type(o_codes)
pandas.core.frame.DataFrame
>>> o_codes.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