Add to the workflow_inputs section of RTD

CHANGELOG.md

@@ -5,13 +5,17 @@ Features
 - Add flexibility to specify location of the radiant barrier ([#1188](https://github.com/NREL/resstock/pull/1188))
 - Add ability to describe detailed performance data for variable-speed air-source HVAC systems ([#1188](https://github.com/NREL/resstock/pull/1188), [#1200](https://github.com/NREL/resstock/pull/1200))
 - Include additional 2022 Cambium 25-year LRMER emissions data ([#1194](https://github.com/NREL/resstock/pull/1194))
+<<<<<<< HEAD
+- Add Census dwelling unit count by state table in resstock/resources/ folder ([#1193](https://github.com/NREL/resstock/pull/1193))
+=======
 - Add optional switch to BuildExistingModel (defaulted to false) for modeling whole SFA/MF buildings ([#1200](https://github.com/NREL/resstock/pull/1200))
 - Update hot water usage multipliers based on field data rather than engineering judgement ([#1210](https://github.com/NREL/resstock/pull/1210))
 - Allow definition of multiple unavailable periods (i.e., vacancy, power outage) ([#1209](https://github.com/NREL/resstock/pull/1209))
 - Add ability to set either an "emergency" or "supplemental" heat pump backup sizing methodology ([#1209](https://github.com/NREL/resstock/pull/1209))
 - Refrigerator energy use is now affected by its ambient temperature using hourly constant and temperature coefficients from ANSI/RESNET/ICC 301-2022 Addendum C ([#1209](https://github.com/NREL/resstock/pull/1209))
 - Add Metropolitan and Micropolitan Statistical Area tsv, County Metro Status tsv, and State Metro Median Income tsv ([#1212](https://github.com/NREL/resstock/pull/1212))
 
+>>>>>>> origin/develop
 
 Fixes
 - Remove old HPWH options from options_lookup ([#1190](https://github.com/NREL/resstock/pull/1190))

docs/read_the_docs/source/workflow_inputs/CensusTableB25001-dwelling_unit_counts.csv

@@ -0,0 +1,57 @@
+Total,2018 ACS 5-yrs,2019 ACS 5-yrs,2020 ACS 5-yrs,2021 ACS 5-yrs,2022 ACS 5-yrs
+Contiguous US (DC incl.),135529853,136569411,137567810,138765649,140056552
+Contiguous US (DC incl.) + AK,135845239,136886312,137886180,139090083,140382740
+50 States (DC incl.),136384292,137428986,138432751,139647020,140943613
+50 States (DC incl.) + Puerto Rico,137947451,138989822,139992727,141200811,142506742
+Alabama,2244462,2255026,2270398,2278526,2296920
+Alaska,315386,316901,318370,324434,326188
+Arizona,2970935,3003286,3040595,3056890,3097768
+Arkansas,1362040,1370281,1379778,1361880,1371709
+California,14084824,14175976,14210945,14328539,14424442
+Colorado,2352202,2386475,2361372,2454873,2500095
+Connecticut,1512305,1516629,1521199,1527039,1531332
+Delaware,428251,433195,438438,445104,451556
+District of Columbia,311545,315176,319192,344306,350372
+Florida,9348689,9448159,9562324,9764897,9915957
+Georgia,4241003,4283477,4329675,4375039,4426780
+Hawaii,539053,542674,546571,556937,560873
+Idaho,711731,723594,737411,742145,758877
+Illinois,5347268,5360315,5373385,5412995,5427357
+Indiana,2870670,2886548,2903720,2911562,2931710
+Iowa,1386722,1397087,1407819,1407100,1417064
+Kansas,1266378,1273297,1280376,1272290,1278548
+Kentucky,1974406,1983949,1994554,1988420,1999202
+Louisiana,2045554,2059918,2074664,2066323,2080371
+Maine,739077,742788,746793,737782,741803
+Maryland,2437740,2448422,2459650,2516341,2531075
+Massachusetts,2882739,2897259,2913009,2979634,2999314
+Michigan,4580939,4596198,4611913,4566504,4580447
+Minnesota,2420473,2438203,2458030,2470483,2493956
+Mississippi,1316108,1322808,1330867,1317375,1324992
+Missouri,2775635,2790397,2804664,2782081,2795030
+Montana,505685,510180,514956,512553,517430
+Nebraska,830749,837476,844248,840802,848023
+Nevada,1235096,1250893,1268533,1269846,1288357
+New Hampshire,630955,634726,638611,636480,640335
+New Jersey,3605401,3616614,3628732,3738342,3756340
+New Mexico,932818,937920,943568,937397,943149
+New York,8287087,8322722,8362971,8449178,8494452
+North Carolina,4573066,4627089,4687122,4673933,4739881
+North Dakota,367684,373063,376597,370111,372376
+Ohio,5188270,5202304,5217090,5232733,5251209
+Oklahoma,1723230,1731632,1740972,1741721,1751802
+Oregon,1750539,1768901,1788855,1798864,1818599
+Pennsylvania,5673599,5693314,5713345,5728788,5753908
+Rhode Island,467412,468335,469289,481168,483053
+South Carolina,2256951,2286826,2319112,2325248,2362253
+South Dakota,387637,392215,396817,391857,396623
+Tennessee,2930530,2963486,2996127,3011124,3050850
+Texas,10769900,10937026,11112975,11433880,11654971
+Utah,1066131,1087112,1110369,1133558,1162654
+Vermont,333013,334999,337214,333519,335138
+Virginia,3491091,3514032,3537788,3596100,3625285
+Washington,3064381,3106528,3150194,3170695,3216243
+West Virginia,890715,892182,893615,859437,859142
+Wisconsin,2681232,2694527,2709444,2718369,2734511
+Wyoming,274985,276846,278495,271818,273291
+Puerto Rico,1563159,1560836,1559976,1553791,1563129

docs/read_the_docs/source/workflow_inputs/characteristics.rst

@@ -1,6 +1,6 @@
 .. _housing_characteristics:
 
-Housing Characteristics
+Housing Characteristics Distributions
 =======================
 
 Each parameter sampled by the national project is listed alphabetically as its own subsection below.

docs/read_the_docs/source/workflow_inputs/dwelling_unit_counts.rst

@@ -0,0 +1,24 @@
+.. _dwelling-unit-counts:
+
+Dwelling unit counts of the U.S. residential building stock
+===========================================================
+ResStock uses data from the U.S. Census American Community Survery (ACS) to specify the number of dwelling units in the U.S. 
+These estimates include both occupied and vacant dwellings. 
+The data comes from the ACS `Table B25001 <https://data.census.gov/table/ACSDT5Y2022.B25001?q=B25001>`_.
+
+These data can be used in project files 
+(like the `national_baseline.yml <https://github.com/NREL/resstock/blob/develop/project_national/national_baseline.yml>`_)
+to specify the ``n_buildings_represented`` variable.
+
+.. note::
+
+ If you want to use state level unit counts, the proper downselect logic must be used in the ``sampler`` block of the project file.
+
+.. literalinclude:: .gemrc
+
+.. _dwelling_unit_count_table:
+
+.. csv-table:: Dwelling unit counts from ACS Table B25001.
+   :file: CensusTableB25001-dwelling_unit_counts.csv
+   :widths: 30, 15, 15, 15, 15, 15
+   :header-rows: 1

docs/read_the_docs/source/workflow_inputs/index.rst

@@ -9,6 +9,5 @@ Contents in :ref:`housing_characteristics` are populated based on the national p
 .. toctree::
    :maxdepth: 2
 
-   characteristics
-   modifying_probability_distributions
-   writing_housing_characteristics
+   dwelling_unit_counts
+   characteristics