Electrification.fetch_national_network_codes¶

Electrification.fetch_national_network_codes(update=False, dump_dir=None, verbose=False, **kwargs)[source]¶

Fetch section codes for Overhead Line Electrification (OLE) installations on the national network.

Parameters:

update (bool) – Whether to check for updates to the package data; defaults to False.
dump_dir (str | None) – Path to a directory where the data file will be saved; defaults to None.
verbose (bool | int) – Whether to print relevant information to the console; defaults to False.

Returns:

A dictionary of OLE section codes for the national network, or None if not applicable.

Return type:

dict | None

Examples:

>>> from pyrcs.line_data import Electrification  # from pyrcs import Electrification

>>> elec = Electrification()

>>> nn_codes = elec.fetch_national_network_codes()
>>> type(nn_codes)
dict
>>> list(nn_codes.keys())
['National network', 'Last updated date']

>>> nn_codes_dat = nn_codes['National network']  # elec.KEY_TO_NATIONAL_NETWORK
>>> type(nn_codes_dat)
dict
>>> list(nn_codes_dat.keys())
['Traditional numbering system [distance and sequence]',
 'New numbering system [km and decimal]',
 'Codes not certain [confirmation is welcome]',
 'Suspicious data',
 'An odd one to complete the record',
 'LBSC/Southern Railway overhead system',
 'Codes not known']

>>> tns_codes = nn_codes_dat['Traditional numbering system [distance and sequence]']
>>> type(tns_codes)
dict
>>> list(tns_codes.keys())
['Codes', 'Notes']

>>> tns_codes_dat = tns_codes['Codes']
>>> tns_codes_dat.shape
(577, 5)
>>> tns_codes_dat.head()
  Code  ...                                               Note
0    A  ...
1    A  ...  Only a short length at Newbridge Junction wire...
2    A  ...
3    A  ...  Former DC system, now closed; it appears that ...
4   AB  ...              Reported, probably never used.  See F
[5 rows x 5 columns]