search

RadiantLabs / modeling-api-docs

Official Modeling API documentation
0 stars 1 forks source link

Inaccurate Property Use Type Errors #43

Open lukeduran opened 3 months ago

lukeduran commented 3 months ago

We are getting errors relating to the use type of the home which are not accurate.


    "request": {
        "headers": {
            "User-Agent": "python-requests/2.28.1",
            "Accept-Encoding": "gzip, deflate",
            "Accept": "*/*",
            "Connection": "keep-alive",
            "Content-Type": "application/json",
            "Authorization": "Bearer jqnTR0wR6nmnS6u5mLEm1NSXq1kHSaF16LYlInbQ8tC04QHa",
            "Content-Length": "1354"
        },
        "body": {
            "addressFull": "1055 Round Meadow Dr, Christiansburg, VA 24073-5812",
            "addressComponents": {
                "addressLine1": "1055 Round Meadow Dr",
                "city": "Christiansburg",
                "stateAbbreviation": "VA",
                "zipCode": "24073-5812"
            },
            "baseBuilding": {
                "enclosure": {
                    "airInfiltration": {
                        "rate": 1341,
                        "rateUnit": "CFM"
                    },
                    "attics": [
                        {
                            "floorAssemblyEffectiveRValue": 49,
                            "id": "attic-insulation-1"
                        }
                    ],
                    "foundations": [
                        {
                            "type": "crawl unvented",
                            "id": "floor-and-foundation-insulation-1"
                        }
                    ],
                    "walls": [
                        {
                            "assemblyEffectiveRValue": 15,
                            "id": "wall-insulation-1"
                        }
                    ]
                },
                "systems": {
                    "hvac": {
                        "hvacHeatPumps": [
                            {
                                "systemType": "mini-split",
                                "heatLoadFraction": 1.0,
                                "coolLoadFraction": 1.0,
                                "heatEfficiency": 7.8,
                                "coolEfficiency": 15.2,
                                "compressorType": "single stage",
                                "backupSystem": {},
                                "id": "heat-pump-systems-1"
                            }
                        ]
                    },
                    "waterHeating": {
                        "waterHeatingSystems": [
                            {
                                "fuel": "electricity",
                                "dhwLoadFraction": 1.0,
                                "id": "water-heating-1"
                            }
                        ]
                    }
                }
            },
            "globalControls": {
                "debug": true,
                "includeInputs": true,
                "includeBase": true,
                "includeTypical": true,
                "useFixture": false,
                "resolution": [
                    "annual",
                    "monthly"
                ],
                "timelineStartDate": "2024-02-27",
                "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": {
        "headers": {
            "Server": "nginx/1.24.0",
            "Date": "Tue, 27 Feb 2024 18:22:14 GMT",
            "Content-Type": "application/json;charset=utf-8",
            "Content-Length": "1469",
            "Connection": "keep-alive",
            "X-Request-Id": "01hqnwv40a01wt9p68148jm6y2",
            "Strict-Transport-Security": "max-age=31536000"
        },
        "body": {
            "globalControls": {
                "timelineStartDate": "2024-02-27",
                "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": "1055 Round Meadow Dr, Christiansburg, VA 24073-5812",
            "baseBuilding": {
                "systems": {
                    "waterHeating": {
                        "waterHeatingSystems": [
                            {
                                "dhwLoadFraction": 1.0,
                                "fuel": "electricity",
                                "id": "water-heating-1"
                            }
                        ]
                    },
                    "hvac": {
                        "hvacHeatPumps": [
                            {
                                "heatLoadFraction": 1.0,
                                "heatEfficiency": 7.8,
                                "backupSystem": {},
                                "coolLoadFraction": 1.0,
                                "coolEfficiency": 15.2,
                                "systemType": "mini-split",
                                "id": "heat-pump-systems-1",
                                "compressorType": "single stage"
                            }
                        ]
                    }
                },
                "enclosure": {
                    "airInfiltration": {
                        "rate": 1341,
                        "rateUnit": "CFM"
                    },
                    "walls": [
                        {
                            "assemblyEffectiveRValue": 15,
                            "id": "wall-insulation-1"
                        }
                    ],
                    "foundations": [
                        {
                            "type": "crawl unvented",
                            "id": "floor-and-foundation-insulation-1"
                        }
                    ],
                    "attics": [
                        {
                            "floorAssemblyEffectiveRValue": 49,
                            "id": "attic-insulation-1"
                        }
                    ]
                }
            },
            "addressComponents": {
                "zipCode": "24073-5812",
                "addressLine1": "1055 Round Meadow Dr",
                "stateAbbreviation": "VA",
                "city": "Christiansburg"
            },
            "errors": [
                {
                    "message": "The use type RESIDENTIAL - VACANT LAND of the address is not supported currently.",
                    "code": "property-use-of-land-not-supported",
                    "value": "1055 Round Meadow Dr, Christiansburg, VA 24073-5812"
                }
            ]
        }
    }
}```
kellyatradiantlabs commented 3 months ago

Hi @lukeduran - thanks for bringing this to our attention. The property use identified is what is currently contained in tax assessor data, which may be out of date. This case sounds like it may be new construction, where previously vacant land now has a new house on it! I've proposed and drafted a new propertyUse field to be added to our buildingSummary schema that will allow users to override the existing property use. It is documented in the PR linked to this ticket. Once it has been added to our modeling code base, we will close this ticket and merge the PR. @joshuamzm will provide updates on expected timing of implementation.

lukeduran commented 1 month ago

Hi @kellyatradiantlabs, will this be in v2?

kellyatradiantlabs commented 1 month ago

@lukeduran yes it will! I just added the tag and updated the draft changelog.

kellyatradiantlabs commented 2 weeks ago

A revised version of this request is passing in our v2.0.0 development environment. I added the propertyUse field to the request to indicate that it is single-family detached. Then, new error reporting indicated that conditionedFloorArea and yearBuilt are missing from our collected data sources for this address, so I included those in the new response too.

{
            "addressFull": "1055 Round Meadow Dr, Christiansburg, VA 24073-5812",
            "addressComponents": {
                "addressLine1": "1055 Round Meadow Dr",
                "city": "Christiansburg",
                "stateAbbreviation": "VA",
                "zipCode": "24073-5812"
            },
            "baseBuilding": {
                "buildingSummary": {
                    "propertyUse": "single-family detached",
                    "conditionedFloorArea": 2255,
                    "yearBuilt": 2023
                },
                "enclosure": {
                    "airInfiltration": {
                        "rate": 1341,
                        "rateUnit": "CFM"
                    },
                    "attics": [
                        {
                            "floorAssemblyEffectiveRValue": 49,
                            "id": "attic-insulation-1"
                        }
                    ],
                    "foundations": [
                        {
                            "type": "crawl unvented",
                            "id": "floor-and-foundation-insulation-1"
                        }
                    ],
                    "walls": [
                        {
                            "assemblyEffectiveRValue": 15,
                            "id": "wall-insulation-1"
                        }
                    ]
                },
                "systems": {
                    "hvac": {
                        "hvacHeatPumps": [
                            {
                                "systemType": "mini-split",
                                "heatLoadFraction": 1.0,
                                "coolLoadFraction": 1.0,
                                "heatEfficiency": 7.8,
                                "coolEfficiency": 15.2,
                                "compressorType": "single stage",
                                "backupSystem": {},
                                "id": "heat-pump-systems-1"
                            }
                        ]
                    },
                    "waterHeating": {
                        "waterHeatingSystems": [
                            {
                                "fuel": "electricity",
                                "dhwLoadFraction": 1.0,
                                "id": "water-heating-1",
                                "systemType": "storage water heater"
                            }
                        ]
                    }
                }
            },
            "globalControls": {
                "debug": true,
                "includeInputs": true,
                "includeBase": true,
                "includeTypical": true,
                "useFixture": false,
                "resolution": [
                    "annual",
                    "monthly"
                ],
                "timelineStartDate": "2024-02-27",
                "timelineDurationInYears": 1,
                "units": {
                    "energyStandard": "MBtu",
                    "coal": "metric ton",
                    "electricity": "MBtu",
                    "fuelOil": "MBtu",
                    "naturalGas": "MBtu",
                    "propane": "MBtu",
                    "woodCord": "MBtu",
                    "woodPellets": "MBtu",
                    "monetary": "USD",
                    "emissions": "CO2"
                }
            }
        }