SignalBoxes.fetch_ireland_codes

SignalBoxes.fetch_ireland_codes(update=False, dump_dir=None, verbose=False)

Fetch data of Irish signal cabin prefix codes.

Parameters

• update (bool) – whether to do an update check (for the package data), defaults to False

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

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

Returns

signal box prefix codes of Ireland

Return type

dict

Examples:

>>> from pyrcs.other_assets import SignalBoxes  # from pyrcs import SignalBoxes

>>> sb = SignalBoxes()

>>> ireland_sb_codes = sb.fetch_ireland_codes()
>>> type(ireland_sb_codes)
dict
>>> list(ireland_sb_codes.keys())
['Ireland', 'Notes', 'Last updated date']

>>> sb.KEY_TO_IRELAND
'Ireland'

>>> ireland_sb_codes_dat = ireland_sb_codes[sb.KEY_TO_IRELAND]
>>> type(ireland_sb_codes_dat)
pandas.core.frame.DataFrame
>>> ireland_sb_codes_dat.head()
   Code Signal Cabin                    Note
0    AD     Adelaide
1    AN       Antrim
2    AE      Athlone
3  AE R                      Distant signals
4    XG               Level crossing signals