TrackDataset.rank_storm

TrackDataset.rank_storm(metric, return_df=True, ascending=False, domain=None, year_range=None, date_range=None, subtropical=True)[source]

Ranks storm by a specified metric.

Parameters

  • metric (str) –

    Metric to rank storms by. Can be any of the following:

    • ace = rank storms by ACE

    • start_lat = starting latitude of cyclone

    • start_lon = starting longitude of cyclone

    • end_lat = ending latitude of cyclone

    • end_lon = ending longitude of cyclone

    • start_date = formation date of cyclone

    • start_date_indomain = first time step a cyclone entered the domain

    • max_wind = first instance of the maximum sustained wind of cyclone

    • min_mslp = first instance of the minimum MSLP of cyclone

    • wind_ge_XX = first instance of wind greater than/equal to a certain threshold (knots)

  • return_df (bool) – Whether to return a pandas.DataFrame (True) or dict (False). Default is True.

  • ascending (bool) – Whether to return rank in ascending order (True) or descending order (False). Default is False.

  • domain (str) – Geographic domain. Default is entire basin. Please refer to Map Domain Options for available domain options.

  • year_range (list or tuple) – List or tuple representing the start and end years (e.g., (1950,2018)). Default is start and end years of dataset.

  • date_range (list or tuple) – List or tuple representing the start and end dates in ‘month/day’ format (e.g., (6/1,8/15)). Default is entire year.

  • subtropical (bool) – Whether to include subtropical storms in the ranking. Default is True.

Returns

pandas.DataFrame – Returns a pandas DataFrame containing ranked storms. If pandas is not installed, a dict will be returned instead.