Features.fetch_water_troughs

Features.fetch_water_troughs(update=False, pickle_it=False, data_dir=None, verbose=False)

Fetch codes of water troughs 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 water troughs, and date of when the data was last updated

Return type

dict

Example:

>>> from pyrcs.other_assets import Features

>>> features = Features()

>>> # wt_codes_dat = features.fetch_water_troughs(update=True, verbose=True)
>>> wt_codes_dat = features.fetch_water_troughs()

>>> type(wt_codes_dat)
dict
>>> list(wt_codes_dat.keys())
['Water troughs', 'Last updated date']

>>> print(features.WaterTroughsKey)
Water troughs

>>> wt_codes = wt_codes_dat[features.WaterTroughsKey]

>>> type(wt_codes)
pandas.core.frame.DataFrame
>>> wt_codes.head()
    ELR  Trough Name  ...                                        Notes
0   BEI    Eckington  ...                               Installed 1904
1   BHL  Aldermaston  ...                            Installed by 1904
2  CGJ2        Moore  ...                              Installed 1860s
3  CGJ6     Lea Road  ...  Installed 1885, taken out of use 8 May 1967
4  CGJ6        Brock  ...                              Installed 1860s
[5 rows x 5 columns]