Electrification¶

A class for collecting codes associated with British railway overhead electrification installations.

`Electrification.collect_codes_for_national_network`([…])	Collect OLE section codes for National network from source web page.
`Electrification.fetch_codes_for_national_network`([…])	Fetch OLE section codes for National network from local backup.
`Electrification.get_names_of_independent_lines`()	Get names of independent lines.
`Electrification.collect_codes_for_independent_lines`([…])	Collect OLE section codes for independent lines from source web page.
`Electrification.fetch_codes_for_independent_lines`([…])	Fetch OLE section codes for independent lines from local backup.
`Electrification.collect_codes_for_ohns`([…])	Collect codes for overhead line electrification neutral sections (OHNS) from source web page.
`Electrification.fetch_codes_for_ohns`([…])	Fetch codes for overhead line electrification neutral sections (OHNS) from local backup.
`Electrification.collect_codes_for_energy_tariff_zones`([…])	Collect OLE section codes for national network energy tariff zones from source web page.
`Electrification.fetch_codes_for_energy_tariff_zones`([…])	Fetch OLE section codes for national network energy tariff zones from source web page.
`Electrification.fetch_electrification_codes`([…])	Fetch OLE section codes in the electrification catalogue.

class pyrcs.line_data.Electrification(data_dir=None, update=False)[source]¶

A class for collecting codes associated with British railway overhead electrification installations.

Parameters:	data_dir (str, None) – name of data directory, defaults to `None` update (bool) – whether to check on update and proceed to update the package data, defaults to `False`

Example:

from pyrcs.line_data import Electrification

elec = Electrification()

print(elec.Name)
# Electrification masts and related features

print(elec.SourceURL)
# http://www.railwaycodes.org.uk/electrification/mast_prefix0.shtm

collect_codes_for_national_network(confirmation_required=True, verbose=False)[source]¶

Collect OLE section codes for National network from source web page.

Parameters:	confirmation_required (bool) – whether to require users to confirm and proceed, defaults to `True` verbose (bool, int) – whether to print relevant information in console as the function runs, defaults to `False`
Returns:	OLE section codes for National network
Return type:	dict, None

Example:

from pyrcs.line_data import Electrification

elec = Electrification()

confirmation_required = True

national_network_ole = elec.collect_codes_for_national_network(confirmation_required)
# To collect section codes for OLE installations: national network? [No]|Yes:
# >? yes

print(national_network_ole)
# {'National network': <code>,
#  'Last updated date': <date>}

fetch_codes_for_national_network(update=False, pickle_it=False, data_dir=None, verbose=False)[source]¶

Fetch OLE section codes for National network 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, None) – name of package data folder, defaults to `None` verbose (bool, int) – whether to print relevant information in console as the function runs, defaults to `False`
Returns:	OLE section codes for National network
Return type:	dict, None

Example:

from pyrcs.line_data import Electrification

elec = Electrification()

update = False
pickle_it = False
data_dir = None

national_network_ole = elec.fetch_codes_for_national_network(update, pickle_it, data_dir)

print(national_network_ole)
# {'National network': <code>,
#  'Last updated date': <date>}

get_names_of_independent_lines()[source]¶

Get names of independent lines.

Returns:	a list of independent line names
Return type:	list

Example:

from pyrcs.line_data import Electrification

elec = Electrification()

line_names = elec.get_names_of_independent_lines()

print(line_names)
# a list of independent line names

collect_codes_for_independent_lines(confirmation_required=True, verbose=False)[source]¶

Collect OLE section codes for independent lines from source web page.

Parameters:	confirmation_required (bool) – whether to require users to confirm and proceed, defaults to `True` verbose (bool, int) – whether to print relevant information in console as the function runs, defaults to `False`
Returns:	OLE section codes for independent lines
Return type:	dict, None

Example:

from pyrcs.line_data import Electrification

elec = Electrification()

confirmation_required = True

independent_lines_ole = elec.collect_codes_for_independent_lines(confirmation_required)
# To collect section codes for OLE installations: independent lines? [No]|Yes:
# >? yes

print(independent_lines_ole)
# {'Independent lines': <codes>,
#  'Last updated date': <date>}

fetch_codes_for_independent_lines(update=False, pickle_it=False, data_dir=None, verbose=False)[source]¶

Fetch OLE section codes for independent lines 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, None) – name of package data folder, defaults to `None` verbose (bool, int) – whether to print relevant information in console as the function runs, defaults to `False`
Returns:	OLE section codes for independent lines
Return type:	dict

Example:

from pyrcs.line_data import Electrification

elec = Electrification()

update = False
pickle_it = False
data_dir = None

independent_lines_ole = elec.fetch_codes_for_independent_lines(update, pickle_it, data_dir)

print(independent_lines_ole)
# {'Independent lines': <codes>,
#  'Last updated date': <date>}

collect_codes_for_ohns(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, int) – whether to print relevant information in console as the function runs, defaults to `False`
Returns:	OHNS codes
Return type:	dict, None

Example:

from pyrcs.line_data import Electrification

elec = Electrification()

confirmation_required = True

ohns_codes = elec.collect_codes_for_ohns(confirmation_required)
# To collect section codes for OLE installations: national network neutral sections? [No]|Yes:
# >? yes

print(ohns_codes)
# {'National network neutral sections': <codes>,
#  'Last updated date': <date>}

fetch_codes_for_ohns(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, None) – name of package data folder, defaults to `None` verbose (bool, 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()

update = False
pickle_it = False
data_dir = None

ohns_codes = elec.fetch_codes_for_ohns(update, pickle_it, data_dir)

print(ohns_codes)
# {'National network neutral sections': <codes>,
#  'Last updated date': <date>}

collect_codes_for_energy_tariff_zones(confirmation_required=True, verbose=False)[source]¶

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

Parameters:	confirmation_required (bool) – whether to require users to confirm and proceed, defaults to `True` verbose (bool, int) – whether to print relevant information in console as the function runs, defaults to `False`
Returns:	OLE section codes for national network energy tariff zones
Return type:	dict, None

Example:

from pyrcs.line_data import Electrification

elec = Electrification()

confirmation_required = True

etz_ole = elec.collect_codes_for_energy_tariff_zones(confirmation_required)
# To collect section codes for OLE installations: national network energy tariff zones? [No]|Yes:
# >? yes

print(etz_ole)
# {'National network energy tariff zones': <codes>,
#  'Last updated date': <date>}

fetch_codes_for_energy_tariff_zones(update=False, pickle_it=False, data_dir=None, verbose=False)[source]¶

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

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, None) – name of package data folder, defaults to `None` verbose (bool, int) – whether to print relevant information in console as the function runs, 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()

update = False
pickle_it = False
data_dir = None

etz_ole = elec.fetch_codes_for_energy_tariff_zones(update, pickle_it, data_dir)

print(etz_ole)
# {'National network energy tariff zones': <codes>,
#  'Last updated date': <date>}

fetch_electrification_codes(update=False, pickle_it=False, data_dir=None, verbose=False)[source]¶

Fetch OLE section codes in the electrification catalogue.

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, None) – name of package data folder, defaults to `None` verbose (bool, int) – whether to print relevant information in console as the function runs, defaults to `False`
Returns:	section codes for overhead line electrification (OLE) installations
Return type:	dict

Example:

from pyrcs.line_data import Electrification

elec = Electrification()

update = False
pickle_it = False
data_dir = None

ole_section_codes = elec.fetch_electrification_codes(update, pickle_it, data_dir)

print(ole_section_codes)
# {'Electrification': <codes>,
#  'Latest update date': <date>}