buildstock-fetch 1.4.0__tar.gz → 1.4.4__tar.gz

{buildstock_fetch-1.4.0/buildstock_fetch.egg-info → buildstock_fetch-1.4.4}/PKG-INFO

@@ -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.4/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-1.4.0 → buildstock_fetch-1.4.4}/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 → buildstock_fetch-1.4.4/buildstock_fetch.egg-info}/PKG-INFO

@@ -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 → buildstock_fetch-1.4.4}/buildstock_fetch.egg-info/SOURCES.txt

@@ -13,6 +13,7 @@ buildstock_fetch.egg-info/entry_points.txt
 buildstock_fetch.egg-info/requires.txt
 buildstock_fetch.egg-info/top_level.txt
 buildstock_fetch/data/buildstock_releases.json
+buildstock_fetch/data/buildstock_upgrades_lookup.json
 buildstock_fetch/data/building_data/combined_metadata.parquet/product=comstock/release_year=2021/weather_file=amy2018/release_version=1/state=AK/d1454abff0d94c8090af7b3e923c473b-0.parquet
 buildstock_fetch/data/building_data/combined_metadata.parquet/product=comstock/release_year=2021/weather_file=amy2018/release_version=1/state=AK/dcd864cc169b4695be2b9775b1a054ae-0.parquet
 buildstock_fetch/data/building_data/combined_metadata.parquet/product=comstock/release_year=2021/weather_file=amy2018/release_version=1/state=AL/d1454abff0d94c8090af7b3e923c473b-0.parquet

{buildstock_fetch-1.4.0 → buildstock_fetch-1.4.4}/buildstock_fetch.egg-info/requires.txt

@@ -4,6 +4,8 @@ rich>=13.9.5
 questionary>=1.11.0
 polars>=0.20.0
 tomli>=2.0.0
+boto3>=1.33.0
+botocore>=1.33.0
 
 [dev]
 buildstock-fetch[dev-utils,docs,lint,test]

{buildstock_fetch-1.4.0 → buildstock_fetch-1.4.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "buildstock-fetch"
-version = "v1.4.0"
+version = "v1.4.4"
 description = "This library simplifies downloading building characteristics and load curve data from NREL's ResStock and ComStock projects."
 authors = [{ name = "Switchbox", email = "hello@switch.box" }]
 readme = "README.md"
@@ -24,6 +24,8 @@ dependencies = [
     "questionary>=1.11.0",
     "polars>=0.20.0",
     "tomli>=2.0.0",
+    "boto3>=1.33.0",
+    "botocore>=1.33.0",
 ]
 
 [project.urls]
@@ -89,7 +91,8 @@ packages = ["buildstock_fetch"]
     "data/buildstock_releases.json",
     "data/building_data/**/*",
     "data/**/*.parquet",
-    "data/load_curve_column_map/*.csv"
+    "data/load_curve_column_map/*.csv",
+    "data/buildstock_upgrades_lookup.json"
 ]