yards_to_nr_mileage¶

pyrcs.utils.yards_to_nr_mileage(yards)[source]¶

Convert yards to Network Rail mileages.

Parameters: yards (int or float or numpy.nan or None) – yards
Returns: Network Rail mileage in the form ‘<miles>.<yards>’
Return type: str

Examples:

>>> from pyrcs.utils import yards_to_nr_mileage

>>> yards_dat = 396
>>> mileage_dat = yards_to_nr_mileage(yards_dat)
>>> print(mileage_dat)
0.0396
>>> type(mileage_dat)
<class 'str'>

>>> yards_dat = 396.0
>>> mileage_dat = yards_to_nr_mileage(yards_dat)
>>> print(mileage_dat)
0.0396
>>> type(mileage_dat)
<class 'str'>

>>> yards_dat = None
>>> mileage_dat = yards_to_nr_mileage(yards_dat)
>>> print(mileage_dat)

>>> type(mileage_dat)
<class 'str'>