Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
lixiliu committed Jan 26, 2024
1 parent 882d03d commit e3d6fad
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,16 @@ The `develop` branch is under active development. Find the latest release [here]

This repository contains:

- [Housing characteristics of the U.S. residential building stock](https://github.com/NREL/resstock/tree/main/project_national/housing_characteristics), in the form of conditional probability distributions stored as tab-separated value (.tsv) files. Comments at the bottom of each file document data sources and assumptions for each.
- [Housing characteristics of the U.S. residential building stock](https://github.com/NREL/resstock/tree/main/project_national/housing_characteristics), in the form of conditional probability distributions stored as tab-separated value (.tsv) files. Comments at the bottom of each file document data sources and assumptions for each. [Resources files](https://github.com/NREL/resstock/tree/main/project_national/resources) available to provide the national saturation of each housing characteristic and a summary report of the data sources and assumptions from all tsvs.
- [A library of housing characteristic "options"](https://github.com/NREL/resstock/blob/main/resources/options_lookup.tsv) that translate high-level characteristic parameters into arguments for OpenStudio measures, and which are referenced by the housing characteristic .tsv files and building energy upgrades defined in project definition files
- Project definition files:
- v2.3.0 and later: [buildstockbatch YML files openable in any text editor](https://github.com/NREL/resstock/blob/main/project_national/national_baseline.yml)
- v2.2.5 and prior: [Project folder openable in PAT](https://github.com/NREL/resstock/tree/v2.2.5/project_singlefamilydetached)
- Resources for the project definition files:
- [Dwelling unit count lookup for `n_buildings_represented`](https://github.com/NREL/resstock/blob/main/resources/CensusTableB25001-dwelling_unit_counts.tsv)
- [Data dictionary of simulation result columns](https://github.com/NREL/resstock/blob/main/resources/data/dictionary)
- [Cambium emissions scenarios](https://github.com/NREL/resstock/blob/main/resources/data/emissions)
- [Utility bills calculation](https://github.com/NREL/resstock/blob/main/resources/data/utility_bills)
- Unit-level OpenStudio Measures for automatically constructing OpenStudio Models of each representative dwelling unit model:
- v3.0.0 and later: [OpenStudio-HPXML Measures](https://github.com/NREL/resstock/tree/main/resources/hpxml-measures)
- v2.5.0 and prior: [OpenStudio Measures](https://github.com/NREL/resstock/tree/v2.5.0/resources/measures)
Expand Down

0 comments on commit e3d6fad

Please sign in to comment.