windborne 1.1.3__py3-none-any.whl → 1.1.4__py3-none-any.whl

windborne/__init__.py

@@ -14,6 +14,7 @@ from .data_api import (
     get_flying_missions,
     get_mission_launch_site,
     get_predicted_path,
+    get_current_location,
     get_flight_path
 )
 
@@ -22,6 +23,7 @@ from .forecasts_api import (
     get_point_forecasts,
     get_initialization_times,
 
+    get_full_gridded_forecast,
     get_temperature_2m,
     # get_dewpoint_2m,
     get_wind_u_10m, get_wind_v_10m,
@@ -51,11 +53,13 @@ __all__ = [
     "get_flying_missions",
     "get_mission_launch_site",
     "get_predicted_path",
+    "get_current_location",
     "get_flight_path",
 
     "get_point_forecasts",
     "get_initialization_times",
 
+    "get_full_gridded_forecast",
     "get_temperature_2m",
     # "get_dewpoint_2m",
     "get_wind_u_10m",

windborne/cli.py

@@ -14,10 +14,12 @@ from . import (
     get_flying_missions,
     get_mission_launch_site,
     get_predicted_path,
+    get_current_location,
     get_flight_path,
 
     get_point_forecasts,
     get_initialization_times,
+    get_full_gridded_forecast,
     get_temperature_2m,
     # get_dewpoint_2m,
     get_wind_u_10m, get_wind_v_10m,
@@ -121,6 +123,11 @@ def main():
     launch_site_parser.add_argument('mission_id', help='Mission ID')
     launch_site_parser.add_argument('output', nargs='?', help='Output file')
 
+    # Get Current Location Command
+    current_location_parser = subparsers.add_parser('current-location', help='Get current location')
+    current_location_parser.add_argument('mission_id', help='Mission ID')
+    current_location_parser.add_argument('output', nargs='?', help='Output file')
+
     # Get Predicted Path Command
     prediction_parser = subparsers.add_parser('predict-path', help='Get predicted flight path')
     prediction_parser.add_argument('mission_id', help='Mission ID')
@@ -149,6 +156,9 @@ 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')
@@ -379,7 +389,12 @@ def main():
             output_file=args.output,
             print_result=(not args.output)
         )
-
+    elif args.command == 'current-location':
+        get_current_location(
+            mission_id=args.mission_id,
+            output_file=args.output,
+            print_result=(not args.output)
+        )
     elif args.command == 'predict-path':
         get_predicted_path(
             mission_id=args.mission_id,
@@ -419,6 +434,17 @@ 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")
+
     elif args.command == 'grid_temp_2m':
         # Parse grid_temp_2m arguments
         if len(args.args) in [0,1]:

windborne/data_api.py

@@ -622,22 +622,22 @@ def get_mission_launch_site(mission_id=None, output_file=None, print_result=Fals
     return response.get('launch_site')
 
 
-def get_predicted_path(mission_id=None, output_file=None, print_result=False):
+def get_flying_mission(mission_id, verify_flying=True):
     """
-        Fetches the predicted flight path for a given mission.
-        Displays currently flying missions if the provided mission ID is invalid.
+    Fetches a flying mission by ID.
+    If the mission is not flying, displays a list of currently flying missions.
 
-        Args:
-            mission_id (str): The ID of the mission to fetch the prediction for.
-            output_file (str): Optional path to save the response data.
-            print_result (bool): Whether to print the results in the CLI.
+    Args:
+        mission_id (str): The ID of the mission to fetch.
+        verify_flying (bool): Whether to always check if the mission is flying.
 
-        Returns:
-            list: The API response containing the predicted flight path data.
+    Returns:
+        dict: The API response containing the mission data, or None if the mission is not flying.
     """
-    if not mission_id:
-        print("To get the predicted flight path for a given mission you must provide a mission ID.")
-        return
+    if not verify_flying and not mission_id.startswith('W-'):
+        return {
+            'id': mission_id,
+        }
 
     # Check if provided mission ID belong to a flying mission
     flying_missions = get_flying_missions()
@@ -658,8 +658,30 @@ def get_predicted_path(mission_id=None, output_file=None, print_result=False):
             print_table(flying_missions, keys=['id', 'name'], headers=['Mission ID', 'Mission Name'])
         else:
             print("No missions are currently flying.")
+        return None
+
+    return mission
+
+
+def get_predicted_path(mission_id=None, output_file=None, print_result=False):
+    """
+        Fetches the predicted flight path for a given mission.
+        Displays currently flying missions if the provided mission ID is invalid.
+
+        Args:
+            mission_id (str): The ID of the mission to fetch the prediction for.
+            output_file (str): Optional path to save the response data.
+            print_result (bool): Whether to print the results in the CLI.
+
+        Returns:
+            list: The API response containing the predicted flight path data.
+    """
+    if not mission_id:
+        print("To get the predicted flight path for a given mission you must provide a mission ID.")
         return
 
+    mission = get_flying_mission(mission_id)
+
     url = f"{DATA_API_BASE_URL}/missions/{mission.get('id')}/prediction.json"
     response = make_api_request(url)
 
@@ -677,6 +699,42 @@ def get_predicted_path(mission_id=None, output_file=None, print_result=False):
     return response.get('prediction')
 
 
+def get_current_location(mission_id=None, output_file=None, print_result=False, verify_flying=True):
+    """
+    Fetches the current location for a given mission.
+
+    Args:
+        mission_id (str): The ID of the mission to fetch the current location for.
+        output_file (str): Optional path to save the response data.
+        print_result (bool): Whether to print the results in the CLI.
+        verify_flying (bool): Whether to verify the mission is flying before trying to fetch the current location
+
+    Returns:
+        dict: Current location with latitude, longitude, and altitude, or None if not found
+    """
+    if not mission_id:
+        print("To get the current location for a given mission you must provide a mission ID.")
+        return
+
+    mission = get_flying_mission(mission_id, verify_flying=verify_flying)
+
+    url = f"{DATA_API_BASE_URL}/missions/{mission.get('id')}/current_location.json"
+    response = make_api_request(url)
+
+    if response is None:
+        return
+
+    if output_file:
+        save_arbitrary_response(output_file, response, csv_data_key=None)
+
+    if print_result:
+        print("Current location\n")
+        print_table([response], keys=['latitude', 'longitude', 'altitude'],
+                    headers=['Latitude', 'Longitude', 'Altitude'])
+
+    return response
+
+
 def get_flight_path(mission_id=None, output_file=None, print_result=False):
     """
         Fetches the flight path for a given mission.

windborne/forecasts_api.py

@@ -141,6 +141,9 @@ def get_gridded_forecast(time, variable, output_file=None):
 
     return response
 
+def get_full_gridded_forecast(time, output_file=None):
+    return get_gridded_forecast(time, "FULL", output_file)
+
 def get_temperature_2m(time, output_file=None):
     return get_gridded_forecast(time, "temperature_2m", output_file)
 

{windborne-1.1.3.dist-info → windborne-1.1.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: windborne
-Version: 1.1.3
+Version: 1.1.4
 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.1.4.dist-info/RECORD

@@ -0,0 +1,13 @@
+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=f2TdMpSxQLiWKcUJxbG_9SqAp4DU-sZ3rBvqTcBHbuk,33343
+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.4.dist-info/METADATA,sha256=PqFm1t3RoKqj0K1UtUtJYMfIwl1gauKIAinS1Elyir4,1235
+windborne-1.1.4.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+windborne-1.1.4.dist-info/entry_points.txt,sha256=j_YrqdCDrCd7p5MIwQ2BYwNXEi95VNANzLRJmcXEg1U,49
+windborne-1.1.4.dist-info/top_level.txt,sha256=PE9Lauriu5S5REf7JKhXprufZ_V5RiZ_TnfnrLGJrmE,10
+windborne-1.1.4.dist-info/RECORD,,

windborne-1.1.3.dist-info/RECORD

@@ -1,13 +0,0 @@
-windborne/__init__.py,sha256=DcxmiLq4UnjoRjZd4UeuYt29FBsi9paMXGtI91Itn04,1826
-windborne/api_request.py,sha256=zh1TaaZAaRfAXp2NYMja75fKeduWLfao02JRRFVpQCA,11108
-windborne/cli.py,sha256=xRPRLh50iC4Uu0AYEHL-LHRxUnpxqB_Mn-easp5VSK4,35370
-windborne/data_api.py,sha256=QsG1NJyOCzTrTLRaoz5Z4nGRI0HCMEJvbDyRUlY3Usg,31388
-windborne/forecasts_api.py,sha256=E0X9FyUW2yz3pQZKkFBYDMeg6PhFJ1bp4z1Cg1g0uGs,13987
-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.3.dist-info/METADATA,sha256=unPmA3uPzt8obgqSmJSrsSzSLat4yH7o3uJtb-i3wy0,1235
-windborne-1.1.3.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-windborne-1.1.3.dist-info/entry_points.txt,sha256=j_YrqdCDrCd7p5MIwQ2BYwNXEi95VNANzLRJmcXEg1U,49
-windborne-1.1.3.dist-info/top_level.txt,sha256=PE9Lauriu5S5REf7JKhXprufZ_V5RiZ_TnfnrLGJrmE,10
-windborne-1.1.3.dist-info/RECORD,,