v3.3.0 Changelog

v3.3.0

Released: 2024-07-24

characteristics

  • [characteristics] [feature] [ducts]

    Date: 2024-05-07

    Title: Updates duct effective R-values; allows duct shape inputs

    Description: Update to new OS-HPXML defaults for duct insulation; 25% rectangular supply ducts and 100% rectangular return ducts (previously 100% round supply/return ducts). Adds optional inputs (Ducts/DuctShape and Ducts/DuctFractionRectangular); defaults to 25% rectangular supply ducts and 100% rectangular return ducts (previously 100% round supply/return ducts).

    OpenStudio-HPXML: #1470, pull request 1691

    Assignees: Scott Horowitz

    References: pull request 1233

  • [characteristics] [feature] [ceiling fan] [plug loads]

    Date: 2024-04-02

    Title: Update Other, TV, and Ceiling Fan stochastic schedules

    Description: Update the stochastic schedule generator to produce updated other/TV plug load and ceiling fan schedules. generate TV schedules that follow the ATUS TV schedule fractions (distinct weekday/weekend) and multipliers (and not Other schedule fractions and multipliers). generate Other schedules that follow the new Other schedule fractions (still uses non-constant 2010 BAHSP monthly multipliers). generate Ceiling Fan schedules that follow the new Ceiling Fan schedule fractions (also update multipliers to not follow Other multipliers, but rather Ceiling Fan multipliers that are a function of weather).

    OpenStudio-HPXML: pull request 1634

    Assignees: Joe Robertson

    References: pull request 1220

  • [characteristics] [feature] [socio-demographics]

    Date: 2024-02-29

    Title: Add SMI, MSA, Metro Status

    Description: Add Metropolitan and Micropolitan Statistical Area tsv, County Metro Status tsv, and State Metro Median Income tsv. Added 3 new tsvs to support @SinounPhoung’s socio-demographically differentiated Stochastic Occupant Schedule integration into ResStock.

    resstock-estimation: pull request 400

    Assignees: Lixi Liu

    References: pull request 1212

  • [characteristics] [feature] [refrigerator]

    Date: 2024-02-23

    Title: ANSI 301-2022: load profile schedules

    Description: Refrigerator energy use is now affected by its ambient temperature using hourly constant and temperature coefficients from ANSI/RESNET/ICC 301-2022 Addendum C. Default fridge schedule is now an actuated EMS program. Daily schedule is a function of hour and space temperature.

    OpenStudio-HPXML: pull request 1572

    Assignees: Joe Robertson

    References: pull request 1209

  • [characteristics] [feature] [hot water fixtures]

    Date: 2024-02-21

    Title: Updating hot water fixtures multipliers based on field data.

    Description: Update hot water usage multipliers based on field data rather than engineering judgement. Update hot water usage multipliers. Using field data from 1700 water heaters in New England to come up with the distribution. Based on data collected as part of PERFORM with Michael Blonsky, who shared the distribution with us.

    resstock-estimation: #289, pull request 361

    Assignees: Jeff Maguire, Anthony Fontanini

    References: pull request 1210

  • [characteristics] [alaska] [bugfix]

    Date: 2024-03-18

    Title: Integrate ARIS data

    Description: Update the Alaska residential stock characterization using the Alaska Retrofit Information System data. Update housing characteristics for Alaska using ARIS dataset. Explicitly model wood heating for the national.

    resstock-estimation: pull request 381

    Assignees: Rajendra Adhikari, Anthony Fontanini

    References: pull request 1214

  • [characteristics] [bugfix] [water heater]

    Date: 2024-02-28

    Title: Update water heater location

    Description: Move location of out-of-unit (shared) water heaters to conditioned mechanical room. Move out-of-unit water heaters (i.e., Water Heater In Unit=No from Location=None to Location=Conditioned Mechanical Room (corresponds to OS-HPXML location: “other heated space”).

    Assignees: Lixi Liu, Jeff Maguire, Anthony Fontanini

    References: pull request 1201

  • [characteristics] [bugfix] [data sources]

    Date: 2024-01-26

    Title: Update characteristics using 2020 RECS v7 data

    Description: Update to RECS 2020 V7 data files. Updates RECS 2020 data from v5 to v7. There are some new EV variables to be leveraged by the ResStock/TEMPO project.

    resstock-estimation: pull request 394

    Assignees: Anthony Fontanini

    References: pull request 1199

  • [characteristics]

    Date: 2024-06-17

    Title: Update threshold for weekday occupancy

    Description: RECS tsv_maker previously assumed that if people are home even for 1 day during the week, they are home every day of the week. This resulted in people being less away (and hence fewer day time setbacks). This PR updates the threshold for weekday occupancy to be 3 days. This makes the weekday occupancy more in line with RECS.

    Assignees: Rajendra Adhikari

    References: pull request 1260

documentation

  • [documentation] [feature] [changelog]

    Date: 2024-06-12

    Title: RTD: detailed changelog

    Description: Adopt changelog approach from buildstockbatch.

    Assignees: Joe Robertson

    References: pull request 1244

  • [documentation] [feature] [options_lookup]

    Date: 2024-06-04

    Title: Adding options and option arguments to Read the Docs

    Description: Adding to the read the docs documentation by articulating the options in project national and the arguments specified. One can now look at the descriptions of the arguments and documentation linked to OS-HPXML and see what arguments are currently being used in the baseline stock. The updates combines two files automatically: “options_lookup.tsv” and the “project_national/resuources/options_saturations.csv”.

    Assignees: Anthony Fontanini

    References: pull request 1249

workflow

  • [workflow] [feature] [mechanics]

    Date: 2024-07-20

    Title: Specify upgrade_names for run_analysis.rb

    Description: Introduce a new optional upgrade_name argument (can be called multiple times) to run_analysis.rb.

    Assignees: Joe Robertson

    References: pull request 1275

  • [workflow] [feature] [utility bills]

    Date: 2024-07-19

    Title: Latest OS-HPXML, v1.8.1

    Description: Add new project yml file arguments for reporting/controlling annual/monthly utility bill outputs.

    Assignees: Joe Robertson

    References: pull request 1246

  • [workflow] [feature] [plug loads]

    Date: 2024-05-21

    Title: Split out Other and TV plug loads

    Description: Split out TV plug loads (calculated using an equation based on ANSI/RESNET/ICC 301) from other plug loads (calculated using updated regression equations based on RECS2020). For TV, we are now using OS-HPXML defaults (i.e., TV = 413.0 + 69.0 * NumberofBedrooms based on ANSI/RESNET/ICC 301-2019, where NumberofBedrooms is adjusted based on NumberofResidents). Create a new sources/recs/recs2020/plug_loads/mel_ann.py script.

    resstock-estimation: pull request 401

    Assignees: Joe Robertson, Anthony Fontanini

    References: #1206, pull request 1213

  • [workflow] [feature] [mechanics]

    Date: 2024-05-16

    Title: Run run_analysis in parallel

    Description: Introduce a new optional buildstock_csv_path argument that supports parallel resstock runs using run_analysis.rb. I know this is an odd workflow, but I’d like to call resstock in parallel, to run multiple models (baseline only) built each with a precomputed buildstock.csv.

    Assignees: Julien Marrec

    References: #1130, pull request 1230

  • [workflow] [feature] [reporting]

    Date: 2024-05-16

    Title: Latest OS-HPXML

    Description: Improves heating/cooling component loads; for timesteps where there is no heating/cooling load, assigns heat transfer to heating or cooling by comparing indoor temperature to the average of heating/cooling setpoints.

    Assignees: Andrew Speake

    References: pull request 1240

  • [workflow] [feature] [reporting]

    Date: 2024-05-16

    Title: Latest OS-HPXML

    Description: Additional geothermal loop default simulation outputs (number/length of boreholes). Adds geothermal loop outputs (number/length of boreholes) to annual results output file.

    OpenStudio-HPXML: #1657

    Assignees: Scott Horowitz

    References: pull request 1240

  • [workflow] [feature] [infiltration]

    Date: 2024-05-16

    Title: Latest OS-HPXML

    Description: Updates default ShieldingofHome to be “well-shielded” (from “normal”) for single-family attached and multifamily dwelling units. Updates default ShieldingofHome to be “well-shielded” for single-family attached and multifamily dwelling units.

    Assignees: Scott Horowitz

    References: pull request 1240

  • [workflow] [feature] [hvac]

    Date: 2024-05-07

    Title: HVAC Autosizing Limits

    Description: Sizing control option to specify max allowed airflow. The PR aims to allow specifying upper limits for autosized capacities.

    OpenStudio-HPXML: #1530, #1556, pull request 1584

    Assignees: Joe Robertson

    References: pull request 1233

  • [workflow] [feature] [hvac]

    Date: 2024-04-09

    Title: HVAC Autosizing Factors

    Description: Enable HVAC airflow and capacity scaling factors to oversize or undersize the equipment. Manually create new tsv files for assigning autosizing factor arguments introduced by NREL/OpenStudio-HPXML#1611.

    resstock-estimation: pull request 406

    OpenStudio-HPXML: #1561

    Assignees: Joe Robertson

    References: pull request 1218

  • [workflow] [feature] [weather]

    Date: 2024-03-11

    Title: Allow building site inputs

    Description: Allow building site inputs; this is particularly useful when the building is located far from, or at a very different elevation than, the EPW weather station. When not provided, defaults to using EPW header values (as before).

    OpenStudio-HPXML: pull request 1636

    Assignees: Scott Horowitz

    References: pull request 1215

  • [workflow] [feature] [unavailable periods]

    Date: 2024-02-23

    Title: BuildResidentialHPXML: multiple vacancy/outage periods

    Description: Allow definition of multiple unavailable periods (i.e., vacancy, power outage). Update schedules_vacancy_period and schedules_power_outage_period arguments to support multiple periods (comma-separated?).

    OpenStudio-HPXML: #1618, pull request 1622

    Assignees: Joe Robertson

    References: pull request 1209

  • [workflow] [feature] [heat pump backup]

    Date: 2024-02-23

    Title: HP backup sizing methodology

    Description: Add ability to set either an “emergency” or “supplemental” heat pump backup sizing methodology. Adds a HeatPumpBackupSizingMethodology element with choices of ‘emergency’ and ‘supplemental’. Defaults to ‘emergency’, so results do not change by default.

    OpenStudio-HPXML: #1322, pull request 1597

    Assignees: Scott Horowitz

    References: pull request 1209

  • [workflow] [feature] [general water use]

    Date: 2024-02-23

    Title: ANSI 301-2022: load profile schedules

    Description: Various schedule fractions/multipliers updates (e.g., appliances, lighting, fixtures, occupancy, ceiling fan).

    OpenStudio-HPXML: pull request 1572

    Assignees: Joe Robertson

    References: pull request 1209

  • [workflow] [feature] [ceiling fan]

    Date: 2024-02-23

    Title: ANSI 301-2022: load profile schedules

    Description: For ceiling fans, add a LabelEnergyUse (W) input as an alternative to Efficiency (cfm/W).

    OpenStudio-HPXML: pull request 1609

    Assignees: Joe Robertson

    References: pull request 1209

  • [workflow] [feature] [whole building]

    Date: 2024-01-30

    Title: Whole MF building models: Replace building_id=ALL argument with an HPXML element

    Description: Add optional switch to BuildExistingModel (defaulted to false) for modeling whole SFA/MF buildings. Replaces building_id=ALL argument with an element in the HPXML file, which allows us to perform validation specific to whole MF building simulations.

    OpenStudio-HPXML: pull request 1594

    Assignees: Joe Robertson, Scott Horowitz

    References: pull request 1200

  • [workflow] [feature] [emissions]

    Date: 2024-01-19

    Title: 2022 Cambium: add 25 year levelization scenarios

    Description: Include additional 2022 Cambium 25-year LRMER emissions data. Add 10 new “LRMER_xxx_25” data folders to resources/data/cambium/2022.

    Assignees: Joe Robertson

    References: pull request 1194

  • [workflow] [feature] [radiant barrier]

    Date: 2024-01-17

    Title: Adding flexibility to specify location of the radiant barrier

    Description: Add flexibility to specify location of the radiant barrier. Allowing Radiant Barrier for Attic Floor.

    OpenStudio-HPXML: #1435, pull request 1473

    Assignees: Prateek Shrestha

    References: pull request 1188

  • [workflow] [feature] [hvac]

    Date: 2024-01-17

    Title: Allow autosizing with detailed performance data inputs for var speed systems BuildResidentialHPXML: detailed performance data arguments

    Description: Add ability to describe detailed performance data for variable-speed air-source HVAC systems. Updated assumptions for variable-speed air conditioners, heat pumps, and mini-splits. Also allows detailed heating and cooling performance data (min/max COPs and capacities at different outdoor temperatures) as an optional set of inputs. Data can be sourced from e.g. NEEP’s Cold Climate Air Source Heat Pump List. Add detailed performance data arguments for air-source, variable-speed HVAC systems.

    OpenStudio-HPXML: pull request 1583, pull request 1317, pull request 1558

    Assignees: Yueyue Zhou, Scott Horowitz, Joe Robertson

    References: pull request 1188, pull request 1200

  • [workflow] [changed] [utility bills]

    Date: 2024-07-19

    Title: Latest OS-HPXML, v1.8.1

    Description: Updates default fuel prices to use 2022 EIA State Energy Data System (SEDS) instead of state-averages.

    Assignees: Joe Robertson

    References: pull request 1246

  • [workflow] [bugfix] [refactor]

    Date: 2024-07-22

    Title: ServerDirectoryCleanup: catch *schedules.csv, refactor

    Description: Remove duplicate measure code. Catch *schedules.csv since OS-HPXML generates in.schedules.csv. Remove “retain_in_idf: false” from national project yml files; appears that even if you delete in.idf from ServerDirectoryCleanup, the file is still subsequently exported (by the openstudio workflow?).

    Assignees: Joe Robertson

    References: pull request 1277

  • [workflow] [bugfix] [temperature capacitance multiplier]

    Date: 2024-07-19

    Title: Latest OS-HPXML, v1.8.1

    Description: Update to use the new temperature capacitance multiplier of 7.0 after some resilience application investigation.

    Assignees: Joe Robertson

    References: pull request 1246

  • [workflow] [bugfix] [refactor]

    Date: 2024-07-19

    Title: Convert UpgradeCosts measure to ModelMeasure

    Description: UpgradeCosts does not need to be a reporting measure; it doesn’t actually report any simulation output. ReportHPXMLOutput does not need to be its own measure; it can be pulled into UpgradeCosts.

    If UpgradeCosts becomes a model measure, it gets applied before simulation time and therefore its registered values would show up in the results.csv when using the measures_only flag.

    This also fixes a bug related to using the measure_only flag. When using measure_only, the results.json file is not produced. Therefore, no registered values would show up in the results csv. Now we use data_point_out.json, which is produced when using measures_only.

    Update buildstock.rb and sample yml files with workflow generator version tag. This enables us to point to buildstockbatch’s develop branch for CI tests.

    buildstockbatch: pull request 458

    Assignees: Joe Robertson

    References: pull request 1253

  • [workflow] [refactor]

    Date: 2024-07-15

    Title: ResStockArguments: convert args to double, integer

    Description: Avoids a bug that would be introduced by making air_leakage_value optional in https://github.com/NREL/OpenStudio-HPXML/pull/1760. Per suggestion by @shorowit, create a method for automatically converting ResStockArguments argument data types based on original argument type.

    Assignees: Joe Robertson

    References: pull request 1269

  • [workflow] [bugfix] [geometry]

    Date: 2024-06-21

    Title: Reduce garage protrusion slightly for 0-499 Geometry Floor Area

    Description: For the “0-499” Geometry Floor Area option, change the garage protrusion from 0.75 to 0.72. This avoids the “Garage is as wide as the single-family detached unit.” error.

    Assignees: Joe Robertson

    References: pull request 1258

  • [workflow] [bugfix] [hvac]

    Date: 2024-03-11

    Title: HVAC Autosizing Factors

    Description: Add ability to specify HVAC system autosizing factors for baseline buildings; autosizing factors are retained for upgrade buildings following the same approach for HVAC system capacities. Allows optional HeatingAutosizingFactor, CoolingAutosizingFactor, BackupHeatingAutosizingFactor inputs to scale HVAC equipment autosizing results.

    OpenStudio-HPXML: #1561, pull request 1611

    Assignees: Joe Robertson, Yueyue Zhou

    References: pull request 1215

  • [workflow] [bugfix] [mechanics]

    Date: 2024-01-22

    Title: Reorganize emissions and utility bills data folders

    Description: Reorganize the emissions and utility rates data folders such that their sources and functions are more clear. Previously, it wasn’t clear that the provided utility rate data was for demonstration purposes only.

    Assignees: Joe Robertson

    References: pull request 1195

  • [workflow] [bugfix] [water heater]

    Date: 2024-01-12

    Title: Remove old HPWH options from options_lookup

    Description: Remove old HPWH options from options_lookup. Removing the old HPWH options from options_lookup.tsv.

    Assignees: Jeff Maguire

    References: #1184, pull request 1190

software

  • [software] [feature] [openstudio]

    Date: 2024-05-09

    Title: OpenStudio 3.8/EnergyPlus 24.1

    Description: Update to OpenStudio v3.8.0.

    OpenStudio-HPXML: pull request 1630

    Assignees: Joe Robertson, Scott Horowitz

    References: pull request 1225