ELRMileages.fetch_mileage_file

ELRMileages.fetch_mileage_file(elr, update=False, pickle_it=False, data_dir=None, verbose=False)[source]

Fetch mileage file for the given ELR from local backup.

Parameters

  • elr (str) – elr: ELR, e.g. 'CJD', 'MLA', 'FED'

  • 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 or None) – name of package data folder, defaults to None

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

Returns

mileage file (codes), line name and, if any, additional information/notes

Return type

dict

Example:

>>> from pyrcs.line_data import ELRMileages

>>> em = ELRMileages()

>>> mileage_dat = em.fetch_mileage_file('MLA')

>>> type(mileage_dat)
dict
>>> list(mileage_dat.keys())
['ELR', 'Line', 'Sub-Line', 'Mileage', 'Notes']

>>> type(mileage_dat['Mileage'])
dict
>>> list(mileage_dat['Mileage'].keys())
['Current measure', 'Original measure']
>>> print(mileage_dat['Mileage']['Current measure'])
  Mileage Mileage_Note Miles_Chains  ...       Link_1 Link_1_ELR Link_1_Mile_Chain
0  0.0000                      0.00  ...  MRL2 (4.44)       MRL2              4.44
1  0.0572                      0.26  ...         None
2  0.1540                      0.70  ...         None
3  0.1606                      0.73  ...         None
[4 rows x 8 columns]