RS/YJ/Rule 11-17

docs/ruleset_functions/get_SWH_bats_and_SWH_use.md

@@ -1,6 +1,6 @@
 ## get_SWH_bats_and_SWH_use
 
-Description: This function gets all the SWH Uses and the SWH space types and sorts them into a dictionary where the keys are the ServiceWaterHeatingBuildingAreaOptions2019ASHRAE901 and values are a list if ServiceWaterHeatingUse.ids  
+Description: This function gets all the SWH Uses and the SWH space types and sorts them into a dictionary where the keys are the ServiceWaterHeatingBuildingAreaOptions2019ASHRAE901 and values are a list of ServiceWaterHeatingUse.ids  
 
 Inputs:
 - **RMD**
@@ -17,11 +17,10 @@ Function Call:
 Logic:
 - create a blank dictionary: `swh_and_SWH_use_dict = {}`
 - look at each building segment: `for building_segment in RMD.building_segments:`
-    - get the swh_bat by using the function: get_building_segment_SWH_bat: `swh_bat = get_building_segment_SWH_bat(RMD,building_segment)`
-    - add this bat to swh_and_SWH_use_dict if it doesnt exist yet: `swh_and_SWH_use_dict.set_default(swh_bat,[])`
-    - get the service water heating uses in the building segment `service_water_heating_use_ids = get_SWH_uses_associated_with_each_building_segment(P_RMD, building_segment.id)`
-    - add all of the swh_use ids in the building segment to the list: `for swh_use in building_segment.service_water_heating_uses:`
-        - append the id of the swh_use to the list: `swh_and_SWH_use_dict[swh_bat].append(swh_use.id)`
+    - get the swh_bat by using the function: get_building_segment_SWH_bat: `swh_bat = get_building_segment_SWH_bat(RMD,building_segment["id"])`
+    - add this bat to swh_and_SWH_use_dict if it doesnt exist yet: `swh_and_SWH_use_dict.setdefault(swh_bat,[])`
+    - get the service water heating use ids in the building segment `service_water_heating_use_ids = get_SWH_uses_associated_with_each_building_segment(RMD, building_segment.id)`
+    - add all of the swh_use ids in the building segment to the list: `service_water_heating_use_ids[swh_bat].extend(service_water_heating_use_ids) `
 
 **Returns** swh_and_SWH_use_dict
 

docs/section11/Rule11-17.md

@@ -19,28 +19,21 @@
 - **get_SWH_uses_associated_with_each_building_segment**  
 - **get_component_by_id**  
 
-## Applicability Checks:  
-
-- look at each building in the proposed RMD: `for building in P_RMD:`
-    - look at each building segment: `for building_segment in building:`
-        - we want to look at all building segments, so continue directly to the rule logic: `CONTINUE TO RULE LOGIC`
 
-        ## Rule Logic:
-        - get the building segment service water heating building area type: `swh_bat = get_building_segment_SWH_bat(P_RMD,building_segment)`
-        - check if the building segment has service water heating loads.  First create a boolean has_swh_loads and set it to false: `has_swh_loads = false`
-        - get the service water heating uses in the building segment `service_water_heating_use_ids = get_SWH_uses_associated_with_each_building_segment(P_RMD, building_segment.id)`
-        - look at each service water heating use id: `for swh_use_id in service_water_heating_use_ids:`
-            - get the swh_use using get_component_by_ID: `swh_use = get_component_by_ID(P_RMD, swh_use_id)`
-            - check to see if the use has SWH loads: `if swh_use.use > 0:`
-                - set has_swh_loads to TRUE and break out of the loop: `has_swh_loads = TRUE; break;`
-
-
-
-        ## Rule Assertion:
-        - if the building segment has SWH loads, PASS: `if has_swh_loads: PASS`
-        - if the BAT is UNDETERMINED, then rule outcome is UNDETERMINED and provide a note: `elif swh_bat == 'UNDETERMINED': UNDETERMINED; note = "No SWH loads were simulated. The SWH Building Area type is UNDETERMINED, so this rule cannot assess whether building type is likely to have SWH loads. Recommend manual check to determine if SWH loads should have been simulated based on whether the building will have SWH loads."` 
-        - otherwise, check if the BAT is one of OTHER, WAREHOUSE or PARKING_GARAGE, rule outcome is UNDETERMINED: `elif: swh_bat in ['OTHER', 'WAREHOUSE', 'PARKING_GARAGE']: UNDETERMINED; note = "There are no service water heating loads simulated in this building segment. SWH Building Area type is " + swh_bat + ".  Confirm that there will be no service water heating loads in this building segment."`
-        - otherwise, all other cases fail: `else: FAIL; note = "There were no service water heating loads simulated in this building segment.  Service water heating loads are expected for Building Area Type: " + swh_bat`
+## Rule Logic:
+- get the building segment service water heating building area type: `swh_bat = get_building_segment_SWH_bat(P_RMD,building_segment)`
+- check if the building segment has service water heating loads.  First create a boolean has_swh_loads and set it to false: `has_swh_loads = false`
+- get the service water heating uses in the building segment `service_water_heating_use_ids = get_SWH_uses_associated_with_each_building_segment(P_RMD, building_segment.id)`
+- look at each service water heating use id: `for swh_use_id in service_water_heating_use_ids:`
+    - get the swh_use using get_component_by_ID: `swh_use = get_component_by_ID(P_RMD, swh_use_id)`
+    - check to see if the use has SWH loads: `if swh_use.use > 0:`
+        - set has_swh_loads to TRUE and break out of the loop: `has_swh_loads = TRUE; break;`
+
+## Rule Assertion:
+- if the building segment has SWH loads, PASS: `if has_swh_loads: PASS`
+- if the BAT is UNDETERMINED, then rule outcome is UNDETERMINED and provide a note: `elif swh_bat == 'UNDETERMINED': UNDETERMINED; note = "No SWH loads were simulated. The SWH Building Area type is UNDETERMINED, so this rule cannot assess whether building type is likely to have SWH loads. Recommend manual check to determine if SWH loads should have been simulated based on whether the building will have SWH loads."` 
+- otherwise, check if the BAT is one of ALL_OTHERS, WAREHOUSE or PARKING_GARAGE, rule outcome is UNDETERMINED: `elif: swh_bat in ['ALL_OTHERS', 'WAREHOUSE', 'PARKING_GARAGE']: UNDETERMINED; note = "There are no service water heating loads simulated in this building segment. SWH Building Area type is " + swh_bat + ".  Confirm that there will be no service water heating loads in this building segment."`
+- otherwise, all other cases fail: `else: FAIL; note = "There were no service water heating loads simulated in this building segment.  Service water heating loads are expected for Building Area Type: " + swh_bat`
 
 ## Notes:  
 1. checking this at the proposed model.  The check for the baseline model will be done by checking that proposed = baseline in Rule 11-15

docs/section11/Rule11-6.md

@@ -3,7 +3,7 @@
 **Schema Version:** 0.0.37  
 **Mandatory Rule:** True  
 **Rule ID:** 11-6  
-**Rule Description:** Piping losses shall not be modeled. 
+**Rule Description:** Piping losses shall not be modeled.  
 **Rule Assertion:** Options are PASS/FAIL/NOT_APPLICABLE/UNDETERMINED  
 **Appendix G Section Reference:** Table G3.1 #11, baseline column, i
 

rct229/cli.py

@@ -29,7 +29,7 @@ def cli():
     Software test workflow, add sections to do test. \n
     --ruleset or -rs: default is ashrae9012019, available: ashrae9012019\n
     argument (optional): section string, \n
-    currently available: section1, section4, section5, section6, section10, section12, section16, section18, section19, section21, section22 and section23"""
+    currently available: section1, section4, section5, section6, section10, section11, section12, section16, section18, section19, section21, section22 and section23"""
 
 
 @cli.command(

rct229/rule_engine/rulesets.py

@@ -10,6 +10,7 @@ class RuleSetTest:
         "section5",
         "section6",
         "section10",
+        "section11",
         "section12",
         "section16",
         "section18",

rct229/rulesets/ashrae9012019/__init__.py

@@ -11,6 +11,7 @@
     "section5",
     "section6",
     "section10",
+    "section11",
     "section12",
     "section16",
     "section18",

rct229/rulesets/ashrae9012019/ruleset_functions/get_swh_bats_and_swh_use.py

@@ -0,0 +1,39 @@
+from rct229.rulesets.ashrae9012019.ruleset_functions.get_building_segment_swh_bat import (
+    get_building_segment_swh_bat,
+)
+from rct229.rulesets.ashrae9012019.ruleset_functions.get_swh_uses_associated_with_each_building_segment import (
+    get_swh_uses_associated_with_each_building_segment,
+)
+from rct229.utils.jsonpath_utils import find_all
+
+
+def get_swh_bats_and_swh_use(rmd: dict) -> dict:
+    """
+    This function gets all the SWH Uses and the SWH space types and sorts them into a dictionary where the keys are the ServiceWaterHeatingBuildingAreaOptions2019ASHRAE901
+    and values are a list of ServiceWaterHeatingUse.ids
+
+    Parameters
+    ----------
+    rmd: dict
+        The ruleset model descriptions
+
+    Returns
+    -------
+    swh_bat_and_SWH_use_dict: dict
+        A dictionary containing where the keys are the ServiceWaterHeatingSpaceOptions2019ASHRAE901 in the RMD and values are lists of SWHUse ids.
+        Example: {"DORMITORY":["swh1","swh2","swh3"], "AUTOMOTIVE_FACILITY":["swhg1","swhg2","swhg3"]}
+    """
+
+    swh_and_swh_use_dict = {}
+    for building_segment in find_all("$.buildings[*].building_segments[*]", rmd):
+        bldg_seg_id = building_segment["id"]
+        swh_bat = get_building_segment_swh_bat(rmd, bldg_seg_id)
+        swh_and_swh_use_dict.setdefault(swh_bat, [])
+
+        service_water_heating_use_ids = (
+            get_swh_uses_associated_with_each_building_segment(rmd, bldg_seg_id)
+        )
+
+        swh_and_swh_use_dict[swh_bat].extend(service_water_heating_use_ids)
+
+    return swh_and_swh_use_dict

rct229/rulesets/ashrae9012019/ruleset_functions/get_swh_bats_and_swh_use_test.py

@@ -0,0 +1,120 @@
+from rct229.rulesets.ashrae9012019.ruleset_functions.get_swh_bats_and_swh_use import (
+    get_swh_bats_and_swh_use,
+)
+from rct229.schema.schema_utils import quantify_rmd
+from rct229.schema.validate import schema_validate_rmd
+
+TEST_RMD = {
+    "id": "test_rmd",
+    "buildings": [
+        {
+            "id": "Building 1",
+            "building_open_schedule": "Required Building Schedule 1",
+            "building_segments": [
+                {
+                    "id": "Building Segment 1",
+                    "zones": [
+                        {
+                            "id": "Zone 1",
+                            "spaces": [
+                                {
+                                    "id": "Space 1",
+                                    "service_water_heating_building_area_type": "HOTEL",
+                                    "service_water_heating_uses": [
+                                        {
+                                            "id": "service water heating uses 1_1",
+                                            "use": 400,
+                                            "use_units": "POWER",
+                                        },
+                                        {
+                                            "id": "service water heating uses 1_2",
+                                            "use": 500,
+                                            "use_units": "POWER",
+                                        },
+                                    ],
+                                }
+                            ],
+                        }
+                    ],
+                },
+                {
+                    "id": "Building Segment 2",
+                    "zones": [
+                        {
+                            "id": "Zone 2",
+                            "spaces": [
+                                {
+                                    "id": "Space 2",
+                                    "service_water_heating_building_area_type": "OFFICE",
+                                    "service_water_heating_uses": [
+                                        {
+                                            "id": "service water heating uses 2_1",
+                                            "use": 400,
+                                            "use_units": "POWER",
+                                        },
+                                        {
+                                            "id": "service water heating uses 2_2",
+                                            "use": 500,
+                                            "use_units": "POWER",
+                                        },
+                                    ],
+                                }
+                            ],
+                        }
+                    ],
+                },
+            ],
+        }
+    ],
+    "schedules": [
+        {
+            "id": "SWH Schedule 1",
+            "hourly_values": [0.8] * 8760,
+        },
+        {
+            "id": "SWH Entering Water Temp Schedule 1",
+            "hourly_values": [50] * 8760,
+        },
+    ],
+    "service_water_heating_distribution_systems": [
+        {
+            "id": "SWH Distribution 1",
+            "design_supply_temperature": 60,
+            "drain_heat_recovery_efficiency": 0.3,
+            "entering_water_mains_temperature_schedule": "SWH Entering Water Temp Schedule 1",
+            "tanks": [
+                {
+                    "id": "Tank 1",
+                }
+            ],
+            "service_water_piping": [
+                {
+                    "id": "SWH Piping 1",
+                }
+            ],
+        }
+    ],
+    "type": "BASELINE_0",
+}
+
+TEST_RPD_FULL = {
+    "id": "229",
+    "ruleset_model_descriptions": [TEST_RMD],
+    "data_timestamp": "2024-02-12T09:00Z",
+}
+
+TEST_RMD = quantify_rmd(TEST_RPD_FULL)["ruleset_model_descriptions"][0]
+
+
+def test__TEST_RPD__is_valid():
+    schema_validation_result = schema_validate_rmd(TEST_RPD_FULL)
+    assert schema_validation_result[
+        "passed"
+    ], f"Schema error: {schema_validation_result['error']}"
+
+
+def test__get_swh_bats_and_swh_use__two_bldg_seg():
+    assert get_swh_bats_and_swh_use(TEST_RMD) == {
+        "HOTEL": ["service water heating uses 1_1", "service water heating uses 1_2"],
+        "OFFICE": ["service water heating uses 2_1", "service water heating uses 2_2"],
+    }

rct229/rulesets/ashrae9012019/section11/__init__.py

@@ -0,0 +1,32 @@
+# Add all available rule modules in __all__
+import importlib
+
+__all__ = [
+    # "section11rule1",
+    # "section11rule2",
+    # "section11rule3",
+    # "section11rule4",
+    # "section11rule5",
+    "section11rule6",
+    # "section11rule7",
+    # "section11rule8",
+    # "section11rule9",
+    # "section11rule10",
+    # "section11rule11",
+    # "section11rule12",
+    # "section11rule13",
+    # "section11rule14",
+    # "section11rule15",
+    # "section11rule16",
+    "section11rule17",
+]
+
+
+def __getattr__(name):
+    if name in __all__:
+        return importlib.import_module("." + name, __name__)
+    raise AttributeError(f"module {__name__!r} has no attribute {name!r}")
+
+
+def __dir__():
+    return sorted(__all__)