Features
- Include battery modeling capabilities for project_testing (#1009)
- Ability to check buildstock csv against an options lookup as a command line utility (#1042)
- Demonstrate new power outage modeling feature using upgrades specified in example project yml files (#1054)
- Ability to specify a "sample_weight" column in the precomputed buildstock.csv (#1056)
- Add descriptions to the housing characteristics (#1069)
Fixes
- Pulls in upstream OS-HPXML fix related to avoiding possible OpenStudio temporary directory collision causing random errors (#1054)
February 3, 2023 - Diff
Features
- Transition to using the HPXML-based workflow (#443)
- Add a new "Floor Area, Foundation (ft^2)" cost multiplier (#870)
- Add a new "Floor Area, Attic * Insulation Increase (ft^2 * Delta R-value)" cost multiplier for handling incremental costs of adding attic insulation (#842)
- Allow air leakage % reduction upgrades (e.g., 25%), and add a new "Floor Area, Conditioned * Infiltration Reduction (ft^2 * Delta ACH50)" cost multiplier for handling incremental costs of such upgrades (#840)
- For the testing project, sample equal distributions of (1) smooth and stochastic schedules (each 50%) and (2) faulted and non-faulted HVAC systems (each 50%) (#828)
- Allow upgrade options to be defined in the lookup using measures other than ResStockArguments (#839)
- Enable rim joists for homes with basements/crawlspaces; assumes a height of 9.25 inches and calculates rim joist assembly R-value from new insulation arguments (#831)
- Enable the HEScore workflow to be run with BuildExistingModel (#782)
- Cities with more than 15,000 dwelling units are added as a geographic characteristic (#874)
- Update tsvs with new sampling_probability calculation (#905)
- Improve distributions of heat pumps in the southeast U.S. by spliting IECC zone 2A into two zones: 2A (FL, GA, AL, MS) and 2A (TX, LA) (#913)
- Add Income and Tenure tsv, update PUMS tsvs from 2017 5-yrs to 2019 5-yrs, update dependencies and fix encoding error in Occupants.tsv (#900)
- Add Income and Tenure into Geometry Floor Area (#949)
- Add distributions for partial space cooling (#964)
- Add ability to calculate emissions for various scenarios (#791)
- Add ability to calculate simple utility bills for various scenarios (#984)
- Modeled floor area based on AHS 2021 and AHS 2019 (#978)
- Add area median income (#1004)
- Update to OpenStudio v3.5.1 (#1006)
Fixes
- Clean up option names for natural ventilation and hot water distribution (#828)
- Remove the zero degree switchover temperature for heat pump backup heating (#833)
- For homes with a finished attic or cathedral ceilings, models a conditioned attic instead of a vented attic (#830)
- Reduce housing characteristic file size by relaxing the six digit float format in the housing characteristics (#877)
- Fix minor bug in sampling probability calculation (#934)
- Rename sources subfolders so all tsv_makers can be imported as packages (#959)
- Fix heating and cooling auto-season inputs (#975)
- Remove Void from dependency columns in TSVs and update tests.(#981)
- Update low-sample downscaling logic to use raw source_weight, which leads to minor changes to Geometry Floor Area and HVAC Partial Sapce Conditioning (#982)
February 9, 2022 - Diff
Features
- Update to OpenStudio v3.3.0 (#604)
- Model multifamily and single-family attached buildings as individual dwelling units instead of multiple units representing a building (#439)
- Reduce vacant unit heating setpoints to 55ºF (#541)
- Introduce a CEC Building Climate Zone tag for samples in California (#548)
- Increase LED saturation to approximately 2019 levels (#545)
- Introduce GEB capabilities for water heaters, including the ability to schedule setpoint and HPWH operating mode (#483)
- Introduce different cooling setpoint distributions for window ACs (#551)
- Include electric zonal heating equipment as a dependency in heating setpoint-related tsvs (#549)
- Geo-temporal shifting of the stochastic load model schedules using the American Time Use Survey (#550)
- Switch data source for
Geometry Wall Type.tsvfrom RECS 2009 to Homeland Infrastructure Foundation-Level Data (HIFLD) Parcel data (#561) - Use Schedule:File with well pump / vehicle plug loads, as well as gas grill / fireplace / lighting fuel loads. This enables the optional vacancy period to apply to these end uses (#566)
- Update example project yaml files to use buildstockbatch input schema version 0.3 (#583)
- Update default daylight saving start and end dates to March 12 and November 5, respectively (#585)
- Switches room air conditioner model to use Cutler performance curves (#586)
- Remove 3 story limit for multi-family buildings, and instead use RECS data to allow for buildings up to 21 stories (#558)
- Add a sampling probability column in the housing characteristics to define the probability a given column will be sampled (#584)
- Add ReEDS balancing areas as a spatial field (#591)
- Changes heat pump defrost control from OnDemand to Timed (#605)
- Update number of bathrooms assumption to match the Building America House Simulation Protocols (#601)
- Speed up sampling algorithm by multiple orders of magnitude for large numbers of samples (#606)
- Use ANSI/RESNET/ICC 301 equations to calculate annual interior, exterior, and garage lighting energy (#619)
- Update tsv files for both the national and testing projects. Supports transition to ResStock-HPXML (#559)
- Changes "Duct Surface Area (ft^2)" cost multiplier to "Duct Unconditioned Surface Area (ft^2)" (#634)
- Update window type distributions using RECS 2015. Includes additional of frame material types (RECS 2015) and presence of storm windows (D&R International) (#615)
- Reduces window interior shading during Winter to match ANSI/RESNET/ICC 301 assumption (#649)
- Updates ceiling fan model based on ANSI/RESNET ICC 301 assumptions (#652)
- Updates infiltration model pressure coefficient (#670)
- Updates mechanical ventilation options/model to ASHRAE 62.2-2019 and adds a "Flow Rate, Mechanical Ventilation (cfm)" output (#675)
- Add PV ownership and PV system size distributions using 2019 Tracking the Sun and GTM report on solar installation. (#673)
- Add optional argument to ResidentialLocation measure for setting the IECC climate zone (#755)
- Add Geometry Story Bin tsv and Geometry Story Bin dependency to Geometry Wall Type. (#759)
- Add arguments to the ServerDirectoryCleanup measure for controlling deletion of files in the run folder. (#661, #818)
Fixes
- Fixes significant runtime bottleneck in TSV fetching in BuildExistingModel & ApplyUpgrade measures (#543)
- Dwelling units that are 0-499 ft2 are limited to a maximum of 2 bedrooms (#553)
- Reverses the material layers of the unfinished attic floor construction so that they are correctly ordered outside-to-inside (#556)
- Fixes invalid garage and living space dimension errors (#560)
- Set all mini-split heat pump supplemental capacity to autosize (#564)
- Reduce stochastic schedule generation runtime by over 50% (#571, #577)
- Fixes the problem that
Heating Type=Voidis showing up in buildstock samples (#568) - Set AZ counties to NA daylight saving times instead of some AR counties (#585)
- Housing characteristics fixes based on more samples in testing (#592)
- Fixes window-to-wall ratio calculation for facades with doors (#597)
- Fixes number of bathrooms for single-family attached and multi-family buildings (#601)
- Sync the sample probabilities after a bug fix in tsv_dist (#609)
- Fix name of ReEDS balancing areas (#613)
- Fixes hot water distribution internal gains not being zeroed out during vacancies (#653)
- Exclude adiabatic doors when outputting the door area cost multiplier (#674)
- Disaggregate the shared fan coil's fan energy use into heating and cooling (#694)
- Fixes hours setpoint not met output to exclude A) no heating and/or cooling equipment and B) finished basements (#700)
- Revert wall type constraint that assumes all brick facades built >1960 are wood-framed with 4" face brick. Also add constraint to force all buildings > 8 stories to have steel-framed wall type (#759)
- Fixes for wall constructions: remove wood sheathing on CMU and brick walls; better data for exterior finish absorptances and wall densities (#789)
- Fixes unit conversion bugs in solar hot water model (#809)
- Update the number of units represented in the national project YAML files to the American Community Survey 2019 5-year estimate (#821)
- Properly apply roof insulation when the attic type is Finished Attic or Cathedral Ceilings (#817)
January 27, 2021 - Diff
Features
- Report the annual peak use and timing using the quantities of interest measure (#458)
- Major change to most occupant-related schedules. Occupant activities are now generated on-the-fly and saved to .csv files used by Schedule:File objects. Schedules are generated using time-inhomogenous Markov chains derived from American Time Use Survey data, supplemented with sampling duration and power level from NEEA RBSA data, as well as DHW draw duration and flow rate data from Aquacraft/AWWA data (see pre-print for details) (#348)
- Update the dependencies for heating and cooling setpoint tsvs (Setpoint, Has Offset, Offset Magnitude, and Offset Period) to IECC climate zone (#468)
- Distinguish between vacant and occupied dwelling units using PUMS data (#473)
- Update heating fuel distributions to be by Public Use Microdata Area (PUMA) rather than State (#474)
- Restructure HVAC housing characteristics to 1) simplify the structure, 2) allow for integrating more local data sources, 3) update reference years for HVAC and refrigerator ages and efficiencies from 2009 to 2018, 4) add assumption comments to all HVAC-related housing characteristics, 5) improve Room AC efficiency distributions using ENERGY STAR saturation data, and 6) fix some incorrect assignment of Option=None heating systems (#478)
- Increase roofing material options; update roofing material tsv files to include these new options (#485)
- Update foundation type from the Building Foundation Design Handbook published in 1988 to RECS 2009 (#492)
- Synchronize weather between ResStock and ComStock which increases the number of weather stations from 215 to 941 (#507)
- Update Occupants per unit from RECS 2015 to PUMS 5-yr 2017 (#509)
- Based on RECS 2015, separate the plug load equations for single-family detached, single-family attached, and multifamily buildings (#471)
- Allow for plug load energy consumption to vary by Census Division and include additional "diversity" multiplier in plug load equations (#511)
- Lighting saturations based on RECS 2015 with new building type and spatial dependencies (#510)
- Introduce premium water heaters and heat pump water heaters into building stock, differentiate between central and in-unit water heating, and split water heater fuel and efficiency into different housing characteristics (#513)
- Separate heat pump electric supplemental heating from total electric heating in output reporting (#512)
- Update the duct leakage "total" to "to outside" conversion to be based on ASHRAE Standard 152 (#532)
- Allow for flexible weather regions based on weather data available and introduce TMY3 weather files for the new weather format (#525)
Fixes
- Fix for pseudo-random number generator that was generating non-deterministic occupancy schedules (#477)
- Iterate all spaces in a thermal zone when checking for zone type; fixes missing infiltration for protruding garages in 1-story homes (#480)
- Update spatial distribution of units based on total dwelling unit counts rather than occupied unit counts (#486)
- Exclude existing shared walls when calculating the partition wall area of MF and SFA buildings (#496)
- For the purpose of calculating cooling and dehumidification loads for HVAC sizing, use simple internal gains equation from ANSI/RESNET/ICC 301 (consistent with HPXML workflow); this fixes a bug introduced in #348 that caused cooling capacities to be ~3x larger than they should be (#501)
- Reintroduce IECC climate zone dependency to HVAC Cooling Type and some heat pump fixes (#497)
- Reintroduce monthly multipliers with stochastic load model for dishwasher, clothes washer and clothes dryer and cooking (#504)
- Account for collapsed units when determining geometry variables (building floor/wall area and volume) in infiltration calculations; add airflow unit tests (#518)
- Fix for calculating door and below-grade wall area of multifamily and single-family attached buildings with collapsed geometries (#523)
- In the Corridor.tsv, assign single-family attached, single-family detached, and mobile homes with a "Not Applicable" option (#502)
- Remove ceiling fan energy for vacant units (#527)
- Fix bug related to incorrect timestamps when using AMY weather file (#528)
- Fix DST start hour error and end date error (#530)
- Calculate slab surface effective R values used in HVAC sizing with unit-level variables (#537)
June 24, 2020 - Diff
Features
- Remove the single-family detached project, and remove PAT from the testing and multifamily projects (#402)
- Relocate the data folder, along with tsv makers, to a separate private repository (#401)
- Update the single-family detached and multifamily projects with more up-to-date lighting stock distributions (#392)
- Update Insulation Finished Attic tsv with more options for insulation levels (#395)
- Add ability to ignore comment lines with the "#" symbol (#408)
- Update occupant and plug loads equations based on RECS 2015 data; replace floor area with occupants as independent variable in plug loads equation; allow modeling of zero-bedroom units (e.g., studios) (#324)
- New geospatial characteristics have been added or updated. New geospatial characteristics are as follows: ASHRAE IECC Climate Zone 2004, State, County, PUMA, Census Division, Census Region, Building America Climate Zone, and ISO/RTO Region. The top level housing characteristic is now ASHRAE IECC Climate Zone 2004. Now using data from the American Community Survey Public Use Microdata Sample (ACS PUMS) for Building Type, Vintage, and Heating Fuel (#416)
- Update HVAC System Cooling tsv with air-conditioning saturations ("None", "Room AC", or "Central AC") from American Housing Survey for Custom Region 04. Efficiency probabilities remain based on RECS 2009 (#418)
- Diversify the timing heating and cooling setpoint setbacks (#414)
- Reduce the number of appliances in multifamily units. Adding RECS building type as a dependencies to clothes washers, clothes dryers, dishwashers, refrigerators, extra refrigerators, and stand-alone freezers. Update refrigeration levels based on RECS 2009 age and shipment-weighted efficiency by year. Now using the American Housing Survey (AHS) for clothes washer and clothes dryer saturations. New geographic field, AHS Region, which uses the top 15 largest Core Based Statistical Areas (CBSAs) and Non-CBSA Census Divisions. (420)
- Exterior lighting schedule changed from using interior lighting sunrise/sunset algorithm to T24 2016 Residential ACM Appendix C Table 8 Exterior Lighting Hourly Multiplier for weekdays and weekends (#419)
- Increase the diversity of the floor areas that are simulated. Geometry House Size has been replaced by Geometry Floor Area Bin and Geometry Floor Area. Now using AHS for specifying the floor area. Floor areas differ by non-Core Based Statistical Areas (CBSAs) Census Divisions and the top 15 largest CBSAs (#425)
- Increase the diversity of the infiltration simulated. Now using the Residential Diagnostics Database for the Infiltration housing characteristic (#427)
- Allow a key value to be specified when outputting timeseries variables (#438)
Fixes
- Rename "project_multifamily_beta" to "project_national" (#459)
- Add mini-split heat pump pan heater to custom meter for heating electricity (#454)
- Assign daylight saving start/end dates based on county and not epw region (#453)
- Update ceiling fan tsv to remove the "National Average" option, and instead sample 28% "None" and 72% "Standard Efficiency" (#445)
- Remove Location Weather Filename and Location Weather Year tsvs, and update options lookup to reflect updated weather file changes; weather filenames are now required to match what is in the options lookup (#432)
- Fix bug in QOI reporting measure where absence of any heating/cooling/overlap seasons would cause errors (#433)
- Restructure unfinished attic and finished roof -related tsv files (i.e., insulation, roof material, and radiant barrier) and options (#426)
- Exclude net site energy consumption from annual and timeseries simulation output ("total" now reflects net of pv); change
include_enduse_subcategoriesargument default to "true"; report either total interior equipment OR each of its components (#405) - Refactor the tsv maker classes to accommodate more data sources (#392)
- Allow a building to be simulated with no water heater; map the "Other Fuel" option from the Water Heater tsv to no water heater (#375)
- Revert plug load schedule to RBSA for the National Average option (#355)
- Removed the "Geometry Unit Stories SF" and "Geometry Unit Stories MF" housing characteristics. Unit stories are instead represented by the "Geometry Stories" housing characteristic (#416)
- Diversify window to wall ratio variation using the Residential Building Stock Assessment (RBSA) II data (#412)
- Fix bug in assigning small window areas to surfaces (#452)
September 24, 2020 - Diff
Fixes
- Update the weather zip file url in each PAT project to point to a different location at data.nrel.gov (#489)
April 28, 2020 - Diff
Fixes
- Fix bug in options lookup where buildings without heating systems were not being assigned the required "has_hvac_flue" airflow measure argument (#442)
March 9, 2020 - Diff
Fixes
- Update the weather zip file url in each PAT project to point to data.nrel.gov (#422)
February 19, 2020 - Diff
Fixes
- Update the datapoint initialization script to download weather files to a common zip filename (#406)
February 7, 2020 - Diff
Features
- Update the multifamily project with a Geometry Wall Type tsv file for sampling between wood stud and masonry walls (#382)
Fixes
- Add generation of the Geometry Wall Type tsv file for the single-family detached project to the 2009 RECS tsv maker; this corrects the tsv file (#387)
- Add generation of the Misc Pool tsv file (with Geometry Building Type and Location Region dependencies) to the 2009 RECS tsv maker; this also corrects having pool pumps for all homes (#387)
- Refactor the RECS tsv makers for years 2009 and 2015 (#382)
January 30, 2020 - Diff
Features
- The results csv now optionally reports annual totals for all end use subcategories, including appliances, plug loads, etc. (#371)
- Split out national average options so not all homes have all miscellaneous equipment, and add none options to appliances (#362)
- Update the single-family detached project with a Geometry Wall Type tsv file for sampling between wood stud and masonry walls (#357)
- Made housing characteristics a consistent format. Added integrity check to ensure housing characteristics follow the guildelines specified in read-the-docs (#353)
- Include additional "daylight saving time" and "utc time" columns to timeseries csv file to account for one hour forward and backward time shifts (#346)
- Update bedrooms and occupants tsv files with options and probability distributions based on RECS 2015 data (#340)
- Add new QOIReport measure for reporting seasonal quantities of interest for uncertainty quantification (#334)
- Separate tsv files for bedrooms, cooking range schedule, corridor, holiday lighting, interior/other lighting use, pool schedule, plug loads schedule, and refrigeration schedule (#338)
Fixes
- Allow Wood Stove option as an upgrade, and account for wood heating energy in simulation output (#372)
- Custom meters for ceiling fan, hot water recirc pump, and vehicle end use subcategories were not properly implemented (#371)
- Some re-labeling of tsv files, such as "Geometry Building Type" to "Geometry Building Type RECS" and "Geometry Building Type FPL" to "Geometry Building Type ACS" (#356)
- Removes option "Auto" from parameter "Occupants" in the options lookup file (#360)
- Update the multifamily project's neighbors and orientation tsv files to have geometry building type dependency; remove the now obsolete "Geometry Is Multifamily Low Rise.tsv" file (#350)
- Update each PAT project's AMI selection to "2.9.0" (#346)
- Fixes for custom output meters: total site electricity double-counting exterior holiday lighting, and garage lighting all zeroes (#349)
- Remove shared facades tsv files from the multifamily_beta and testing projects (#301)
- Move redundant output meter code from individual reporting measures out into shared resource file (#334)
- Fix for the power outages measure where the last hour of the day was not getting the new schedule applied (#238)
November 5, 2019 - Diff
Features
- Update to OpenStudio v2.9.0 (#322)
- Unit tests and performance improvements for integrity checks (#228, #237, #239)
- Register climate zones (BA and IECC) based on the simulation EPW file (#245)
- Split ResidentialLighting into separate ResidentialLightingInterior and ResidentialLightingOther (with optional exterior holiday lighting) measures (#244, #252)
- Additional example workflow osw files using TMY/AMY2012/AMY2014 weather for use in regression testing (#259, #261)
- Update all projects with new heating/cooling setpoint, offset, and magnitude distributions (#272)
- Add new ResidentialDemandResponse measure that allows for 8760 DR schedules to be applied to heating/cooling schedules (#276)
- Additional options for HVAC, dehumidifier, clothes washer, misc loads, infiltration, etc. (#264, #278, #292)
- Add EV options and update ResidentialMiscLargeUncommonLoads measure with new electric vehicle argument (#282)
- Update ResidentialSimulationControls measure to include a calendar year argument for controlling the simulation start day of week (#287)
- Increase number of possible upgrade options from 10 to 25 (#273, #293)
- Additional "max-tech" options for slab, wall, refrigerator, dishwasher, clothes washer, and lighting (#296)
- Add references to ResStock trademark in both the license and readme files (#302)
- Report all cost multipliers in the SimulationOutputReport measure (#304)
- Add options for low flow fixtures (#305)
- Add argument to BuildExistingModel measure that allows the user to ignore measures (#310)
- Create example project yaml files for use with buildstockbatch (#291, #314)
- Create a pull request template to facilitate development (#317)
- Update documentation to clarify downselect logic parameters (#321)
- Additional options for EnergyStar clothes washer, clothes dryer, dishwasher (#329, #333)
Fixes
- Bugfix for assuming that all simulations are exactly 365 days (#255)
- Bugfix for heating coil defrost strategy (#258)
- Various HVAC-related fixes for buildings with central systems (#263)
- Update testing project to sweep through more options (#280)
- Updates, edits, and clarification to the documentation (#270, #274, #285)
- Skip any reporting measure output requests for datapoints that have been registered as invalid (#286)
- Bugfix for when bedrooms are specified for each unit but bathrooms are not (#295)
- Ensure that autosizing does not draw the whole tank volume in one minute for solar hot water storage tank (#307)
- Remove invalid characters from option names for consistency with buildstockbatch (#308)
- Bugfix for ducts occasionally getting placed in the garage attic instead of only unfinished attic (#309)
- Able to get past runner values of any type, and not just as string (#312)
- Log the error message along with the backtrace when an applied measure fails (#315)
- Add tests to ensure that the Run Measure argument is correctly defined in all Apply Upgrade measures for all projects (#320)
- Bugfix when specifying numbers of bedrooms to building units (#330)
- Enforce rubocop as CI test so code with offenses cannot be merged (#331)
- Bugfix for some clothes washer, dishwasher options causing increased energy consumption (#329, #333)
April 17, 2019 - Diff
Features
- Update to OpenStudio v2.8.0 (#151)
- Add a multifamily project which includes housing characteristic distributions for single-family detached, single-family attached, and multifamily buildings (#151)
- Ability to add central systems (boiler with baseboards, fan coil, PTAC) to multifamily buildings using the openstudio-standards gem (#151)
- Ability to simulate large multifamily buildings using "collapsed" buildings with multipliers on building units (#206)
- Automatically generate dependency graphs and a dependency wheel for each project (#211)
- Add measures for calculating construction properties, modeling power outages and calculating resilience metrics, and calculating utility bills (#151)
- Add measure for modeling shared multiifamily facades using adiabatic constructions (#151)
- Relocate all measure unit tests, test osw files, and test osm files from archived OpenStudio-BEopt and into this repository (#151)
- Create example workflow osw files for single-family detached, single-family attached, and multifamily buildings using TMY weather (#151)
Fixes