LocationIdentifiers.fetch_location_codes

LocationIdentifiers.fetch_location_codes(update=False, pickle_it=False, data_dir=None, verbose=False)

Fetch CRS, NLC, TIPLOC, STANME and STANOX codes 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

data of location codes and date of when the data was last updated

Return type

dict

Example:

>>> from pyrcs.line_data import LocationIdentifiers

>>> lid = LocationIdentifiers()

>>> # loc_dat = lid.fetch_location_codes(update=True, verbose=True)
>>> loc_dat = lid.fetch_location_codes()

>>> type(loc_dat)
dict
>>> list(loc_dat.keys())
['Location codes', 'Other systems', 'Additional notes', 'Last updated date']

>>> print(lid.Key)
Location codes

>>> loc_codes = loc_dat['Location codes']

>>> type(loc_codes)
pandas.core.frame.DataFrame
>>> loc_codes.head()
                               Location CRS  ... STANME_Note STANOX_Note
0                                Aachen      ...
1                    Abbeyhill Junction      ...
2                 Abbeyhill Signal E811      ...
3            Abbeyhill Turnback Sidings      ...
4  Abbey Level Crossing (Staffordshire)      ...
[5 rows x 12 columns]