Uniform Energy Factor Not Working

[lukeduran]

I see that your documentation indicates that both energyFactor or uniformEnergyFactor can be provided, but the latter is not working.

Request

{
            "addressFull": "1301 NE Hilltop Dr, Blue Springs, MO 64014-2332",
            "addressComponents": {
                "addressLine1": "1301 NE Hilltop Dr",
                "city": "Blue Springs",
                "stateAbbreviation": "MO",
                "zipCode": "64014-2332"
            },
            "baseBuilding": {
                "buildingSummary": {
                    "yearBuilt": 1974,
                    "bedroomsCount": 5,
                    "averageCeilingHeight": 8,
                    "conditionedFloorArea": 3300
                },
                "enclosure": {
                    "airInfiltration": {
                        "rate": 2490,
                        "rateUnit": "CFM"
                    },
                    "attics": [
                        {
                            "floorAssemblyEffectiveRValue": 38,
                            "id": "attic-insulation-1"
                        },
                        {
                            "floorAssemblyEffectiveRValue": 13,
                            "id": "attic-insulation-2"
                        }
                    ],
                    "foundations": [
                        {
                            "type": "basement unconditioned",
                            "id": "floor-and-foundation-insulation-1"
                        }
                    ],
                    "walls": [
                        {
                            "assemblyEffectiveRValue": 5,
                            "id": "wall-insulation-1"
                        }
                    ]
                },
                "systems": {
                    "hvac": {
                        "hvacHeatingSystems": [
                            {
                                "systemType": "furnace",
                                "fuel": "natural gas",
                                "heatLoadFraction": 1.0,
                                "heatEfficiency": 0.8,
                                "heatEfficiencyUnits": "AFUE",
                                "id": "heating-systems-1"
                            }
                        ],
                        "hvacCoolingSystems": [
                            {
                                "systemType": "central air conditioner",
                                "coolLoadFraction": 1.0,
                                "coolEfficiency": 14.0,
                                "coolEfficiencyUnits": "SEER",
                                "id": "cooling-systems-1"
                            }
                        ]
                    },
                    "waterHeating": {
                        "waterHeatingSystems": [
                            {
                                "fuel": "natural gas",
                                "dhwLoadFraction": 1.0,
                                "id": "water-heating-1",
                                "uniformEnergyFactor": 0.82
                            }
                        ]
                    }
                }
            },
            "globalControls": {
                "debug": true,
                "includeInputs": true,
                "includeBase": true,
                "includeTypical": true,
                "useFixture": false,
                "resolution": [
                    "annual",
                    "monthly"
                ],
                "timelineStartDate": "2024-03-21",
                "timelineDurationInYears": 1,
                "units": {
                    "energyStandard": "MBtu",
                    "coal": "metric ton",
                    "electricity": "MBtu",
                    "fuelOil": "MBtu",
                    "naturalGas": "MBtu",
                    "propane": "MBtu",
                    "woodCord": "MBtu",
                    "woodPellets": "MBtu",
                    "monetary": "USD",
                    "emissions": "CO2"
                }
            }
        }

Response

        {
    "globalControls": {
        "timelineStartDate": "2024-03-21",
        "debug": true,
        "includeInputs": true,
        "resolution": [
            "monthly",
            "annual"
        ],
        "includeBase": true,
        "includeTypical": true,
        "useFixture": false,
        "timelineDurationInYears": 1,
        "units": {
            "monetary": "USD",
            "electricity": "MBtu",
            "naturalGas": "MBtu",
            "woodPellets": "MBtu",
            "propane": "MBtu",
            "coal": "metric ton",
            "emissions": "CO2",
            "woodCord": "MBtu",
            "energyStandard": "MBtu",
            "fuelOil": "MBtu"
        }
    },
    "addressFull": "1301 NE Hilltop Dr, Blue Springs, MO 64014-2332",
    "baseBuilding": {
        "systems": {
            "waterHeating": {
                "waterHeatingSystems": [
                    {
                        "dhwLoadFraction": 1.0,
                        "fuel": "natural gas",
                        "id": "water-heating-1",
                        "uniformEnergyFactor": 0.82
                    }
                ]
            },
            "hvac": {
                "hvacHeatingSystems": [
                    {
                        "heatLoadFraction": 1.0,
                        "heatEfficiency": 0.8,
                        "fuel": "natural gas",
                        "systemType": "furnace",
                        "id": "heating-systems-1",
                        "heatEfficiencyUnits": "AFUE"
                    }
                ],
                "hvacCoolingSystems": [
                    {
                        "coolEfficiencyUnits": "SEER",
                        "coolLoadFraction": 1.0,
                        "coolEfficiency": 14.0,
                        "systemType": "central air conditioner",
                        "id": "cooling-systems-1"
                    }
                ]
            }
        },
        "enclosure": {
            "airInfiltration": {
                "rate": 2490,
                "rateUnit": "CFM"
            },
            "walls": [
                {
                    "assemblyEffectiveRValue": 5,
                    "id": "wall-insulation-1"
                }
            ],
            "foundations": [
                {
                    "type": "basement unconditioned",
                    "id": "floor-and-foundation-insulation-1"
                }
            ],
            "attics": [
                {
                    "floorAssemblyEffectiveRValue": 38,
                    "id": "attic-insulation-1"
                },
                {
                    "floorAssemblyEffectiveRValue": 13,
                    "id": "attic-insulation-2"
                }
            ]
        },
        "buildingSummary": {
            "conditionedFloorArea": 3300,
            "yearBuilt": 1974,
            "bedroomsCount": 5,
            "averageCeilingHeight": 8
        }
    },
    "addressComponents": {
        "zipCode": "64014-2332",
        "addressLine1": "1301 NE Hilltop Dr",
        "stateAbbreviation": "MO",
        "city": "Blue Springs"
    },
    "errors": [
        {
            "message": "[\"Warning: No dishwasher specified, the model will not include dishwasher energy use.\" \"Error: /tmp/modeling-api/dir2/NORMAL/20240328174140264418005/195656589_BASE.xml: Expected 1 element(s) for xpath: EnergyFactor | UniformEnergyFactor [context: /HPXML/Building/BuildingDetails/Systems/WaterHeating/WaterHeatingSystem[WaterHeaterType=\\\"storage water heater\\\"]]\"]",
            "code": "openstudio-creating-input-unsuccessful"
        }
    ]
}

[kellyatradiantlabs]

Hi @lukeduran - thank you for bringing this to our attention. We investigated this issue and identified the underlying bug. This will be resolved upon the release of our next major version (v2.0.0), which currently does not have a planned release date.

[lukeduran]

@kellyatradiantlabs, do you have an updated timeline for v.2.0.0 and when we might expect this?

[kellyatradiantlabs]

@lukeduran I just provided an update in slack today - we are aiming for a May 1 release date for v2.0.0. We're starting to build out the documentation of that release here: https://github.com/RadiantLabs/modeling-api-docs/milestone/1

[kellyatradiantlabs]

Due to some breaking changes in v2.0.0, the request in this ticket is not longer valid, but with some slight tweaks to align schemas, this bug is now resolved in our development environment. Note that in the waterHeatingSystems object, systemType is a required field and fields energyFactor and uniformEnergyFactor have been renamed to efficiency and efficiencyUnits.

                        "waterHeatingSystems": [
                            {
                                "fuel": "natural gas",
                                "dhwLoadFraction": 1.0,
                                "id": "water-heating-1",
                                "efficiency": 0.82,
                                "efficiencyUnits": "UEF",
                                "systemType": "storage water heater"
                            }