Filter-stations

Retrieves ground truth data for a specified date range.

Parameters:
-----------
- start_date (str): The start date for the report in 'yyyy-mm-dd' format.
- end_date (str, optional): The end date for the report in 'yyyy-mm-dd' format.
If not provided, only data for the start_date is returned.

Returns:
-----------
- pandas.DataFrame: A DataFrame containing ground truth data with columns 'startDate',
'station_sensor', 'description' and 'level'. The 'startDate' column is used as the index.

Raises:
-----------
- Exception: If there's an issue with the API request.

Usage:
-----------
To retrieve ground truth data for a specific date range:
python
start_date = '2023-01-01'
end_date = '2023-01-31'
report_data = ret.ground_truth(start_date, end_date)


To retrieve ground truth data for a specific date:

start_date = '2023-01-01'
report_data = ret.ground_truth(start_date)

Subsets weather stations by a specific geographical region and optionally plots them on a map with a scale bar.

Parameters:
-----------
- region (str): The name of the region to subset stations from (47 Kenyan counties).
- plot (bool, optional): If True, a map with stations and a scale bar is plotted. Default is False.

Returns:
-----------
- list or None: If plot is False, returns a list of station codes in the specified region. Otherwise, returns None.

Usage:
-----------
To get a list of station codes in the 'Nairobi' region without plotting:

fs = Filter(api_key, api_secret, maps_key) Create an instance of your class
station_list = fs.stations_region('Nairobi')


To subset stations in the 'Nairobi' region and display them on a map with a scale bar:

fs = Filter(api_key, api_secret, maps_key) Create an instance of your class
fs.stations_region('Nairobi', plot=True)

<div align="center">
<img src="https://github.com/kaburia/Packaging/assets/88529649/98af7d1e-19ca-4efd-8a94-d187faf4c6ec" alt="Nairobi Region Map">
</div>