buildstock-fetch 1.4.3__py3-none-any.whl → 1.4.5__py3-none-any.whl

buildstock_fetch/__init__.py

@@ -0,0 +1 @@
+__version__ = "1.4.5"

buildstock_fetch/data/buildstock_upgrades_lookup.json

@@ -1,4 +1,104 @@
 {
+  "com_2024_amy2018_1": {
+    "upgrade_descriptions": {
+      "0": "Baseline",
+      "1": "Variable Speed HP RTU, Electric Backup",
+      "2": "Variable Speed HP RTU, Original Heating Fuel Backup",
+      "3": "Variable Speed HP RTU, Electric Backup, Energy Recovery",
+      "5": "VRF with DOAS",
+      "6": "VRF with 25pct Upsizing Allowance",
+      "7": "DOAS HP Minisplits",
+      "8": "HP Boiler, Electric Backup",
+      "9": "HP Boiler, Gas Backup",
+      "10": "Air Side Economizers for AHUs",
+      "11": "Demand Control Ventilation",
+      "12": "Energy Recovery for AHUs",
+      "13": "Advanced RTU Controls",
+      "14": "Unoccupied AHU Control",
+      "15": "Hydronic Water-to-Water Geothermal Heat Pump",
+      "16": "Packaged Water-to-Air Geothermal Heat Pump",
+      "17": "Console Water-to-Air Geothermal Heat Pump",
+      "18": "Comprehensive Geothermal Heat Pump Package, Hydronic GHP, Packaged GHP, or Console GHP",
+      "19": "Demand Flexibility, Thermostat Control, Load Shed",
+      "20": "Demand Flexibility, Thermostat Control, Load Shift",
+      "21": "LED Lighting",
+      "22": "Electric Kitchen Equipment",
+      "23": "Wall Insulation",
+      "24": "Roof Insulation",
+      "25": "Secondary Windows",
+      "26": "Window Film",
+      "27": "New Windows",
+      "28": "Package 1, Wall & Roof Insulation + New Windows",
+      "29": "Package 2, LED Lighting + Variable Speed HP RTU or HP Boilers",
+      "31": "Package 4, Package 1 + Package 2",
+      "32": "Package 5, Variable Speed HP RTU or HP Boilers + Economizer + DCV + Energy Recovery"
+    }
+  },
+  "com_2024_amy2018_2": {
+    "upgrade_descriptions": {
+      "0": "Baseline",
+      "1": "HP RTU E Backup",
+      "2": "HP RTU OF Backup",
+      "3": "HP RTU + ER",
+      "4": "HP RTU Std Perf",
+      "5": "Std Perf w Roof",
+      "6": "Std Perf 32F Lockout",
+      "7": "CCHPC",
+      "8": "VRF with DOAS",
+      "9": "VRF with 25pct Upsizing Allowance",
+      "10": "DOAS HP Minisplits",
+      "11": "HP Boiler E Backup",
+      "12": "HP Boiler G Backup",
+      "13": "Economizer",
+      "14": "DCV",
+      "15": "Energy Recovery",
+      "16": "Advanced RTU Controls",
+      "17": "Unoccupied AHU Control",
+      "18": "Ideal Thermal Loads",
+      "19": "Hydronic GHP",
+      "20": "Packaged GHP",
+      "21": "Console GHP",
+      "22": "Comprehensive GHP",
+      "23": "tstat_shed",
+      "24": "tstat_shift",
+      "25": "light_shed",
+      "26": "light_emission",
+      "27": "LED Lighting",
+      "28": "Electric Kitchen Equipment",
+      "29": "Wall Insulation",
+      "30": "Roof Insulation",
+      "31": "Secondary Windows",
+      "32": "Window Film",
+      "33": "New Windows",
+      "34": "Package 1",
+      "35": "Package 2",
+      "36": "Package 3",
+      "37": "Package 4",
+      "38": "Package 5",
+      "39": "Package 6"
+    }
+  },
+  "res_2024_amy2018_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"
+    }
+  },
   "res_2024_tmy3_2": {
     "upgrade_descriptions": {
       "0": "Baseline",

buildstock_fetch/main.py

@@ -722,7 +722,7 @@ def _process_single_metadata_file(metadata_file: Path) -> None:
 
     # Use streaming operations to avoid loading entire file into memory
     # Create a temporary file to write the filtered data
-    with tempfile.NamedTemporaryFile(delete=False, suffix=".parquet") as temp_file:
+    with tempfile.NamedTemporaryFile(delete=False, suffix=".parquet", dir=metadata_file.parent) as temp_file:
         temp_file_path = temp_file.name
 
         try:

buildstock_fetch/main_cli.py

@@ -161,7 +161,9 @@ def _get_upgrade_ids_options(release_name: str) -> list[str]:
             "upgrade_descriptions"
         ]
         available_upgrade_ids = [
-            f"{upgrade_id}: {upgrade_descriptions[upgrade_id]}" for upgrade_id in available_upgrade_ids
+            f"{upgrade_id}: {upgrade_descriptions[upgrade_id]}"
+            for upgrade_id in available_upgrade_ids
+            if upgrade_id in upgrade_descriptions
         ]
 
     return cast(list[str], available_upgrade_ids)
@@ -399,15 +401,26 @@ def _run_interactive_mode() -> dict[str, Union[str, list[str]]]:
     )
 
     # Retrieve upgrade ids
-    selected_upgrade_ids = _handle_cancellation(
+    upgrade_options = _get_upgrade_ids_options(selected_release_name)
+    selected_upgrade_ids_raw = _handle_cancellation(
         questionary.checkbox(
             "Select upgrade ids:",
-            choices=_get_upgrade_ids_options(selected_release_name),
-            instruction="Use spacebar to select/deselect options, enter to confirm",
+            choices=upgrade_options,
+            instruction="Use spacebar to select/deselect options, 'a' to select all, 'i' to invert selection, enter to confirm",
             validate=lambda answer: "You must select at least one upgrade id" if len(answer) == 0 else True,
         ).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],
@@ -658,6 +671,58 @@ def _get_user_download_choice(bldg_ids: list) -> list:
         return selected_bldg_ids
 
 
+def _select_bldg_ids_for_sample(bldg_ids: list, sample: Union[str, None]) -> list:
+    """Return building IDs sampled per (state, upgrade_id) pair.
+
+    - Group by (state, upgrade_id)
+    - If sample is "all"/"a": return all IDs from each group
+    - If sample is an integer string N: return first N from each group
+    - Invalid or non-positive sample returns an empty list
+    """
+    if sample is None:
+        return []
+
+    # Group building IDs by (state, upgrade_id)
+    state_upgrade_groups: dict[tuple[str, str], list] = {}
+    for bldg_id in bldg_ids:
+        key = (bldg_id.state, bldg_id.upgrade_id)
+        if key not in state_upgrade_groups:
+            state_upgrade_groups[key] = []
+        state_upgrade_groups[key].append(bldg_id)
+
+    sample_str = str(sample).strip().lower()
+    if sample_str in ("all", "a"):
+        selected_all: list = []
+        for group_ids in state_upgrade_groups.values():
+            selected_all.extend(group_ids)
+        console.print(f"[green]Selected all {len(selected_all)} building IDs across all state/upgrade pairs.[/green]")
+        return selected_all
+
+    try:
+        sample_size = int(sample_str)
+    except ValueError:
+        console.print(f"[red]Invalid value for --sample: {sample}. Use an integer, 'all', or 'a'.[/red]")
+        return []
+
+    if sample_size <= 0:
+        console.print("[yellow]Sample size must be greater than 0.[/yellow]")
+        return []
+
+    # Select first N from each (state, upgrade_id) group
+    selected_per_group: list = []
+    for (state, upgrade_id), group_ids in state_upgrade_groups.items():
+        take = min(sample_size, len(group_ids))
+        selected_per_group.extend(group_ids[:take])
+        console.print(
+            f"[green]Sampling {take} building IDs for State {state}, Upgrade {upgrade_id} (of {len(group_ids)} available).[/green]"
+        )
+
+    if not selected_per_group and len(bldg_ids) > 0:
+        console.print("[yellow]No building IDs selected after sampling per group.[/yellow]")
+
+    return selected_per_group
+
+
 def _validate_required_inputs(inputs: dict[str, Union[str, list[str]]]) -> Union[str, bool]:
     """Validate that all required inputs are provided."""
     if not all([
@@ -765,7 +830,7 @@ RELEASE_YEAR_OPTION = typer.Option(None, "--release_year", "-y", help="Release y
 WEATHER_FILE_OPTION = typer.Option(None, "--weather_file", "-w", help='"tmy3", "amy2012", "amy2018"')
 RELEASE_VERSION_OPTION = typer.Option(None, "--release_version", "-r", help="1, 1.1, or 2")
 STATES_OPTION = typer.Option(
-    None, "--states", "-s", help="List of states (multiple can be provided, inside quotes and separated by spaces)"
+    None, "--states", "-st", help="List of states (multiple can be provided, inside quotes and separated by spaces)"
 )
 FILE_TYPE_OPTION = typer.Option(
     None,
@@ -777,6 +842,12 @@ UPGRADE_ID_OPTION = typer.Option(
     None, "--upgrade_id", "-u", help="Upgrade IDs (multiple can be provided, inside quotes and separated by spaces)"
 )
 OUTPUT_DIRECTORY_OPTION = typer.Option(None, "--output_directory", "-o", help='e.g., "data" or "../output"')
+SAMPLE_OPTION = typer.Option(
+    None,
+    "--sample",
+    "-sm",
+    help="Number of building IDs to download across all upgrades (only applies to direct inputs)",
+)
 VERSION_OPTION = typer.Option(False, "--version", "-v", help="Show version information and exit")
 
 
@@ -824,7 +895,8 @@ def _process_direct_inputs(
     file_type: str,
     upgrade_id: str,
     output_directory: str,
-) -> dict[str, Union[str, list[str]]]:
+    sample: Union[str, None] = None,
+) -> tuple[dict[str, Union[str, list[str]]], Union[str, None]]:
     """Process direct command line inputs."""
     states_list = states.split() if states else []
     upgrade_ids_list = upgrade_id.split() if upgrade_id else ["0"]
@@ -850,10 +922,10 @@ def _process_direct_inputs(
         console.print(f"\n[red]Invalid product: {direct_inputs['product']}[/red]")
         raise typer.Exit(1) from None
 
-    return direct_inputs
+    return direct_inputs, sample
 
 
-def _process_data_download(inputs: dict[str, Union[str, list[str]]]) -> None:
+def _process_data_download(inputs: dict[str, Union[str, list[str]]], sample: Union[str, None] = None) -> None:
     """Process data download based on available file types."""
     available_file_types, unavailable_file_types = _check_unavailable_file_types(inputs)
     if "weather" in inputs["file_type"]:
@@ -865,8 +937,12 @@ def _process_data_download(inputs: dict[str, Union[str, list[str]]]) -> None:
         # Fetch the building ids and download data
         bldg_ids = _fetch_all_building_ids(inputs)
 
-        # Ask user about download choice
-        selected_bldg_ids = _get_user_download_choice(bldg_ids)
+        # If sample is provided (direct input mode), use it to sample building IDs
+        if sample is not None:
+            selected_bldg_ids = _select_bldg_ids_for_sample(bldg_ids, sample)
+        else:
+            # Ask user about download choice (interactive mode)
+            selected_bldg_ids = _get_user_download_choice(bldg_ids)
 
         if selected_bldg_ids:
             file_type_tuple = (
@@ -895,6 +971,7 @@ def main_callback(
     file_type: str = FILE_TYPE_OPTION,
     upgrade_id: str = UPGRADE_ID_OPTION,
     output_directory: str = OUTPUT_DIRECTORY_OPTION,
+    sample: str = SAMPLE_OPTION,
     version: bool = VERSION_OPTION,
 ) -> None:
     """
@@ -908,14 +985,23 @@ def main_callback(
     # If no arguments provided, run interactive mode
     if not any([product, release_year, weather_file, release_version, states, file_type]):
         inputs = _run_interactive_mode_wrapper()
+        sample_value = None
     else:
-        inputs = _process_direct_inputs(
-            product, release_year, weather_file, release_version, states, file_type, upgrade_id, output_directory
+        inputs, sample_value = _process_direct_inputs(
+            product,
+            release_year,
+            weather_file,
+            release_version,
+            states,
+            file_type,
+            upgrade_id,
+            output_directory,
+            sample,
         )
 
     # Process the data
     _print_data_processing_info(inputs)
-    _process_data_download(inputs)
+    _process_data_download(inputs, sample_value)
 
 
 app.command()(main_callback)

{buildstock_fetch-1.4.3.dist-info → buildstock_fetch-1.4.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: buildstock-fetch
-Version: 1.4.3
+Version: 1.4.5
 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/

{buildstock_fetch-1.4.3.dist-info → buildstock_fetch-1.4.5.dist-info}/RECORD

@@ -1,9 +1,9 @@
-buildstock_fetch/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+buildstock_fetch/__init__.py,sha256=Fv2JHnR-ADpzdVitwHAsUrkhe-BpoDkmx7MxtXxlm1k,22
 buildstock_fetch/__main__.py,sha256=wEPNJ-s7F6KcRQ_4B5Xh08uqvYZHno5F2R8DU0BMBtk,80
-buildstock_fetch/main.py,sha256=yZ8xoYWnoyeTIDMXzVnbQt57a2NAZS7bEPRDtj_SuiU,90887
-buildstock_fetch/main_cli.py,sha256=ZZ6Yn7rBfXguCiUSszKlB0L-FY88ZJM_HXLC8o1EGNc,36311
+buildstock_fetch/main.py,sha256=zvVfr_fPqC83B3i0S860WFPJOB0SbDZ_LLfaL9IGtMs,90913
+buildstock_fetch/main_cli.py,sha256=4RbIvWjy5VT4BiqfEE3_tXGnGh18M5L4QkMV7SA6vyk,39571
 buildstock_fetch/data/buildstock_releases.json,sha256=XL-D1Xdix59sFGbS6vKFiGhQakhhPrwn14N-Tgt9iuk,11620
-buildstock_fetch/data/buildstock_upgrades_lookup.json,sha256=CCc2dV6voD8r6WpBBq9zoxhVQGAPcUGmAoFyKoUcUpo,1486
+buildstock_fetch/data/buildstock_upgrades_lookup.json,sha256=Nt2R_p-7JN0S-MpGrQQqwAzvEtRRx-PmGqgWrUvHTDw,5801
 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
@@ -1603,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.3.dist-info/licenses/LICENSE,sha256=TJeh2yvO8__8Rbamd8r48-zvlFCINAsu9nOo5QdMRX8,1066
-buildstock_fetch-1.4.3.dist-info/METADATA,sha256=7TaxdMpRmwemxFqaneiJ09sXgPzlcuc_xBUIPGdzTn4,8323
-buildstock_fetch-1.4.3.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-buildstock_fetch-1.4.3.dist-info/entry_points.txt,sha256=C7zPk3BSLcI47ymvYKI05nvfRJMEXz4BPIIDKsjePn8,54
-buildstock_fetch-1.4.3.dist-info/top_level.txt,sha256=-PGb2C-Tb3O-wPqUHSOBrvJqRzNHgY_KTbTsXaHIo5M,17
-buildstock_fetch-1.4.3.dist-info/RECORD,,
+buildstock_fetch-1.4.5.dist-info/licenses/LICENSE,sha256=TJeh2yvO8__8Rbamd8r48-zvlFCINAsu9nOo5QdMRX8,1066
+buildstock_fetch-1.4.5.dist-info/METADATA,sha256=wfDXp8KQNXGzGwyOCbRILkX2VOlxmwdwPOgvkfQN57c,8323
+buildstock_fetch-1.4.5.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+buildstock_fetch-1.4.5.dist-info/entry_points.txt,sha256=C7zPk3BSLcI47ymvYKI05nvfRJMEXz4BPIIDKsjePn8,54
+buildstock_fetch-1.4.5.dist-info/top_level.txt,sha256=-PGb2C-Tb3O-wPqUHSOBrvJqRzNHgY_KTbTsXaHIo5M,17
+buildstock_fetch-1.4.5.dist-info/RECORD,,