windborne 1.2.4__py3-none-any.whl → 1.2.6__py3-none-any.whl

windborne/__init__.py

@@ -39,7 +39,10 @@ from .forecasts_api import (
     get_historical_500hpa_geopotential,
     get_historical_500hpa_wind_u, get_historical_500hpa_wind_v,
 
-    get_tropical_cyclones
+    get_tropical_cyclones,
+
+    get_population_weighted_hdd,
+    get_population_weighted_cdd
 )
 
 # Define what should be available when users import *
@@ -82,5 +85,8 @@ __all__ = [
     "get_historical_500hpa_geopotential",
     "get_historical_500hpa_wind_u",
     "get_historical_500hpa_wind_v",
-    "get_tropical_cyclones"
+    "get_tropical_cyclones",
+
+    "get_population_weighted_hdd",
+    "get_population_weighted_cdd"
 ]

windborne/cli.py

@@ -23,7 +23,9 @@ from . import (
     get_generation_times,
     get_full_gridded_forecast,
     get_gridded_forecast,
-    get_tropical_cyclones
+    get_tropical_cyclones,
+    get_population_weighted_hdd,
+    get_population_weighted_cdd
 
 )
 
@@ -226,6 +228,22 @@ def main():
     tropical_cyclones_parser.add_argument('args', nargs='*',
                                  help='[optional: initialization time (YYYYMMDDHH, YYYY-MM-DDTHH, or YYYY-MM-DDTHH:mm:ss)] output_file')
 
+    # Population Weighted HDD Command
+    hdd_parser = subparsers.add_parser('hdd', help='Get population weighted heating degree days (HDD) forecasts')
+    hdd_parser.add_argument('initialization_time', help='Initialization time (YYYYMMDDHH, YYYY-MM-DDTHH, or YYYY-MM-DDTHH:mm:ss)')
+    hdd_parser.add_argument('-i', '--intracycle', action='store_true', help='Use the intracycle forecast')
+    hdd_parser.add_argument('-e', '--ens-member', help='Ensemble member (eg 1 or mean)')
+    hdd_parser.add_argument('-m', '--external-model', help='External model (eg gfs, ifs, hrrr, aifs)')
+    hdd_parser.add_argument('-o', '--output', help='Output file (supports .csv and .json formats)')
+
+    # Population Weighted CDD Command
+    cdd_parser = subparsers.add_parser('cdd', help='Get population weighted cooling degree days (CDD) forecasts')
+    cdd_parser.add_argument('initialization_time', help='Initialization time (YYYYMMDDHH, YYYY-MM-DDTHH, or YYYY-MM-DDTHH:mm:ss)')
+    cdd_parser.add_argument('-i', '--intracycle', action='store_true', help='Use the intracycle forecast')
+    cdd_parser.add_argument('-e', '--ens-member', help='Ensemble member (eg 1 or mean)')
+    cdd_parser.add_argument('-m', '--external-model', help='External model (eg gfs, ifs, hrrr, aifs)')
+    cdd_parser.add_argument('-o', '--output', help='Output file (supports .csv and .json formats)')
+
     # 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')
@@ -527,6 +545,28 @@ def main():
             print("Error: Too many arguments")
             print("Usage: windborne tropical_cyclones [initialization_time] output_file")
 
+    elif args.command == 'hdd':
+        # Handle population weighted HDD
+        get_population_weighted_hdd(
+            initialization_time=args.initialization_time, 
+            intracycle=args.intracycle,
+            ens_member=args.ens_member,
+            external_model=args.external_model,
+            output_file=args.output,
+            print_response=(not args.output)
+        )
+
+    elif args.command == 'cdd':
+        # Handle population weighted CDD
+        get_population_weighted_cdd(
+            initialization_time=args.initialization_time, 
+            intracycle=args.intracycle,
+            ens_member=args.ens_member,
+            external_model=args.external_model,
+            output_file=args.output,
+            print_response=(not args.output)
+        )
+
     else:
         parser.print_help()
 

windborne/forecasts_api.py

@@ -389,3 +389,79 @@ def download_and_save_output(output_file, response, silent=False):
         if not silent:
             print(f"Error processing the file: {e}")
         return False
+
+def get_population_weighted_hdd(initialization_time, intracycle=False, ens_member=None, external_model=None, output_file=None, print_response=False):
+    """
+    Get population weighted HDD data from the API.
+    """
+    params = {
+        "initialization_time": initialization_time,
+        "intracycle": intracycle,
+        "ens_member": ens_member,
+        "external_model": external_model
+    }
+    response = make_api_request(f"{FORECASTS_API_BASE_URL}/hdd", params=params, as_json=True)
+    
+    if output_file:
+        if output_file.endswith('.csv'):
+            import csv
+
+            # save as csv, with a row for each region, and a column for each date, sorted alphabetically by region
+            regions = sorted(response['hdd'].keys())
+            dates = response['dates']
+            data = [[response['hdd'][region][dates[i]] for region in regions] for i in range(len(dates))]  
+
+            with open(output_file, 'w') as f:
+                writer = csv.writer(f)
+                writer.writerow(['Region'] + dates)
+
+                for region in regions:
+                    writer.writerow([region] + [response['hdd'][region][date] for date in dates])
+    
+    if print_response:
+        dates = response['dates']
+        print(response['hdd']['Alabama'])
+        for region in sorted(response['hdd'].keys()):
+            print(f"{region}:")
+            for i in range(len(dates)):
+                print(f"  {dates[i]}: {response['hdd'][region][dates[i]]}")
+    
+    return response
+
+def get_population_weighted_cdd(initialization_time, intracycle=False, ens_member=None, external_model=None, output_file=None, print_response=False):
+    """
+    Get population weighted CDD data from the API.
+    """
+    params = {
+        "initialization_time": initialization_time,
+        "intracycle": intracycle,
+        "ens_member": ens_member,
+        "external_model": external_model
+    }
+    response = make_api_request(f"{FORECASTS_API_BASE_URL}/cdd", params=params, as_json=True)
+    
+    if output_file:
+        if output_file.endswith('.csv'):
+            import csv
+
+            # save as csv, with a row for each region, and a column for each date, sorted alphabetically by region
+            regions = sorted(response['cdd'].keys())
+            dates = response['dates']
+            data = [[response['cdd'][region][dates[i]] for region in regions] for i in range(len(dates))]  
+
+            with open(output_file, 'w') as f:
+                writer = csv.writer(f)
+                writer.writerow(['Region'] + dates)
+
+                for region in regions:
+                    writer.writerow([region] + [response['cdd'][region][date] for date in dates])
+    
+    if print_response:
+        dates = response['dates']
+        print(response['cdd']['Alabama'])
+        for region in sorted(response['cdd'].keys()):
+            print(f"{region}:")
+            for i in range(len(dates)):
+                print(f"  {dates[i]}: {response['cdd'][region][dates[i]]}")
+    
+    return response

{windborne-1.2.4.dist-info → windborne-1.2.6.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: windborne
-Version: 1.2.4
+Version: 1.2.6
 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.6.dist-info/RECORD

@@ -0,0 +1,13 @@
+windborne/__init__.py,sha256=eTmMmiGDOwvecD4Eyfe13v0dn8yU9PqpwZbce9xLkpE,2240
+windborne/api_request.py,sha256=moFKZFKMrHCINtve6ZfQYgrGgd6tXQffVGuNkZzprV4,8508
+windborne/cli.py,sha256=qjXfyPPKTvrssl2Mr2X2NsIxsJw31slffoic0GoY3eE,31459
+windborne/data_api.py,sha256=sYZkcQog8RuLErfdLLa4gC8fRkAoPGNKKQJ8i6o-LTQ,33826
+windborne/forecasts_api.py,sha256=TPSR25_GiFnQrWharrefSGpxN5300Un0d4sx1sFIN6E,20063
+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.6.dist-info/METADATA,sha256=7P5KLbZ0q6HFRZ4ANStCOXGkHPeF3Bk0WDd6MAtt1SI,1304
+windborne-1.2.6.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+windborne-1.2.6.dist-info/entry_points.txt,sha256=j_YrqdCDrCd7p5MIwQ2BYwNXEi95VNANzLRJmcXEg1U,49
+windborne-1.2.6.dist-info/top_level.txt,sha256=PE9Lauriu5S5REf7JKhXprufZ_V5RiZ_TnfnrLGJrmE,10
+windborne-1.2.6.dist-info/RECORD,,

windborne-1.2.4.dist-info/RECORD

@@ -1,13 +0,0 @@
-windborne/__init__.py,sha256=dslI8_5Wozr96w7c0E7_HEpYIHt9YaTLo3ADF2yapSk,2102
-windborne/api_request.py,sha256=moFKZFKMrHCINtve6ZfQYgrGgd6tXQffVGuNkZzprV4,8508
-windborne/cli.py,sha256=TzEZtfzOgMgPU11ARgJ6O3YZFV3TcXPPYOabHBKb01Y,29247
-windborne/data_api.py,sha256=sYZkcQog8RuLErfdLLa4gC8fRkAoPGNKKQJ8i6o-LTQ,33826
-windborne/forecasts_api.py,sha256=mg7rJkBUE9xSyKIx4RMN0-RIZBdqqSz7Jp5JqFg8DhI,17053
-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.4.dist-info/METADATA,sha256=IueZfHUEH8-ZAqiUm-pODRED1uRRsRKfecGq7lokM8E,1304
-windborne-1.2.4.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-windborne-1.2.4.dist-info/entry_points.txt,sha256=j_YrqdCDrCd7p5MIwQ2BYwNXEi95VNANzLRJmcXEg1U,49
-windborne-1.2.4.dist-info/top_level.txt,sha256=PE9Lauriu5S5REf7JKhXprufZ_V5RiZ_TnfnrLGJrmE,10
-windborne-1.2.4.dist-info/RECORD,,