buildstock-fetch 1.4.0__py3-none-any.whl → 1.4.4__py3-none-any.whl

buildstock_fetch/data/buildstock_upgrades_lookup.json

@@ -0,0 +1,23 @@
+{
+  "res_2024_tmy3_2": {
+    "upgrade_descriptions": {
+      "0": "Baseline",
+      "1": "ENERGY STAR heat pump with elec backup",
+      "2": "High efficiency cold-climate heat pump with elec backup",
+      "3": "Ultra high efficiency heat pump with elec backup",
+      "4": "ENERGY STAR heat pump with existing system as backup",
+      "5": "Geothermal heat pump",
+      "6": "ENERGY STAR heat pump with elec backup + Light Touch Envelope",
+      "7": "High efficiency cold-climate heat pump with elec backup + Light Touch Envelope",
+      "8": "Ultra high efficiency heat pump with elec backup + Light Touch Envelope",
+      "9": "ENERGY STAR heat pump with existing system as backup + Light Touch Envelope",
+      "10": "Geothermal heat pump + Light Touch Envelope",
+      "11": "ENERGY STAR heat pump with elec backup + Light Touch Envelope + Full Appliance Electrification with Efficiency",
+      "12": "High efficiency cold-climate heat pump with elec backup + Light Touch Envelope + Full Appliance Electrification with Efficiency",
+      "13": "Ultra high efficiency heat pump with elec backup + Light Touch Envelope + Full Appliance Electrification with Efficiency",
+      "14": "ENERGY STAR heat pump with existing system as backup + Light Touch Envelope + Full Appliance Electrification with Efficiency",
+      "15": "Geothermal heat pump + Light Touch Envelope + Full Appliance Electrification with Efficiency",
+      "16": "Envelope Only - Light Touch Envelope"
+    }
+  }
+}

buildstock_fetch/main_cli.py

@@ -32,6 +32,9 @@ BUILDSTOCK_RELEASES_FILE = str(files("buildstock_fetch").joinpath("data").joinpa
 # File types that haven't been implemented yet
 UNAVAILABLE_FILE_TYPES: list[str] = []
 
+# Upgrade scenario description lookup file
+UPGRADES_LOOKUP_FILE = str(files("buildstock_fetch").joinpath("data").joinpath("buildstock_upgrades_lookup.json"))
+
 
 class InvalidProductError(Exception):
     """Exception raised when an invalid product is provided."""
@@ -153,6 +156,14 @@ def _get_upgrade_ids_options(release_name: str) -> list[str]:
     available_upgrade_ids.sort()
     available_upgrade_ids = [str(upgrade_id) for upgrade_id in available_upgrade_ids]
 
+    if release_name in json.loads(Path(UPGRADES_LOOKUP_FILE).read_text(encoding="utf-8")):
+        upgrade_descriptions = json.loads(Path(UPGRADES_LOOKUP_FILE).read_text(encoding="utf-8"))[release_name][
+            "upgrade_descriptions"
+        ]
+        available_upgrade_ids = [
+            f"{upgrade_id}: {upgrade_descriptions[upgrade_id]}" for upgrade_id in available_upgrade_ids
+        ]
+
     return cast(list[str], available_upgrade_ids)
 
 
@@ -388,7 +399,7 @@ def _run_interactive_mode() -> dict[str, Union[str, list[str]]]:
     )
 
     # Retrieve upgrade ids
-    selected_upgrade_ids = _handle_cancellation(
+    selected_upgrade_ids_raw = _handle_cancellation(
         questionary.checkbox(
             "Select upgrade ids:",
             choices=_get_upgrade_ids_options(selected_release_name),
@@ -397,6 +408,16 @@ def _run_interactive_mode() -> dict[str, Union[str, list[str]]]:
         ).ask()
     )
 
+    # Extract upgrade ID integers from the selected options
+    selected_upgrade_ids = []
+    for option in selected_upgrade_ids_raw:
+        if ":" in option:
+            # Extract the integer before the colon
+            upgrade_id = option.split(":")[0].strip()
+            selected_upgrade_ids.append(upgrade_id)
+        else:
+            selected_upgrade_ids.append(option)
+
     # Retrieve state
     selected_states: list[str] = cast(
         list[str],

{buildstock_fetch-1.4.0.dist-info → buildstock_fetch-1.4.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: buildstock-fetch
-Version: 1.4.0
+Version: 1.4.4
 Summary: This library simplifies downloading building characteristics and load curve data from NREL's ResStock and ComStock projects.
 Author-email: Switchbox <hello@switch.box>
 Project-URL: Homepage, https://switchbox-data.github.io/buildstock-fetch/
@@ -25,6 +25,8 @@ Requires-Dist: rich>=13.9.5
 Requires-Dist: questionary>=1.11.0
 Requires-Dist: polars>=0.20.0
 Requires-Dist: tomli>=2.0.0
+Requires-Dist: boto3>=1.33.0
+Requires-Dist: botocore>=1.33.0
 Provides-Extra: test
 Requires-Dist: pytest>=7.2.0; extra == "test"
 Provides-Extra: docs

{buildstock_fetch-1.4.0.dist-info → buildstock_fetch-1.4.4.dist-info}/RECORD

@@ -1,8 +1,9 @@
 buildstock_fetch/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 buildstock_fetch/__main__.py,sha256=wEPNJ-s7F6KcRQ_4B5Xh08uqvYZHno5F2R8DU0BMBtk,80
 buildstock_fetch/main.py,sha256=yZ8xoYWnoyeTIDMXzVnbQt57a2NAZS7bEPRDtj_SuiU,90887
-buildstock_fetch/main_cli.py,sha256=lf-UGI9rcJgBOrJtRdHZ1mcr-jvRxOQ5H0G3re2v9Is,35754
+buildstock_fetch/main_cli.py,sha256=NydxBL72yRMXnFCRwYuZP7wvuF9S_7yfVFqGY9ea0OU,36695
 buildstock_fetch/data/buildstock_releases.json,sha256=XL-D1Xdix59sFGbS6vKFiGhQakhhPrwn14N-Tgt9iuk,11620
+buildstock_fetch/data/buildstock_upgrades_lookup.json,sha256=CCc2dV6voD8r6WpBBq9zoxhVQGAPcUGmAoFyKoUcUpo,1486
 buildstock_fetch/data/building_data/combined_metadata.parquet/product=comstock/release_year=2021/weather_file=amy2018/release_version=1/state=AK/d1454abff0d94c8090af7b3e923c473b-0.parquet,sha256=nG6H3oGyDzPk1B15YmFd_U81PsA14uABqqwK7P30nKE,7059
 buildstock_fetch/data/building_data/combined_metadata.parquet/product=comstock/release_year=2021/weather_file=amy2018/release_version=1/state=AK/dcd864cc169b4695be2b9775b1a054ae-0.parquet,sha256=fsREWV9g4fsA3cIWqyPnXVwd7FsJxED2btYpmyOvnbQ,7163
 buildstock_fetch/data/building_data/combined_metadata.parquet/product=comstock/release_year=2021/weather_file=amy2018/release_version=1/state=AL/d1454abff0d94c8090af7b3e923c473b-0.parquet,sha256=jiTG48ly-LZwfwAL3THdfRzHDG1qEogoxO7P78U4WOU,41201
@@ -1602,9 +1603,9 @@ buildstock_fetch/data/building_data/combined_metadata.parquet/product=resstock/r
 buildstock_fetch/data/load_curve_column_map/2022_resstock_load_curve_columns.csv,sha256=9UoTPlvxR3RqsxH8i4tI75lLtdSAT-HbAFxwlzvAYNY,7339
 buildstock_fetch/data/load_curve_column_map/2024_resstock_load_curve_columns.csv,sha256=TIxqsE-iVHE5tYq9oPSgBxIVbd5qfyDcJG_eTqds9aY,7471
 buildstock_fetch/data/weather_station_map/weather_station_map.parquet,sha256=igNrx-UGH20CqPcjANTDrrMyj6Z4_JcXIg2aaCNhFRg,346990
-buildstock_fetch-1.4.0.dist-info/licenses/LICENSE,sha256=TJeh2yvO8__8Rbamd8r48-zvlFCINAsu9nOo5QdMRX8,1066
-buildstock_fetch-1.4.0.dist-info/METADATA,sha256=d7DyxjVTO_F-XbtLvJbJDEQyImhBkZQLGr9H5PAZ13M,8262
-buildstock_fetch-1.4.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-buildstock_fetch-1.4.0.dist-info/entry_points.txt,sha256=C7zPk3BSLcI47ymvYKI05nvfRJMEXz4BPIIDKsjePn8,54
-buildstock_fetch-1.4.0.dist-info/top_level.txt,sha256=-PGb2C-Tb3O-wPqUHSOBrvJqRzNHgY_KTbTsXaHIo5M,17
-buildstock_fetch-1.4.0.dist-info/RECORD,,
+buildstock_fetch-1.4.4.dist-info/licenses/LICENSE,sha256=TJeh2yvO8__8Rbamd8r48-zvlFCINAsu9nOo5QdMRX8,1066
+buildstock_fetch-1.4.4.dist-info/METADATA,sha256=Key8VMJHuY3BddTT_xACa2sjJhTWLKpDUfYf4KuQcWs,8323
+buildstock_fetch-1.4.4.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+buildstock_fetch-1.4.4.dist-info/entry_points.txt,sha256=C7zPk3BSLcI47ymvYKI05nvfRJMEXz4BPIIDKsjePn8,54
+buildstock_fetch-1.4.4.dist-info/top_level.txt,sha256=-PGb2C-Tb3O-wPqUHSOBrvJqRzNHgY_KTbTsXaHIo5M,17
+buildstock_fetch-1.4.4.dist-info/RECORD,,