Features

class pyrcs.other_assets.Features(data_dir=None, update=False, verbose=True)[source]

A class for collecting data of several infrastructure features, including HABDs and WILDs, water troughs locations, telegraph code words and buzzer codes.

Parameters:
  • data_dir (str | None) – The name of the directory for storing the data; defaults to None.

  • update (bool) – Whether to check for updates to the catalogue; defaults to False.

  • verbose (bool | int) – Whether to print relevant information to the console; defaults to True.

Variables:
  • catalogue (dict) – The catalogue of the data.

  • last_updated_date (str) – The date when the data was last updated.

  • data_dir (str) – The path to the directory containing the data.

  • current_data_dir (str) – The path to the current data directory.

Examples:

>>> from pyrcs.other_assets import Features  # from pyrcs import Features
>>> feats = Features()
>>> feats.NAME
'Infrastructure features'

Attributes

KEY

The key for accessing the data.

KEY_TO_BUZZER

The key for accessing the data of buzzer codes.

KEY_TO_HABD_WILD

The key for accessing the data of HABD and WILD.

KEY_TO_LAST_UPDATED_DATE

The key used to reference the last updated date in the data.

KEY_TO_TELEGRAPH

The key for accessing the data of telegraph codes.

KEY_TO_TROUGH

The key for accessing the data of water troughs.

NAME

The name of the data.

URL

The URL of the main web page for the data.

Methods

fetch_codes([update, dump_dir, verbose])

Fetches data of infrastructure features.