windborne 1.1.5__py3-none-any.whl → 1.2.1__py3-none-any.whl

windborne/__init__.py

@@ -22,10 +22,12 @@ from .data_api import (
 from .forecasts_api import (
     get_point_forecasts,
     get_initialization_times,
+    get_forecast_hours,
 
+    get_gridded_forecast,
     get_full_gridded_forecast,
     get_temperature_2m,
-    # get_dewpoint_2m,
+    get_dewpoint_2m,
     get_wind_u_10m, get_wind_v_10m,
     get_pressure_msl,
     get_500hpa_wind_u, get_500hpa_wind_v,
@@ -58,10 +60,12 @@ __all__ = [
 
     "get_point_forecasts",
     "get_initialization_times",
+    "get_forecast_hours",
 
+    "get_gridded_forecast",
     "get_full_gridded_forecast",
     "get_temperature_2m",
-    # "get_dewpoint_2m",
+    "get_dewpoint_2m",
     "get_wind_u_10m",
     "get_wind_v_10m",
     "get_500hpa_wind_u",

windborne/api_request.py

@@ -199,6 +199,9 @@ def make_api_request(url, params=None, as_json=True, retry_counter=0):
                     mission_id = url.split('/missions/')[1].split('/')[0]
                     print(f"Mission ID provided: {mission_id}")
                     print(f"No mission found with id: {mission_id}")
+            print("-------------------------------------------------------")
+            print("Response text:")
+            print(http_err.response.text)
             return None
         elif http_err.response.status_code == 502:
             print(f"Temporary connection failure; sleeping for {2**retry_counter}s before retrying")
@@ -223,4 +226,4 @@ def make_api_request(url, params=None, as_json=True, retry_counter=0):
         time.sleep(2**retry_counter)
         return make_api_request(url, params, as_json, retry_counter + 1)
     except requests.exceptions.RequestException as req_err:
-        print(f"An error occurred\n\n{req_err}")
+        print(f"An error occurred\n\n{req_err}")

windborne/cli.py

@@ -19,18 +19,9 @@ from . import (
 
     get_point_forecasts,
     get_initialization_times,
+    get_forecast_hours,
     get_full_gridded_forecast,
-    get_temperature_2m,
-    # get_dewpoint_2m,
-    get_wind_u_10m, get_wind_v_10m,
-    get_500hpa_wind_u, get_500hpa_wind_v,
-    get_500hpa_temperature, get_850hpa_temperature,
-    get_pressure_msl,
-    get_500hpa_geopotential, get_850hpa_geopotential,
-
-    get_historical_temperature_2m,
-    get_historical_500hpa_geopotential,
-    get_historical_500hpa_wind_u, get_historical_500hpa_wind_v,
+    get_gridded_forecast,
     get_tropical_cyclones
 
 )
@@ -156,70 +147,73 @@ def main():
 
     # GRIDDED FORECASTS
     ####################################################################################################################
-    full_gridded_parser = subparsers.add_parser('grid_full', help='Get full gridded forecast')
-    full_gridded_parser.add_argument('args', nargs='*', help='time output_file')
-
-    # Gridded 2m temperature Command
-    gridded_temperature_2m_parser = subparsers.add_parser('grid_temp_2m', help='Get gridded output of global 2m temperature forecasts')
-    gridded_temperature_2m_parser.add_argument('args', nargs='*', help='time output_file')
-
-    # Gridded 2m dewpoint Command
-    gridded_dewpoint_2m_parser = subparsers.add_parser('grid_dewpoint_2m', help='Get gridded output of global dewpoint forecasts')
-    gridded_dewpoint_2m_parser.add_argument('args', nargs='*', help='time output_file')
-
-    # Gridded wind-u 10m Command
-    gridded_wind_u_10m_parser = subparsers.add_parser('grid_wind_u_10m', help='Get gridded output of global 10m u-component of wind forecasts')
-    gridded_wind_u_10m_parser.add_argument('args', nargs='*', help='time output_file')
-
-    # Gridded wind-v 10m Command
-    gridded_wind_v_10m_parser = subparsers.add_parser('grid_wind_v_10m', help='Get gridded output of global 10m v-component of wind forecasts')
-    gridded_wind_v_10m_parser.add_argument('args', nargs='*', help='time output_file')
-
-    # Gridded 500hPa wind-u Command
-    gridded_500hpa_wind_u_parser = subparsers.add_parser('grid_500hpa_wind_u', help='Get gridded output of global 500hPa wind v-component of wind forecasts')
-    gridded_500hpa_wind_u_parser.add_argument('args', nargs='*', help='time output_file')
-
-    # Gridded 500hPa wind-v Command
-    gridded_500hpa_wind_v_parser = subparsers.add_parser('grid_500hpa_wind_v', help='Get gridded output of global 500hPa wind u-component of wind forecasts')
-    gridded_500hpa_wind_v_parser.add_argument('args', nargs='*', help='time output_file')
-
-    # Gridded 500hPa temperature Command
-    gridded_500hpa_temperature_parser = subparsers.add_parser('grid_500hpa_temperature', help='Get gridded output of global 500hPa temperature forecasts')
-    gridded_500hpa_temperature_parser.add_argument('args', nargs='*', help='time output_file')
-
-    # Gridded 850hPa temperature Command
-    gridded_850hpa_temperature_parser = subparsers.add_parser('grid_850hpa_temperature', help='Get gridded output of global 850hPa temperature forecasts')
-    gridded_850hpa_temperature_parser.add_argument('args', nargs='*', help='time output_file')
-
-    # Gridded mean sea level pressure Command
-    gridded_pressure_msl_parser = subparsers.add_parser('grid_pressure_msl', help='Get gridded output of global mean sea level pressure forecasts')
-    gridded_pressure_msl_parser.add_argument('args', nargs='*', help='time output_file')
-
-    # Gridded 500hPa geopotential Command
-    gridded_500hpa_geopotential_parser = subparsers.add_parser('grid_500hpa_geopotential', help='Get gridded output of global 500hPa geopotential forecasts')
-    gridded_500hpa_geopotential_parser.add_argument('args', nargs='*', help='time output_file')
+    gridded_parser = subparsers.add_parser('gridded', help='Get gridded forecast for a variable')
+    gridded_parser.add_argument('args', nargs='*', help='variable time output_file')
+    gridded_parser.add_argument('-i', '--intracycle', action='store_true', help='Use the intracycle forecast')
+    gridded_parser.add_argument('-e', '--ens-member', help='Ensemble member (eg 1 or mean)')
 
-    # Gridded 850hPa geopotential Command
-    gridded_850hpa_geopotential_parser = subparsers.add_parser('grid_850hpa_geopotential', help='Get gridded output of global 500hPa geopotential forecasts')
-    gridded_850hpa_geopotential_parser.add_argument('args', nargs='*', help='time output_file')
+    hist_gridded_parser = subparsers.add_parser('hist_gridded', help='Get historical gridded forecast for a variable')
+    hist_gridded_parser.add_argument('args', nargs='*', help='variable initialization_time forecast_hour output_file')
+    hist_gridded_parser.add_argument('-i', '--intracycle', action='store_true', help='Use the intracycle forecast')
+    hist_gridded_parser.add_argument('-e', '--ens-member', help='Ensemble member (eg 1 or mean)')
 
-    # HISTORICAL FORECASTS
-    ####################################################################################################################
-    # Historical 500hpa geopotential Command
-    historical_temperature_2m_parser = subparsers.add_parser('hist_temp_2m', help='Get historical output of global temperature forecasts')
-    historical_temperature_2m_parser.add_argument('args', nargs='*', help='initialization_time forecast_hour output_file')
-
-    # Historical 500hpa geopotential Command
-    historical_500hpa_geopotential_parser = subparsers.add_parser('hist_500hpa_geopotential', help='Get historical output of global 500hPa geopotential forecasts')
-    historical_500hpa_geopotential_parser.add_argument('args', nargs='*', help='initialization_time forecast_hour output_file')
-
-    # Historical 500hpa wind u Command
-    historical_500hpa_wind_u_parser = subparsers.add_parser('hist_500hpa_wind_u', help='Get historical output of global 500hPa wind u forecasts')
-    historical_500hpa_wind_u_parser.add_argument('args', nargs='*', help='initialization_time forecast_hour output_file')
+    full_gridded_parser = subparsers.add_parser('grid_full', help='Get full gridded forecast')
+    full_gridded_parser.add_argument('args', nargs='*', help='time output_file')
 
-    # Historical 500hpa wind v Command
-    historical_500hpa_wind_v_parser = subparsers.add_parser('hist_500hpa_wind_v', help='Get historical output of global 500hPa wind v forecasts')
-    historical_500hpa_wind_v_parser.add_argument('args', nargs='*', help='initialization_time forecast_hour output_file')
+    # Define variables for gridded forecasts - the command name will be derived from the variable name
+    # except for special cases like temperature_2m -> temp_2m
+    gridded_variables = [
+        'temperature_2m',
+        'dewpoint_2m',
+        'wind_u_10m',
+        'wind_v_10m',
+        'pressure_msl',
+        '500/temperature',
+        '500/wind_u',
+        '500/wind_v',
+        '500/geopotential',
+        '850/temperature',
+        '850/geopotential'
+    ]
+
+    gridded_human_names = {
+        'temperature_2m': '2m temperature',
+        'dewpoint_2m': '2m dewpoint',
+        'wind_u_10m': '10m u-component of wind',
+        'wind_v_10m': '10m v-component of wind',
+    }
+
+    gridded_forecast_mapping = {}
+    for var in gridded_variables:
+        cmd_name = var.replace('/', 'hpa_')
+        if var == 'temperature_2m':
+            cmd_name = 'temp_2m'
+
+        human_name = gridded_human_names.get(var, var)
+        if '/' in var:
+            level, real_var = var.split('/')
+            human_name = f"{level}hPa {real_var}"
+
+        gridded_forecast_mapping[cmd_name] = {
+            'variable': var,
+            'human_name': human_name
+        }
+
+    # Dynamically create parsers for gridded forecasts
+    for cmd_name, config in gridded_forecast_mapping.items():
+        grid_help = f"Get gridded output of global {config['human_name']} forecasts"
+        grid_parser = subparsers.add_parser(f'grid_{cmd_name}', help=grid_help)
+        grid_parser.add_argument('args', nargs='*', help='time output_file')
+        grid_parser.add_argument('-i', '--intracycle', action='store_true', help='Use the intracycle forecast')
+        grid_parser.add_argument('-e', '--ens-member', help='Ensemble member (eg 1 or mean)')
+        grid_parser.set_defaults(variable=config['variable'])
+
+        hist_help = f"Get historical output of global {config['human_name']} forecasts"
+        hist_parser = subparsers.add_parser(f'hist_{cmd_name}', help=hist_help)
+        hist_parser.add_argument('args', nargs='*', help='initialization_time forecast_hour output_file')
+        hist_parser.add_argument('-i', '--intracycle', action='store_true', help='Use the intracycle forecast')
+        hist_parser.add_argument('-e', '--ens-member', help='Ensemble member (eg 1 or mean)')
+        hist_parser.set_defaults(variable=config['variable'])
 
     # OTHER
     # TCS
@@ -233,7 +227,13 @@ def main():
 
     # Initialization Times Command
     initialization_times_parser = subparsers.add_parser('init_times', help='Get available initialization times for point forecasts')
+    initialization_times_parser.add_argument('-i', '--intracycle', action='store_true', help='Use the intracycle forecast')
+    initialization_times_parser.add_argument('-e', '--ens-member', help='Ensemble member (eg 1 or mean)')
 
+    # Forecast Hours Command
+    forecast_hours_parser = subparsers.add_parser('forecast_hours', help='Get available forecast hours for WeatherMesh')
+    forecast_hours_parser.add_argument('-i', '--intracycle', action='store_true', help='Use the intracycle forecast')
+    forecast_hours_parser.add_argument('-e', '--ens-member', help='Ensemble member (eg 1 or mean)')
 
     args = parser.parse_args()
 
@@ -432,201 +432,68 @@ def main():
         )
 
     elif args.command == 'init_times':
-        get_initialization_times(print_response=True)
-
-    if args.command == 'grid_full':
-        # Parse get_full_gridded_forecast arguments
-        if len(args.args) in [0,1]:
-            print("To get the full gridded forecast you need to provide the time for which to get the forecast and an output file.")
-            print("\nUsage: windborne get_full_gridded_forecast time output_file")
-        elif len(args.args) == 2:
-            get_full_gridded_forecast(time=args.args[0], output_file=args.args[1])
-        else:
-            print("Too many arguments")
-            print("\nUsage: windborne get_full_gridded_forecast time output_file")
+        get_initialization_times(print_response=True, ensemble_member=args.ens_member, intracycle=args.intracycle)
 
-    elif args.command == 'grid_temp_2m':
-        # Parse grid_temp_2m arguments
-        if len(args.args) in [0,1]:
-            print("To get the gridded output of global 2m temperature forecast you need to provide the time for which to get the forecast and an output file.")
-            print("\nUsage: windborne grid_temp_2m time output_file")
-        elif len(args.args) == 2:
-            get_temperature_2m(time=args.args[0], output_file=args.args[1])
-        else:
-            print("Too many arguments")
-            print("\nUsage: windborne grid_temp_2m time output_file")
-
-    # elif args.command == 'grid_dewpoint_2m':
-    #     # Parse grid_dewpoint_2m arguments
-    #     if len(args.args) in [0,1]:
-    #         print(f"To get the gridded output of global 2m dew point forecast you need to provide the time for which to get the forecast and an output file.")
-    #         print("\nUsage: windborne grid_dewpoint_2m time output_file")
-    #     elif len(args.args) == 2:
-    #         get_dewpoint_2m(time=args.args[0], output_file=args.args[1])
-    #     else:
-    #         print("Too many arguments")
-    #         print("\nUsage: windborne grid_dewpoint_2m time output_file")
-
-    elif args.command == 'grid_wind_u_10m':
-        # Parse grid_wind_u_10m arguments
-        if len(args.args) in [0,1]:
-            print(f"To get the gridded output of global 10m u-component of wind forecasts you need to provide the time for which to get the forecast and an output file.")
-            print("\nUsage: windborne grid_wind_u_10m time output_file")
-        elif len(args.args) == 2:
-            get_wind_u_10m(time=args.args[0], output_file=args.args[1])
-        else:
-            print("Too many arguments")
-            print("\nUsage: windborne grid_wind_u_10m time output_file")
-
-    elif args.command == 'grid_wind_v_10m':
-        # Parse grid_wind_v_10m arguments
-        if len(args.args) in [0,1]:
-            print(f"To get the gridded output of global 10m v-component of wind forecasts you need to provide the time for which to get the forecast and an output file.")
-            print("\nUsage: windborne grid_wind_v_10m time output_file")
-        elif len(args.args) == 2:
-            get_wind_v_10m(time=args.args[0], output_file=args.args[1])
-        else:
-            print("Too many arguments")
-            print("\nUsage: windborne grid_wind_v_10m time output_file")
-
-    elif args.command == 'grid_500hpa_wind_u':
-        # Parse grid_500hpa_wind_u arguments
-        if len(args.args) in [0,1]:
-            print(f"To get the gridded output of global 500hPa u-component of wind forecasts you need to provide the time for which to get the forecast and an output file.")
-            print("\nUsage: windborne grid_500hpa_wind_u time output_file")
-        elif len(args.args) == 2:
-            get_500hpa_wind_u(time=args.args[0], output_file=args.args[1])
-        else:
-            print("Too many arguments")
-            print("\nUsage: windborne grid_500hpa_wind_u time output_file")
+    elif args.command == 'forecast_hours':
+        get_forecast_hours(print_response=True, ensemble_member=args.ens_member, intracycle=args.intracycle)
 
-    elif args.command == 'grid_500hpa_wind_v':
-        # Parse grid_500hpa_wind_v arguments
-        if len(args.args) in [0,1]:
-            print(f"To get the gridded output of global 500hPa v-component of wind forecasts you need to provide the time for which to get the forecast and an output file.")
-            print("\nUsage: windborne grid_500hpa_wind_v time output_file")
-        elif len(args.args) == 2:
-            get_500hpa_wind_v(time=args.args[0], output_file=args.args[1])
-        else:
-            print("Too many arguments")
-            print("\nUsage: windborne grid_500hpa_wind_v time output_file")
-
-    elif args.command == 'grid_500hpa_temperature':
-        # Parse grid_500hpa_temperature arguments
-        if len(args.args) in [0,1]:
-            print(f"To get the gridded output of global 500hPa temperature forecasts you need to provide the time for which to get the forecast and an output file.")
-            print("\nUsage: windborne grid_500hpa_temperature time output_file")
-            return
-        elif len(args.args) == 2:
-            get_500hpa_temperature(time=args.args[0], output_file=args.args[1])
-        else:
-            print("Too many arguments")
-            print("\nUsage: windborne grid_500hpa_temperature time output_file")
-
-    elif args.command == 'grid_850hpa_temperature':
-        # Parse grid_850hpa_temperature arguments
-        if len(args.args) in [0,1]:
-            print(f"To get the gridded output of global 850hPa temperature forecasts you need to provide the time for which to get the forecast and an output file.")
-            print("\nUsage: windborne grid_850hpa_temperature time output_file")
-            return
-        elif len(args.args) == 2:
-            get_850hpa_temperature(time=args.args[0], output_file=args.args[1])
-        else:
-            print("Too many arguments")
-            print("\nUsage: windborne grid_850hpa_temperature time output_file")
-
-    elif args.command == 'grid_pressure_msl':
-        # Parse grid_pressure_msl arguments
-        if len(args.args) in [0,1]:
-            print(f"To get the gridded output of global mean sea level pressure forecasts you need to provide the time for which to get the forecast and an output file.")
-            print("\nUsage: windborne grid_pressure_msl time output_file")
-        elif len(args.args) == 2:
-            get_pressure_msl(time=args.args[0], output_file=args.args[1])
-        else:
-            print("Too many arguments")
-            print("\nUsage: windborne grid_pressure_msl time output_file")
-
-    elif args.command == 'grid_500hpa_geopotential':
-        # Parse grid_500hpa_geopotential arguments
-        if len(args.args) in [0,1]:
-            print(f"To get the gridded output of global 500hPa geopotential forecasts you need to provide the time for which to get the forecast and an output file.")
-            print("\nUsage: windborne grid_500hpa_geopotential time output_file")
-            return
-        elif len(args.args) == 2:
-            get_500hpa_geopotential(time=args.args[0], output_file=args.args[1])
-        else:
-            print("Too many arguments")
-            print("\nUsage: windborne grid_500hpa_geopotential time output_file")
-
-    elif args.command == 'grid_850hpa_geopotential':
-        # Parse grid_850hpa_geopotential arguments
-        if len(args.args) in [0,1]:
-            print(f"To get the gridded output of global 850hPa geopotential forecasts you need to provide the time for which to get the forecast and an output file.")
-            print("\nUsage: windborne grid_850hpa_geopotential time output_file")
-            return
-        elif len(args.args) == 2:
-            get_850hpa_geopotential(time=args.args[0], output_file=args.args[1])
-        else:
-            print("Too many arguments")
-            print("\nUsage: windborne grid_850hpa_geopotential time output_file")
-
-    # HISTORICAL
-
-    elif args.command == 'hist_temp_2m':
-        # Parse historical temperature arguments
-        if len(args.args) in [0,1,2]:
-            print("To get the historical output of global temperature forecasts you need to provide\n"
-                  "  - initialization time of the forecast\n"
-                  "  - How many hours after the run time the forecast is valid at\n"
-                  "  - An ouput file to save the data")
-            print("\nUsage: windborne hist_temp_2m initialization_time forecast_hour output_file")
-            return
-        elif len(args.args) == 3:
-            get_historical_temperature_2m(initialization_time=args.args[0], forecast_hour=args.args[1], output_file=args.args[2])
-        else:
-            print("Too many arguments")
-            print("\nUsage: windborne hist_temp_2m initialization_time forecast_hour output_file")
-
-    elif args.command == 'hist_500hpa_geopotential':
-        # Parse historical 500 hpa geopotential arguments
+    elif args.command == 'gridded':
         if len(args.args) in [0,1,2]:
-            print("To get the historical output of global 500hPa geopotential forecasts you need to provide\n"
-                  "  - initialization time of the forecast\n"
-                  "  - How many hours after the run time the forecast is valid at\n"
-                  "  - An ouput file to save the data")
-            print("\nUsage: windborne hist_500hpa_geopotential initialization_time forecast_hour output_file")
-            return
+            print(f"To get the gridded forecast for a variable you need to provide the variable, time, and an output file.")
+            print(f"\nUsage: windborne gridded variable time output_file")
         elif len(args.args) == 3:
-            get_historical_500hpa_geopotential(initialization_time=args.args[0], forecast_hour=args.args[1], output_file=args.args[2])
+            get_gridded_forecast(variable=args.args[0], time=args.args[1], output_file=args.args[2], ensemble_member=args.ens_member, intracycle=args.intracycle)
         else:
             print("Too many arguments")
-            print("\nUsage: windborne hist_500hpa_geopotential initialization_time forecast_hour output_file")
 
-    elif args.command == 'hist_500hpa_wind_u':
-        if len(args.args) in [0,1,2]:
-            print("To get the historical output of global 500hPa wind u forecasts you need to provide\n"
-                  "  - initialization time of the forecast\n"
-                  "  - How many hours after the run time the forecast is valid at\n"
-                  "  - An ouput file to save the data")
-            print("\nUsage: windborne hist_500hpa_wind_u initialization_time forecast_hour output_file")
-        elif len(args.args) == 3:
-            get_historical_500hpa_wind_u(initialization_time=args.args[0], forecast_hour=args.args[1], output_file=args.args[2])
+    elif args.command == 'grid_full':
+        if len(args.args) in [0,1]:
+            print("To get the full gridded forecast you need to provide the time for which to get the forecast and an output file.")
+            print("\nUsage: windborne grid_full time output_file")
+        elif len(args.args) == 2:
+            get_full_gridded_forecast(time=args.args[0], output_file=args.args[1])
         else:
             print("Too many arguments")
-            print("\nUsage: windborne hist_500hpa_wind_u initialization_time forecast_hour output_file")
-
-    elif args.command == 'hist_500hpa_wind_v':
-        if len(args.args) in [0,1,2]:
-            print("To get the historical output of global 500hPa wind v forecasts you need to provide\n"
-                  "  - initialization time of the forecast\n"
-                  "  - How many hours after the run time the forecast is valid at\n"
-                  "  - An ouput file to save the data")
-            print("\nUsage: windborne hist_500hpa_wind_u initialization_time forecast_hour output_file")
-        elif len(args.args) == 3:
-            get_historical_500hpa_wind_v(initialization_time=args.args[0], forecast_hour=args.args[1], output_file=args.args[2])
+            print("\nUsage: windborne grid_full time output_file")
+
+    elif args.command == 'hist_gridded':
+        if len(args.args) in [0,1,2,3]:
+            print(f"To get the historical gridded forecast for a variable you need to provide the variable, initialization time, forecast hour, and an output file.")
+            print(f"\nUsage: windborne hist_gridded variable initialization_time forecast_hour output_file")
+        elif len(args.args) == 4:
+            get_gridded_forecast(variable=args.args[0], initialization_time=args.args[1], forecast_hour=args.args[2], output_file=args.args[3], ensemble_member=args.ens_member, intracycle=args.intracycle)
         else:
             print("Too many arguments")
-            print("\nUsage: windborne hist_500hpa_wind_v initialization_time forecast_hour output_file")
+            print(f"\nUsage: windborne hist_gridded variable initialization_time forecast_hour output_file")
+
+    # Handle all gridded forecast commands
+    elif args.command.startswith('grid_'):
+        cmd_name = args.command[5:]  # Remove 'grid_' prefix
+        if cmd_name in gridded_forecast_mapping:
+            if len(args.args) in [0,1]:
+                print(f"To get {gridded_forecast_mapping[cmd_name]['human_name']} you need to provide the time for which to get the forecast and an output file.")
+                print(f"\nUsage: windborne {args.command} time output_file")
+            elif len(args.args) == 2:
+                get_gridded_forecast(variable=args.variable, time=args.args[0], output_file=args.args[1], ensemble_member=args.ens_member, intracycle=args.intracycle)
+            else:
+                print("Too many arguments")
+                print(f"\nUsage: windborne {args.command} time output_file")
+
+    # Handle all historical forecast commands
+    elif args.command.startswith('hist_'):
+        cmd_name = args.command[5:]  # Remove 'hist_' prefix
+        if cmd_name in gridded_forecast_mapping:
+            if len(args.args) in [0,1,2]:
+                print(f"To get {gridded_forecast_mapping[cmd_name]['human_name']} you need to provide\n"
+                      "  - initialization time of the forecast\n"
+                      "  - How many hours after the initialization time the forecast is valid at\n"
+                      "  - An output file to save the data")
+                print(f"\nUsage: windborne {args.command} initialization_time forecast_hour output_file")
+            elif len(args.args) == 3:
+                get_gridded_forecast(variable=args.variable, initialization_time=args.args[0], forecast_hour=args.args[1], output_file=args.args[2], ensemble_member=args.ens_member, intracycle=args.intracycle)
+            else:
+                print("Too many arguments")
+                print(f"\nUsage: windborne {args.command} initialization_time forecast_hour output_file")
 
     elif args.command == 'tropical_cyclones':
         # Parse cyclones arguments
@@ -655,4 +522,4 @@ def main():
         parser.print_help()
 
 if __name__ == '__main__':
-    main()
+    main()

windborne/forecasts_api.py

@@ -107,28 +107,45 @@ def get_point_forecasts(coordinates, min_forecast_time=None, max_forecast_time=N
     return response
 
 
-def get_gridded_forecast(time, variable, output_file=None):
+def get_gridded_forecast(variable, time=None, initialization_time=None, forecast_hour=None, output_file=None, silent=False, intracycle=False, ensemble_member=None):
     """
     Get gridded forecast data from the API.
     Note that this is primarily meant to be used internally by the other functions in this module.
 
     Args:
-        time (str): Date in either ISO 8601 format (YYYY-MM-DDTHH:00:00)
-                    or compact format (YYYYMMDDHH)
-                    where HH must be 00, 06, 12, or 18
+        time (str, optional): Date in either ISO 8601 format (YYYY-MM-DDTHH:00:00)
+                    or compact format (YYYYMMDDHH). May be used instead of initialization_time and forecast_hour.
+        initialization_time (str, optional): Date in either ISO 8601 format (YYYY-MM-DDTHH:00:00)
+                    or compact format (YYYYMMDDHH). May be used in conjunction with forecast_hour instead of time.
+        forecast_hour (int, optional): The forecast hour to get the forecast for. May be used in conjunction with initialization_time instead of time.
         variable (str): The variable you want the forecast for
         output_file (str, optional): Path to save the response data
                                       Supported formats: .nc
     """
 
-    params = {}
+    # backwards compatibility for time and variable order swap
+    if time in ['temperature_2m', 'dewpoint_2m', 'wind_u_10m', 'wind_v_10m', '500/wind_u', '500/wind_v', '500/temperature', '850/temperature', 'pressure_msl', '500/geopotential', '850/geopotential', 'FULL']:
+        variable, time = time, variable
 
-    if not time:
-        print("Error: the time you want the forecast for is required.")
+    # require either time or initialization_time and forecast_hour
+    if time is None and (initialization_time is None or forecast_hour is None):
+        print("Error: you must provide either time or initialization_time and forecast_hour.")
         return
-    else:
-        time_parsed = parse_time(time)
-        params["time"] = time_parsed
+    elif time is not None and (initialization_time is not None or forecast_hour is not None):
+        print("Warning: time, initialization_time, forecast_hour all provided; using initialization_time and forecast_hour.")
+
+    params = {}
+    if initialization_time is not None and forecast_hour is not None:
+        params["initialization_time"] = parse_time(initialization_time, init_time_flag=True)
+        params["forecast_hour"] = forecast_hour
+    elif time:
+        params["time"] = parse_time(time)
+
+    if intracycle:
+        params["intracycle"] = intracycle
+
+    if ensemble_member:
+        params["ens_member"] = ensemble_member
 
     response = make_api_request(f"{FORECASTS_GRIDDED_URL}/{variable}", params=params, as_json=False)
 
@@ -136,84 +153,59 @@ def get_gridded_forecast(time, variable, output_file=None):
         return None
 
     if output_file:
-        print(f"Output URL found; downloading to {output_file}...")
+        if not silent:
+            print(f"Output URL found; downloading to {output_file}...")
         download_and_save_output(output_file, response)
 
     return response
 
 def get_full_gridded_forecast(time, output_file=None):
-    return get_gridded_forecast(time, "FULL", output_file)
+    return get_gridded_forecast(variable="FULL", time=time, output_file=output_file)
 
 def get_temperature_2m(time, output_file=None):
-    return get_gridded_forecast(time, "temperature_2m", output_file)
+    return get_gridded_forecast(variable="temperature_2m", time=time, output_file=output_file)
 
-# Not yet implemented
-# def get_dewpoint_2m(time, output_file=None):
-#     return get_gridded_forecast(time, "dewpoint_2m", output_file)
+def get_dewpoint_2m(time, output_file=None):
+    return get_gridded_forecast(variable="dewpoint_2m", time=time, output_file=output_file)
 
 def get_wind_u_10m(time, output_file=None):
-    return get_gridded_forecast(time, "wind_u_10m", output_file)
+    return get_gridded_forecast(variable="wind_u_10m", time=time, output_file=output_file)
 
 def get_wind_v_10m(time, output_file=None):
-    return get_gridded_forecast(time, "wind_v_10m", output_file)
+    return get_gridded_forecast(variable="wind_v_10m", time=time, output_file=output_file)
 
 def get_500hpa_wind_u(time, output_file=None):
-    return get_gridded_forecast(time, "500/wind_u", output_file)
+    return get_gridded_forecast(variable="500/wind_u", time=time, output_file=output_file)
 
 def get_500hpa_wind_v(time, output_file=None):
-    return get_gridded_forecast(time, "500/wind_v", output_file)
+    return get_gridded_forecast(variable="500/wind_v", time=time, output_file=output_file)
 
 def get_500hpa_temperature(time, output_file=None):
-    return get_gridded_forecast(time, "500/temperature", output_file)
+    return get_gridded_forecast(variable="500/temperature", time=time, output_file=output_file)
 
 def get_850hpa_temperature(time, output_file=None):
-    return get_gridded_forecast(time, "850/temperature", output_file)
+    return get_gridded_forecast(variable="850/temperature", time=time, output_file=output_file)
 
 def get_pressure_msl(time, output_file=None):
-    return get_gridded_forecast(time, "pressure_msl", output_file)
+    return get_gridded_forecast(variable="pressure_msl", time=time, output_file=output_file)
 
 def get_500hpa_geopotential(time, output_file=None):
-    return get_gridded_forecast(time, "500/geopotential", output_file)
+    return get_gridded_forecast(variable="500/geopotential", time=time, output_file=output_file)
 
 def get_850hpa_geopotential(time, output_file=None):
-    return get_gridded_forecast(time, "850/geopotential", output_file)
-
-
-def get_historical_output(initialization_time, forecast_hour, variable, output_file=None):
-    params = {}
-
-    if not initialization_time or not forecast_hour:
-        print("To get the historical output of global temperature forecasts you need to provide:\n"
-              "- the initialization time of the forecast\n"
-              "- how many hours after the run time the forecast is valid at.\n")
-        return
-    else:
-        params["initialization_time"] = parse_time(initialization_time, init_time_flag=True)
-        params["forecast_hour"] = forecast_hour
-
-    response = make_api_request(f"{FORECASTS_HISTORICAL_URL}/{variable}", params=params, as_json=False)
-
-    if response is None:
-        return None
-
-    if output_file:
-        print(f"Output URL found; downloading to {output_file}...")
-        download_and_save_output(output_file, response)
-
-    return response
-
+    return get_gridded_forecast(variable="850/geopotential", time=time, output_file=output_file)
 
 def get_historical_temperature_2m(initialization_time, forecast_hour, output_file=None):
-    return get_historical_output(initialization_time, forecast_hour, "temperature_2m", output_file)
+    return get_gridded_forecast(variable="temperature_2m", initialization_time=initialization_time, forecast_hour=forecast_hour, output_file=output_file)
 
 def get_historical_500hpa_geopotential(initialization_time, forecast_hour, output_file=None):
-    return get_historical_output(initialization_time, forecast_hour, "500/geopotential", output_file)
+    return get_gridded_forecast(variable="500/geopotential", initialization_time=initialization_time, forecast_hour=forecast_hour, output_file=output_file)
 
 def get_historical_500hpa_wind_u(initialization_time, forecast_hour, output_file=None):
-    return get_historical_output(initialization_time, forecast_hour, "500/wind_u", output_file)
+    return get_gridded_forecast(variable="500/wind_u", initialization_time=initialization_time, forecast_hour=forecast_hour, output_file=output_file)
 
 def get_historical_500hpa_wind_v(initialization_time, forecast_hour, output_file=None):
-    return get_historical_output(initialization_time, forecast_hour, "500/wind_v", output_file)
+    return get_gridded_forecast(variable="500/wind_v", initialization_time=initialization_time, forecast_hour=forecast_hour, output_file=output_file)
 
 
 def get_tropical_cyclones(initialization_time=None, basin=None, output_file=None, print_response=False):
@@ -287,14 +279,18 @@ def get_tropical_cyclones(initialization_time=None, basin=None, output_file=None
     return response
 
 
-def get_initialization_times(print_response=False):
+def get_initialization_times(print_response=False, ensemble_member=None, intracycle=False):
     """
     Get available WeatherMesh initialization times (also known as cycle times).
 
-    Returns dict with keys "latest" and "available" (a list)
+    Returns dict with keys "latest" and "available"
     """
 
-    response = make_api_request(f"{FORECASTS_API_BASE_URL}/initialization_times.json")
+    params = {
+        'ens_member': ensemble_member,
+        'intracycle': intracycle
+    }
+    response = make_api_request(f"{FORECASTS_API_BASE_URL}/initialization_times.json", params=params)
 
     if print_response:
         print("Latest initialization time:", response['latest'])
@@ -305,6 +301,29 @@ def get_initialization_times(print_response=False):
     return response
 
 
+def get_forecast_hours(print_response=False, ensemble_member=None, intracycle=False):
+    """
+    Get available forecast hours for WeatherMesh
+    This may include initialization times that are not included in the initialization times API that represent outputs
+    that are still being generated.
+
+    Returns dict with keys of initialization times and values of available forecast hours
+    """
+
+    params = {
+        'ens_member': ensemble_member,
+        'intracycle': intracycle
+    }
+    response = make_api_request(f"{FORECASTS_API_BASE_URL}/forecast_hours.json", params=params)
+
+    if print_response:
+        print("Available forecast hours:")
+        for time, hours in response.items():
+            print(f" - {time}: {', '.join([str(hour) for hour in hours])}")
+
+    return response
+
+
 # Tropical cyclones
 def print_tc_supported_formats():
     """Print supported file formats for saving tcs data."""
@@ -313,7 +332,7 @@ def print_tc_supported_formats():
         print(f"  - {fmt}")
 
 
-def download_and_save_output(output_file, response):
+def download_and_save_output(output_file, response, silent=False):
     """
     Downloads a forecast output from a presigned S3 url contained in a response and saves it as a .nc file.
 
@@ -333,12 +352,17 @@ def download_and_save_output(output_file, response):
         # Save the content directly to file
         with open(output_file, 'wb') as f:
             f.write(response.content)
-        print(f"Data Successfully saved to {output_file}")
+
+        if not silent:
+            print(f"Data Successfully saved to {output_file}")
+
         return True
 
     except requests.exceptions.RequestException as e:
-        print(f"Error downloading the file: {e}")
+        if not silent:
+            print(f"Error downloading the file: {e}")
         return False
     except Exception as e:
-        print(f"Error processing the file: {e}")
-        return False
+        if not silent:
+            print(f"Error processing the file: {e}")
+        return False

{windborne-1.1.5.dist-info → windborne-1.2.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: windborne
-Version: 1.1.5
+Version: 1.2.1
 Summary: A Python library for interacting with WindBorne Data and Forecasts API
 Author-email: WindBorne Systems <data@windbornesystems.com>
 Classifier: Programming Language :: Python :: 3

windborne-1.2.1.dist-info/RECORD

@@ -0,0 +1,13 @@
+windborne/__init__.py,sha256=nRvcreJarSKLwx40adsZSbYm-pc3htE2HZJvgY0MQUA,2044
+windborne/api_request.py,sha256=wh8-LANzB62eJt699Zk3YHv4pIzwa1DIhiTJdWRp-To,11264
+windborne/cli.py,sha256=Y0oLQLqHAhGX1xCM4vpREpGAMhECM4SK87h2DkUjalU,28643
+windborne/data_api.py,sha256=sYZkcQog8RuLErfdLLa4gC8fRkAoPGNKKQJ8i6o-LTQ,33826
+windborne/forecasts_api.py,sha256=tp0tirS91xBwv9CuScJwjNiiVhrV3fHL6U5UxAdWLXk,16266
+windborne/observation_formatting.py,sha256=c739aaun6aaYhXl5VI-SRGR-TDS355_0Bfu1t6McoiM,14993
+windborne/track_formatting.py,sha256=LaLfTyjpWoOtHmReJPLViY0MKm_iPL_5I2OB_lNvGGA,10054
+windborne/utils.py,sha256=H8gvZ4Lrr0UmLl25iMZs6NsZliCY_73Ved_rBIqxJg4,7240
+windborne-1.2.1.dist-info/METADATA,sha256=jKnNK7Ar8N3mn9Ab1ptcim8rTX-gPD6L5w6tG_nhIzM,1235
+windborne-1.2.1.dist-info/WHEEL,sha256=Nw36Djuh_5VDukK0H78QzOX-_FQEo6V37m3nkm96gtU,91
+windborne-1.2.1.dist-info/entry_points.txt,sha256=j_YrqdCDrCd7p5MIwQ2BYwNXEi95VNANzLRJmcXEg1U,49
+windborne-1.2.1.dist-info/top_level.txt,sha256=PE9Lauriu5S5REf7JKhXprufZ_V5RiZ_TnfnrLGJrmE,10
+windborne-1.2.1.dist-info/RECORD,,

{windborne-1.1.5.dist-info → windborne-1.2.1.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.8.2)
+Generator: setuptools (80.7.1)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

windborne-1.1.5.dist-info/RECORD

@@ -1,13 +0,0 @@
-windborne/__init__.py,sha256=jPqxHTqOEcAnPU-7VCJionGToE2tqY7Q3SuSdQrdl9Q,1944
-windborne/api_request.py,sha256=zh1TaaZAaRfAXp2NYMja75fKeduWLfao02JRRFVpQCA,11108
-windborne/cli.py,sha256=fJ4cLcBpc7YasfMu3pNrqCX9idGCWA-2j2necNpDfck,36696
-windborne/data_api.py,sha256=sYZkcQog8RuLErfdLLa4gC8fRkAoPGNKKQJ8i6o-LTQ,33826
-windborne/forecasts_api.py,sha256=Jea1hGd2CQHbyRXnJXLamF1GdgBsoqX7oGyg8S6YoRo,14102
-windborne/observation_formatting.py,sha256=c739aaun6aaYhXl5VI-SRGR-TDS355_0Bfu1t6McoiM,14993
-windborne/track_formatting.py,sha256=LaLfTyjpWoOtHmReJPLViY0MKm_iPL_5I2OB_lNvGGA,10054
-windborne/utils.py,sha256=H8gvZ4Lrr0UmLl25iMZs6NsZliCY_73Ved_rBIqxJg4,7240
-windborne-1.1.5.dist-info/METADATA,sha256=M_INOFolggNfzz5IyYivgBT-lzgmp4ax8G-cSNhjZIg,1235
-windborne-1.1.5.dist-info/WHEEL,sha256=jB7zZ3N9hIM9adW7qlTAyycLYW9npaWKLRzaoVcLKcM,91
-windborne-1.1.5.dist-info/entry_points.txt,sha256=j_YrqdCDrCd7p5MIwQ2BYwNXEi95VNANzLRJmcXEg1U,49
-windborne-1.1.5.dist-info/top_level.txt,sha256=PE9Lauriu5S5REf7JKhXprufZ_V5RiZ_TnfnrLGJrmE,10
-windborne-1.1.5.dist-info/RECORD,,