WxData

Return To WxData Wiki Main Page

FEMS: Single RAWS Station NFDRS (Fuels) Forecast

def get_single_raws_station_nfdrs_forecast(station_id, 
                                        fuel_model='Y', 
                                        clear_recycle_bin=False,
                                        path=f'{folder_modified}/FEMS Data/Single Station/NFDRS Forecasts',
                                        proxies=None,
                                        clear_data=True,
                                        meta_path=f'{folder_modified}/FEMS Data/Station Meta Data',
                                        sheet_name='Sheet1'):

This function retrieves the 7-Day NFDRS (fuels) forecast for a user-specified single RAWS station.

{folder_modified} = Current Working Directory

Required Arguments:

1) station_id (Integer) - The RAWS ID of the station.

Optional Arguments:

1) fuel_model (String) - Default = ‘Y’. The fuel model being used.

    Fuel Models List:

    Y - Timber
    X - Brush
    W - Grass/Shrub
    V - Grass
    Z - Slash

2) clear_recycle_bin (Boolean) - Default=False. When set to True, the contents in your recycle/trash bin will be deleted with each run of the program you are calling WxData. This setting is to help preserve memory on the machine.

3) path (String) - Default=f’{folder_modified}/FEMS Data/Single Station/NFDRS Forecasts’. The directory the data will be saved to.

4) proxies (dict or None) - Default=None. If the user is using proxy server(s), the user must change the following:

   proxies=None ---> proxies={
                           'http':'http://your-proxy-address:port',
                           'https':'http://your-proxy-address:port'
                           }

5) clear_data (Boolean) - Default=True. When set to True, the data directory clears out and new data is downloaded.

6) meta_path (String) - Default=f’{folder_modified}/FEMS Data/Station Meta Data’. The path to where the RAWS station meta data excel file will be saved to.

7) sheet_name (String) - The name of the sheet in the excel file to be converted into a pandas.DataFrame.

Returns

1) A Pandas DataFrame of 7-Day NFDRS (fuels) forecast data for a user-specified single RAWS station.

2) A Pandas DataFrame of the RAWS Station Meta-Data.