buildstock-fetch 1.0.4__py3-none-any.whl → 1.2.0__py3-none-any.whl

buildstock_fetch/main_cli.py

@@ -1,6 +1,5 @@
 import json
 import pprint
-import random
 from collections.abc import Mapping
 from importlib.resources import files
 from pathlib import Path
@@ -29,6 +28,9 @@ app = typer.Typer(
 # File configuration
 BUILDSTOCK_RELEASES_FILE = str(files("buildstock_fetch").joinpath("data").joinpath("buildstock_releases.json"))
 
+# File types that haven't been implemented yet
+UNAVAILABLE_FILE_TYPES = ["load_curve_hourly", "load_curve_daily"]
+
 
 class InvalidProductError(Exception):
     """Exception raised when an invalid product is provided."""
@@ -223,6 +225,7 @@ def _get_file_type_options_grouped(release_name: str) -> list[dict]:
             "load_curve_annual",
         ],
         "Metadata": ["metadata"],
+        "Weather": ["weather"],
     }
 
     choices = []
@@ -380,6 +383,7 @@ def _run_interactive_mode() -> dict[str, Union[str, list[str]]]:
             validate=_validate_output_directory,
         ).ask()
     )
+
     output_directory_path = Path(output_directory_str)
     output_directory_path.mkdir(parents=True, exist_ok=True)
     return {
@@ -431,18 +435,80 @@ def _print_data_processing_info(inputs: Mapping[str, Union[str, list[str]]]) ->
     print(f"Output directory: {inputs['output_directory']}")
 
 
-def _check_unavailable_file_types(inputs: Mapping[str, Union[str, list[str]]]) -> None:
-    """Check and print warning for unavailable file types."""
-    unavailable_file_types = ["load_curve_hourly", "load_curve_daily", "load_curve_monthly"]
-    selected_file_types = inputs["file_type"].split() if isinstance(inputs["file_type"], str) else inputs["file_type"]
-    selected_unavailable = [ft for ft in selected_file_types if ft in unavailable_file_types]
-    if selected_unavailable:
+def _check_weather_map_available_states(inputs: Mapping[str, Union[str, list[str]]]) -> tuple[list[str], list[str]]:
+    """Check if the weather map is available for the given release and state."""
+    available_states: list[str] = []
+    unavailable_states: list[str] = []
+    product_short_name = "res" if inputs["product"] == "resstock" else "com"
+    release_name = f"{product_short_name}_{inputs['release_year']}_{inputs['weather_file']}_{inputs['release_version']}"
+    selected_release = _get_all_available_releases()[release_name]
+    if "weather_map_available_states" not in selected_release:
+        unavailable_states = inputs["states"] if isinstance(inputs["states"], list) else [inputs["states"]]
+    else:
+        unavailable_states = [
+            state for state in inputs["states"] if state not in selected_release["weather_map_available_states"]
+        ]
+        available_states = [
+            state for state in inputs["states"] if state in selected_release["weather_map_available_states"]
+        ]
+    return available_states, unavailable_states
+
+
+def _check_weather_file_availability(
+    inputs: Mapping[str, Union[str, list[str]]],
+    available_file_types: list[str],
+    selected_unavailable_file_types: list[str],
+) -> None:
+    """Check weather file availability and update file type lists."""
+    available_states, unavailable_states = _check_weather_map_available_states(inputs)
+
+    if len(unavailable_states) > 0:
+        selected_unavailable_file_types.append("weather")
+        if len(unavailable_states) == len(inputs["states"]) and "weather" in available_file_types:
+            available_file_types.remove("weather")
+
+    if len(unavailable_states) > 0:
+        console.print(
+            f"\n[yellow]The weather map is not available for the following states: {unavailable_states}[/yellow]"
+        )
+        console.print(
+            "\n[yellow]Please first build the weather station mapping for this state using the weather station mapping CLI tool (just build-weather-station-map)[/yellow]"
+        )
+    for state in unavailable_states:
+        selected_unavailable_file_types.append(f"weather: {state}")
+
+
+def _print_unavailable_file_types_warning(selected_unavailable_file_types: list[str]) -> None:
+    """Print warning for unavailable file types."""
+    if selected_unavailable_file_types:
         console.print("\n[yellow]The following file types are not available yet:[/yellow]")
-        for file_type in selected_unavailable:
+        for file_type in selected_unavailable_file_types:
             console.print(f"  • {file_type}")
         console.print("")
 
 
+def _check_unavailable_file_types(inputs: Mapping[str, Union[str, list[str]]]) -> tuple[list[str], list[str]]:
+    """Check and print warning for unavailable file types."""
+    selected_file_types = inputs["file_type"].split() if isinstance(inputs["file_type"], str) else inputs["file_type"]
+    # Create a copy to avoid modifying the original list
+    available_file_types = selected_file_types.copy()
+    selected_unavailable_file_types = []
+
+    for ft in selected_file_types:
+        if ft in UNAVAILABLE_FILE_TYPES:
+            selected_unavailable_file_types.append(ft)
+            # Only remove if it exists in available_file_types
+            if ft in available_file_types:
+                available_file_types.remove(ft)
+
+    if "weather" in selected_file_types:
+        _check_weather_file_availability(inputs, available_file_types, selected_unavailable_file_types)
+
+    _print_unavailable_file_types_warning(selected_unavailable_file_types)
+
+    return available_file_types, selected_unavailable_file_types
+
+
 def _fetch_all_building_ids(inputs: Mapping[str, Union[str, list[str]]]) -> list:
     """Fetch building IDs for all states and upgrade IDs."""
     bldg_ids = []
@@ -512,8 +578,8 @@ def _get_user_download_choice(bldg_ids: list) -> list:
                 console.print(f"[yellow]No files will be downloaded for State {state}, Upgrade {upgrade_id}.[/yellow]")
                 continue
 
-            # Randomly select the specified number of building IDs for this state-upgrade_id pair
-            selected_for_state_upgrade = random.sample(bldg_list, sample_size)
+            # Select the first N building IDs for this state-upgrade_id pair
+            selected_for_state_upgrade = bldg_list[:sample_size]
             selected_bldg_ids.extend(selected_for_state_upgrade)
             console.print(f"[green]Selected {sample_size} buildings for State {state}, Upgrade {upgrade_id}.[/green]")
 
@@ -643,6 +709,94 @@ UPGRADE_ID_OPTION = typer.Option(
 OUTPUT_DIRECTORY_OPTION = typer.Option(None, "--output_directory", "-o", help='e.g., "data" or "../output"')
 
 
+def _run_interactive_mode_wrapper() -> dict[str, Union[str, list[str]]]:
+    """Run interactive mode with error handling."""
+    try:
+        while True:
+            inputs = _run_interactive_mode()
+            if _verify_interactive_inputs(inputs):
+                return inputs
+            console.print("[yellow]Let's try again...[/yellow]")
+    except KeyboardInterrupt:
+        console.print("\n[red]Operation cancelled by user.[/red]")
+        raise typer.Exit(0) from None
+
+
+def _process_direct_inputs(
+    product: str,
+    release_year: str,
+    weather_file: str,
+    release_version: float,
+    states: str,
+    file_type: str,
+    upgrade_id: str,
+    output_directory: str,
+) -> dict[str, Union[str, list[str]]]:
+    """Process direct command line inputs."""
+    states_list = states.split() if states else []
+    upgrade_ids_list = upgrade_id.split() if upgrade_id else ["0"]
+    file_type_list = file_type.split() if file_type else []
+
+    direct_inputs: dict[str, Union[str, list[str]]] = {
+        "product": product,
+        "release_year": release_year,
+        "weather_file": weather_file,
+        "release_version": _normalize_release_version(release_version),
+        "states": states_list,
+        "file_type": file_type_list,
+        "upgrade_ids": upgrade_ids_list,
+        "output_directory": output_directory,
+    }
+
+    try:
+        validation_result = _validate_direct_inputs(direct_inputs)
+        if validation_result is not True:
+            console.print(f"\n[red]{validation_result}[/red]")
+            raise typer.Exit(1) from None
+    except InvalidProductError:
+        console.print(f"\n[red]Invalid product: {direct_inputs['product']}[/red]")
+        raise typer.Exit(1) from None
+
+    return direct_inputs
+
+
+def _process_data_download(inputs: dict[str, Union[str, list[str]]]) -> 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"]:
+        available_weather_states, unavailable_weather_states = _check_weather_map_available_states(inputs)
+    else:
+        available_weather_states = None
+
+    if len(available_file_types) > 0:
+        # 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 selected_bldg_ids:
+            file_type_tuple = (
+                tuple(inputs["file_type"].split())
+                if isinstance(inputs["file_type"], str)
+                else tuple(inputs["file_type"])
+            )
+            output_dir = inputs["output_directory"]
+            if isinstance(output_dir, list):
+                output_dir = output_dir[0] if output_dir else "."
+
+            print(selected_bldg_ids)
+            print(available_weather_states)
+            print(file_type_tuple)
+            fetch_bldg_data(
+                selected_bldg_ids, file_type_tuple, Path(output_dir), weather_states=available_weather_states
+            )
+        else:
+            console.print("[yellow]No files selected for download.[/yellow]")
+    else:
+        console.print("[yellow]None of the selected file types are available for download.[/yellow]")
+
+
 def main_callback(
     product: str = PRODUCT_OPTION,
     release_year: str = RELEASE_YEAR_OPTION,
@@ -659,61 +813,15 @@ def main_callback(
 
     # If no arguments provided, run interactive mode
     if not any([product, release_year, weather_file, release_version, states, file_type]):
-        try:
-            while True:
-                inputs = _run_interactive_mode()
-                if _verify_interactive_inputs(inputs):
-                    break
-                console.print("[yellow]Let's try again...[/yellow]")
-        except KeyboardInterrupt:
-            console.print("\n[red]Operation cancelled by user.[/red]")
-            raise typer.Exit(0) from None
+        inputs = _run_interactive_mode_wrapper()
     else:
-        states_list = states.split() if states else []
-        upgrade_ids_list = upgrade_id.split() if upgrade_id else ["0"]
-        file_type_list = file_type.split() if file_type else []
-
-        direct_inputs: dict[str, Union[str, list[str]]] = {
-            "product": product,
-            "release_year": release_year,
-            "weather_file": weather_file,
-            "release_version": _normalize_release_version(release_version),
-            "states": states_list,
-            "file_type": file_type_list,
-            "upgrade_ids": upgrade_ids_list,
-            "output_directory": output_directory,
-        }
-        try:
-            validation_result = _validate_direct_inputs(direct_inputs)
-            if validation_result is not True:
-                console.print(f"\n[red]{validation_result}[/red]")
-                raise typer.Exit(1) from None
-        except InvalidProductError:
-            console.print(f"\n[red]Invalid product: {direct_inputs['product']}[/red]")
-            raise typer.Exit(1) from None
-
-        inputs = direct_inputs
+        inputs = _process_direct_inputs(
+            product, release_year, weather_file, release_version, states, file_type, upgrade_id, output_directory
+        )
 
     # Process the data
     _print_data_processing_info(inputs)
-    _check_unavailable_file_types(inputs)
-
-    # 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 selected_bldg_ids:
-        file_type_tuple = (
-            tuple(inputs["file_type"].split()) if isinstance(inputs["file_type"], str) else tuple(inputs["file_type"])
-        )
-        output_dir = inputs["output_directory"]
-        if isinstance(output_dir, list):
-            output_dir = output_dir[0] if output_dir else "."
-        fetch_bldg_data(selected_bldg_ids, file_type_tuple, Path(output_dir))
-    else:
-        console.print("[yellow]No files selected for download.[/yellow]")
+    _process_data_download(inputs)
 
 
 app.command()(main_callback)

{buildstock_fetch-1.0.4.dist-info → buildstock_fetch-1.2.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: buildstock-fetch
-Version: 1.0.4
+Version: 1.2.0
 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/
@@ -44,6 +44,7 @@ Requires-Dist: botocore>=1.33.0; extra == "dev-utils"
 Requires-Dist: pyarrow>=14.0.1; extra == "dev-utils"
 Requires-Dist: numpy>=1.26.4; extra == "dev-utils"
 Requires-Dist: scikit-learn>=1.6.1; extra == "dev-utils"
+Requires-Dist: xmltodict>=0.14.2; extra == "dev-utils"
 Provides-Extra: dev
 Requires-Dist: buildstock-fetch[dev-utils,docs,lint,test]; extra == "dev"
 Requires-Dist: tox-uv>=1.11.3; extra == "dev"
@@ -59,7 +60,8 @@ Dynamic: license-file
 This library simplifies downloading building characteristics and load curve data from NREL's ResStock and ComStock projects.
 
 - **Github repository**: <https://github.com/switchbox-data/buildstock-fetch/>
-- **Documentation** <https://switchbox-data.github.io/buildstock-fetch/>
+- **Documentation**: <https://switchbox-data.github.io/buildstock-fetch/>
+- **PyPI page***: <https://pypi.org/project/buildstock-fetch/>
 
 ## Installing the library