From cdb9135dde5b528da2b0c4f828bfa336459f2e7f Mon Sep 17 00:00:00 2001 From: lixiliu <36629962+lixiliu@users.noreply.github.com> Date: Thu, 18 Jan 2024 18:24:44 -0700 Subject: [PATCH 01/12] add dwelling unit count table as a resource --- ...CensusTableB25001-dwelling_unit_counts.csv | 58 +++++++++++++++++++ 1 file changed, 58 insertions(+) create mode 100644 resources/CensusTableB25001-dwelling_unit_counts.csv diff --git a/resources/CensusTableB25001-dwelling_unit_counts.csv b/resources/CensusTableB25001-dwelling_unit_counts.csv new file mode 100644 index 0000000000..7abff702e0 --- /dev/null +++ b/resources/CensusTableB25001-dwelling_unit_counts.csv @@ -0,0 +1,58 @@ +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.),"135,529,853","136,569,411","137,567,810","138,765,649","140,056,552" +Contiguous US (DC incl.) + AK,"135,845,239","136,886,312","137,886,180","139,090,083","140,382,740" +50 States (DC incl.),"136,384,292","137,428,986","138,432,751","139,647,020","140,943,613" +50 States (DC incl.) + Puerto Rico,"137,947,451","138,989,822","139,992,727","141,200,811","142,506,742" +Alabama,"2,244,462","2,255,026","2,270,398","2,278,526","2,296,920" +Alaska,"315,386","316,901","318,370","324,434","326,188" +Arizona,"2,970,935","3,003,286","3,040,595","3,056,890","3,097,768" +Arkansas,"1,362,040","1,370,281","1,379,778","1,361,880","1,371,709" +California,"14,084,824","14,175,976","14,210,945","14,328,539","14,424,442" +Colorado,"2,352,202","2,386,475","2,361,372","2,454,873","2,500,095" +Connecticut,"1,512,305","1,516,629","1,521,199","1,527,039","1,531,332" +Delaware,"428,251","433,195","438,438","445,104","451,556" +District of Columbia,"311,545","315,176","319,192","344,306","350,372" +Florida,"9,348,689","9,448,159","9,562,324","9,764,897","9,915,957" +Georgia,"4,241,003","4,283,477","4,329,675","4,375,039","4,426,780" +Hawaii,"539,053","542,674","546,571","556,937","560,873" +Idaho,"711,731","723,594","737,411","742,145","758,877" +Illinois,"5,347,268","5,360,315","5,373,385","5,412,995","5,427,357" +Indiana,"2,870,670","2,886,548","2,903,720","2,911,562","2,931,710" +Iowa,"1,386,722","1,397,087","1,407,819","1,407,100","1,417,064" +Kansas,"1,266,378","1,273,297","1,280,376","1,272,290","1,278,548" +Kentucky,"1,974,406","1,983,949","1,994,554","1,988,420","1,999,202" +Louisiana,"2,045,554","2,059,918","2,074,664","2,066,323","2,080,371" +Maine,"739,077","742,788","746,793","737,782","741,803" +Maryland,"2,437,740","2,448,422","2,459,650","2,516,341","2,531,075" +Massachusetts,"2,882,739","2,897,259","2,913,009","2,979,634","2,999,314" +Michigan,"4,580,939","4,596,198","4,611,913","4,566,504","4,580,447" +Minnesota,"2,420,473","2,438,203","2,458,030","2,470,483","2,493,956" +Mississippi,"1,316,108","1,322,808","1,330,867","1,317,375","1,324,992" +Missouri,"2,775,635","2,790,397","2,804,664","2,782,081","2,795,030" +Montana,"505,685","510,180","514,956","512,553","517,430" +Nebraska,"830,749","837,476","844,248","840,802","848,023" +Nevada,"1,235,096","1,250,893","1,268,533","1,269,846","1,288,357" +New Hampshire,"630,955","634,726","638,611","636,480","640,335" +New Jersey,"3,605,401","3,616,614","3,628,732","3,738,342","3,756,340" +New Mexico,"932,818","937,920","943,568","937,397","943,149" +New York,"8,287,087","8,322,722","8,362,971","8,449,178","8,494,452" +North Carolina,"4,573,066","4,627,089","4,687,122","4,673,933","4,739,881" +North Dakota,"367,684","373,063","376,597","370,111","372,376" +Ohio,"5,188,270","5,202,304","5,217,090","5,232,733","5,251,209" +Oklahoma,"1,723,230","1,731,632","1,740,972","1,741,721","1,751,802" +Oregon,"1,750,539","1,768,901","1,788,855","1,798,864","1,818,599" +Pennsylvania,"5,673,599","5,693,314","5,713,345","5,728,788","5,753,908" +Rhode Island,"467,412","468,335","469,289","481,168","483,053" +South Carolina,"2,256,951","2,286,826","2,319,112","2,325,248","2,362,253" +South Dakota,"387,637","392,215","396,817","391,857","396,623" +Tennessee,"2,930,530","2,963,486","2,996,127","3,011,124","3,050,850" +Texas,"10,769,900","10,937,026","11,112,975","11,433,880","11,654,971" +Utah,"1,066,131","1,087,112","1,110,369","1,133,558","1,162,654" +Vermont,"333,013","334,999","337,214","333,519","335,138" +Virginia,"3,491,091","3,514,032","3,537,788","3,596,100","3,625,285" +Washington,"3,064,381","3,106,528","3,150,194","3,170,695","3,216,243" +West Virginia,"890,715","892,182","893,615","859,437","859,142" +Wisconsin,"2,681,232","2,694,527","2,709,444","2,718,369","2,734,511" +Wyoming,"274,985","276,846","278,495","271,818","273,291" +Puerto Rico,"1,563,159","1,560,836","1,559,976","1,553,791","1,563,129" +source: https://data.census.gov/table,,,,, \ No newline at end of file From 75087bcbbb67b89f8b4f1e804e66a840745b0456 Mon Sep 17 00:00:00 2001 From: lixiliu <36629962+lixiliu@users.noreply.github.com> Date: Thu, 18 Jan 2024 18:34:39 -0700 Subject: [PATCH 02/12] change file type, update changelog --- CHANGELOG.md | 1 + ...nit_counts.csv => CensusTableB25001-dwelling_unit_counts.tsv} | 0 2 files changed, 1 insertion(+) rename resources/{CensusTableB25001-dwelling_unit_counts.csv => CensusTableB25001-dwelling_unit_counts.tsv} (100%) diff --git a/CHANGELOG.md b/CHANGELOG.md index a3281c77bf..36bd81981e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,7 @@ 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)) - Include additional 2022 Cambium 25-year LRMER emissions data ([#1194](https://github.com/NREL/resstock/pull/1194)) +- Add Census dwelling unit count by state table in resstock/resources/ folder ([#1193](https://github.com/NREL/resstock/pull/1193)) Fixes - Remove old HPWH options from options_lookup ([#1190](https://github.com/NREL/resstock/pull/1190)) diff --git a/resources/CensusTableB25001-dwelling_unit_counts.csv b/resources/CensusTableB25001-dwelling_unit_counts.tsv similarity index 100% rename from resources/CensusTableB25001-dwelling_unit_counts.csv rename to resources/CensusTableB25001-dwelling_unit_counts.tsv From 882d03d9aec931ff619d88ab8f488b18e441e09f Mon Sep 17 00:00:00 2001 From: lixiliu <36629962+lixiliu@users.noreply.github.com> Date: Thu, 18 Jan 2024 18:40:02 -0700 Subject: [PATCH 03/12] tsv format --- ...CensusTableB25001-dwelling_unit_counts.tsv | Bin 4049 -> 6014 bytes 1 file changed, 0 insertions(+), 0 deletions(-) diff --git a/resources/CensusTableB25001-dwelling_unit_counts.tsv b/resources/CensusTableB25001-dwelling_unit_counts.tsv index 7abff702e02b2b4309e995d7fc86582001302f6a..e1b34d1fadb269b5bc039b39809e41c6f1567fd4 100644 GIT binary patch literal 6014 zcmbW*TW?%d5(VJ%YNYuOejGHK;Je+tAtIO=2q3QF(J>*hNIJ;v5WCt1nQX=3WTRkSC0bCCCqQ4ElllY0D- zc#70#sq~|;?>05xUp`Nbukti8VOyrV7#gKWkMfyutwuKIBVO;+UW|~NERZ9t&W6RK z5$k(l)8+CoKhN@`JC3r~=PXZ^aY4qAp_ji}Uc8pEZ>NV6Y+Idr*epK``zns9#hGNS zj@-*zwLc#ANsZ(?#bu%}SNWN?12y@>xE5v3fZjM%u}fZPnw*aX!uF zeth8X%lzErc`tFPhL}_YB6hUqB&hmL*RE1ck{y_SHgdS1T5J+EmdRp2Sbd-0#qUMB z<>9tk?AzHYkXUM!>YIPaVKVPJkOVhuZ!RBf>vEmCU^FH}xf~_ijcHgw7ArK%kut*y zPxPzp+SADD@?j9dv&Y-W%MBb7$Hb0TeNgmN#=KB3v3qLwlUbm}Zyx@!t;Kab>}4e$ zsx|8n>S}nCoIU!1Bo`U;>)G7GFIN9K5P34#YCUuzyO+OZFKkHm&r{D6HnlF|)`v2y z&8MUD*0HM6yf$+&;s;qAt!QN)um>74z-Bm4*=$tT>0_P9_4ImF6f?0IVrC9meOc-( zg;p6+y$Y)LoW&55y_z+P=Y#utqcasExJJf<;z&0Adj8MZKyLM`?_|>XY=1Q3-pxL^ zI6K*}zPZX@&B$0l-}yu@md@9%hn!q%|50$c&1|^J+3;%EU<<3-A^OI7pt_A2*6PU$ zpY%P;dm7XCtBEIT?6uzWX{b*m1wzS9+} z^$Hn##MU{@$0nc4RNzT)+9ZS9d~`#(*&4&1tU9bzhL>4p?$guq&R=Di@>o7S2uA$4 z-^$7S(3AGVtTGF&E7>!Nr|MNgetgXRaA?Qzu^yG!r1I{AB7u+{5U;FPyqj|4kWKaa z22ZEH5$Z$Cl~QPgv|E5*=oV zr1up@>IfyIp58Xo^N9R zBy4(^sBx@!KX|scRJ%7lRWUDgu{w1Ul0@7a38~NR4VHh3-JX*sOV3i==_HZ^zN#O6 zvoX7;Y;r)UvMI8g+w8y0S?@G^mfCIxYkR+ddv7`_R<`R3mPl%gvz1H`k&|R3g7)6@ z@vr#u&GXTifIV@{rFkP}4d>zR&fp~I$=DkOPKzCO^phJb%qqy`K|K5%2KBoIWZ3D% zBVmP(=siP}Jq4@lSu%Cyz+LO#hC?^0vN|?C_~W?P^uRoq$i46N@+liS6?%?zntw8KslWU2@k8WJ z5|Lx87>jlNVpY$*-p?zkV3|ONqxQ<^)4?ZqZ~cUOjhL(k)^@^?dn)%7CBsw3ypq|l ztKTR-O}x$wx21lgv%kAo#do{0ilxff(&;|s?!seFjZ zRhBwaRIVqWD$}c)y7N<6KY926{{EN0IzioaCKT**zpTWo>Q!n@rep^3Eu$~D_3@t; zlgquw`9HJnDLU^0vZ=mjJNEK0`$Hy`JGK3uUVcvPH_`UiqSh)`7Wdwu(~DHQ4N90? zrkPY~ruyBbO6IFI?f0)ncR$&B>8yo$y>@mK`+6|NMM7V$;dRe<)ejmr*ymM^{q(ihff*XNsmu5>~}J<8bPc)lOdGYs2@D?4g2f( z`tPhdMO4aOlHGcvlBlQ7OkfkcI!)x?iSlc<%lCFv<$k*;Lpzgu7GWrv z?^%6v=L{Y+lUG6M*%q#w7>us1h8hNySlpSoKv;`{r7*~PfLF^-nz1Tb^UIa{`z>H<*`0{^!E9qd;aLZ zK5jSH(`gy+F4JY+{rqnCr`OlJ@w7j___MikA(`Z>DJfjZQ)g0FO>|D5GEdnQXZ5L= z+$Gb+Do@cGn^>Lv)gSxc{bl#+yLL#4$@rjKIi!@%1n1X7yx+Wi>aksLym#{sa>ZMd^XnWN%*cYn9hYi@J;YPUWW5B z?S2~fliVV+Bb&H-lT%2XZ|7E1D<}D^$#K-nk~lp#dXsF&EhJU1j{V2}p*L6F_!v#> zWIJ|B1SUaaXRck#Y8UFWzOS9B1g}o!dwc|!xV(G~j&D|u3$B=u<%+@MKSZ@8!9{kS z$A3*HJ-%{G4M{#5YlHF4k+EbZ)%86kE>)dTmka=!ll%TO_cJ*$q4Tl>FW7kWMemGV zP0n%&S>veq(;8>8t%P#jAID#(^Jyd+7b$rpnG!7zE+!x6WW z8){mwr{i?)Zz+>EA(2Dd@=A70%(9pFgb{Lk9}}l#0htsBz;R*4@oCsEcQBZ>Ad2Xf;i*qlMSL;JjBHTL8|H~#alh=QUw2&V^6*hI6dd0*2~u>Yxe2b~Q7#mKQm_hy1bDdQcJntfGTySa znh=ZWiUbU|v0Z9*qIjT0-{+2uRDmy0=7^dyPX0bj=Q}x{GDIghVF7jtq*WG6Mc|dD z7@NAaY)EmyJXPOrz9kpqXs)Omq9GmsPC+c=G&MODHcH%Yj>qvdjX)HJKw1xQ)y6dmY<3Q?r`eHGS1nE= z@C=63%jtIP8(Rw4?vz$u)hoqD&9*ZLZtW@PRnI~ z|0t)|Om!43*i^DMNhbjj3`%n4Js53D$@{8=+HSs|F5~=^5({|SawH%LYFbJx?mGe( zZdnP~H=bDy(h*r593{b5+Wq-SJewPTJ2QB$px^$6JB^vK2jsRu8&c0b~Bz%!%W+k zgUCAEYAF+?@X9&4SAkpYUJ*1#?UB5%R8W=UW}IjF|LGHC17uv@SxG9k=VniKfL>h# zUjSr~c3l&>nMj8?nl5L&kQXT3X`8^NH3MDEN3mb4OqqalOLMLw0RsFRrVeFKvbbnO zL&{sHPiVPB4Jn~sYN|jmQMbMwKAwARafM*B;;62UsoDw>(gU-J6%3%3R(lIJXE>!HHfyRTnT$d7 z0zQaHeZB7Q73_iOvMZVk^(ZAl#$b97g&94UkeXC$WmL(n^~a zFW4fQDttk)9$G7y?Z<@k%M}FW|h%GqOTXo@`ksb>=T#1a8D} z9_}VsFYg$a)&YR=Xr01%PlQD=gI%#z5!ugtmKYwkn;(bMX?{F@?sWu$BIH26NW2}S z7KITzqe4OZ8@3=ug%UfFVK}|r{B)RZhuxdGNn<3d^fUHG;t@QGg@m^%6^0i@3<9F< zc)NKwU7l4~=24oljxE?UuCmUcI&!FQnH~Vn-heh1 zrxmW`gHB7WdDkg@-;B2F!H3>Oc1hE3;^z>a@HC`4`UmO+DYl!Rm;NASmPY1u1i==Vw_h*( zh4NkN-VPTjHNkZx1TT2_WjH^egxrzOR{KCeMd%@NZ{qPy4P>*90aT2mq^`e=3}1>4 zu1>CO6&%Vs=H*p45*`{N1U;ho!U{A;s)OimHy?Ur>~yyXUWtG?FQ`_d68tPlUINA@ zbxtQMY#Daep8y`c@=+@LVVIZQ*O2&K05k<$h0;3h)F>?Crtj#&bZGgC<#b5@FwXnw zG>^nVa=;-BWdXJf9$HQqYh^|iM>Lv>%fu5k zbf1-M;s|1SQU~Rp{h&iR<=(A$I&_BC2$D=Q>o`Sgg1?Rbx}F~a+l{ox{qW81uq>bE dZ(hE Date: Fri, 26 Jan 2024 12:08:45 -0700 Subject: [PATCH 04/12] Update README --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c7d2f6d2ce..ba28df67e4 100644 --- a/README.md +++ b/README.md @@ -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) From 54936fb2c5e307c7ff38675dad311541ff372fc2 Mon Sep 17 00:00:00 2001 From: lixiliu <36629962+lixiliu@users.noreply.github.com> Date: Thu, 18 Jan 2024 18:24:44 -0700 Subject: [PATCH 05/12] add dwelling unit count table as a resource --- ...CensusTableB25001-dwelling_unit_counts.csv | 58 +++++++++++++++++++ 1 file changed, 58 insertions(+) create mode 100644 resources/CensusTableB25001-dwelling_unit_counts.csv diff --git a/resources/CensusTableB25001-dwelling_unit_counts.csv b/resources/CensusTableB25001-dwelling_unit_counts.csv new file mode 100644 index 0000000000..7abff702e0 --- /dev/null +++ b/resources/CensusTableB25001-dwelling_unit_counts.csv @@ -0,0 +1,58 @@ +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.),"135,529,853","136,569,411","137,567,810","138,765,649","140,056,552" +Contiguous US (DC incl.) + AK,"135,845,239","136,886,312","137,886,180","139,090,083","140,382,740" +50 States (DC incl.),"136,384,292","137,428,986","138,432,751","139,647,020","140,943,613" +50 States (DC incl.) + Puerto Rico,"137,947,451","138,989,822","139,992,727","141,200,811","142,506,742" +Alabama,"2,244,462","2,255,026","2,270,398","2,278,526","2,296,920" +Alaska,"315,386","316,901","318,370","324,434","326,188" +Arizona,"2,970,935","3,003,286","3,040,595","3,056,890","3,097,768" +Arkansas,"1,362,040","1,370,281","1,379,778","1,361,880","1,371,709" +California,"14,084,824","14,175,976","14,210,945","14,328,539","14,424,442" +Colorado,"2,352,202","2,386,475","2,361,372","2,454,873","2,500,095" +Connecticut,"1,512,305","1,516,629","1,521,199","1,527,039","1,531,332" +Delaware,"428,251","433,195","438,438","445,104","451,556" +District of Columbia,"311,545","315,176","319,192","344,306","350,372" +Florida,"9,348,689","9,448,159","9,562,324","9,764,897","9,915,957" +Georgia,"4,241,003","4,283,477","4,329,675","4,375,039","4,426,780" +Hawaii,"539,053","542,674","546,571","556,937","560,873" +Idaho,"711,731","723,594","737,411","742,145","758,877" +Illinois,"5,347,268","5,360,315","5,373,385","5,412,995","5,427,357" +Indiana,"2,870,670","2,886,548","2,903,720","2,911,562","2,931,710" +Iowa,"1,386,722","1,397,087","1,407,819","1,407,100","1,417,064" +Kansas,"1,266,378","1,273,297","1,280,376","1,272,290","1,278,548" +Kentucky,"1,974,406","1,983,949","1,994,554","1,988,420","1,999,202" +Louisiana,"2,045,554","2,059,918","2,074,664","2,066,323","2,080,371" +Maine,"739,077","742,788","746,793","737,782","741,803" +Maryland,"2,437,740","2,448,422","2,459,650","2,516,341","2,531,075" +Massachusetts,"2,882,739","2,897,259","2,913,009","2,979,634","2,999,314" +Michigan,"4,580,939","4,596,198","4,611,913","4,566,504","4,580,447" +Minnesota,"2,420,473","2,438,203","2,458,030","2,470,483","2,493,956" +Mississippi,"1,316,108","1,322,808","1,330,867","1,317,375","1,324,992" +Missouri,"2,775,635","2,790,397","2,804,664","2,782,081","2,795,030" +Montana,"505,685","510,180","514,956","512,553","517,430" +Nebraska,"830,749","837,476","844,248","840,802","848,023" +Nevada,"1,235,096","1,250,893","1,268,533","1,269,846","1,288,357" +New Hampshire,"630,955","634,726","638,611","636,480","640,335" +New Jersey,"3,605,401","3,616,614","3,628,732","3,738,342","3,756,340" +New Mexico,"932,818","937,920","943,568","937,397","943,149" +New York,"8,287,087","8,322,722","8,362,971","8,449,178","8,494,452" +North Carolina,"4,573,066","4,627,089","4,687,122","4,673,933","4,739,881" +North Dakota,"367,684","373,063","376,597","370,111","372,376" +Ohio,"5,188,270","5,202,304","5,217,090","5,232,733","5,251,209" +Oklahoma,"1,723,230","1,731,632","1,740,972","1,741,721","1,751,802" +Oregon,"1,750,539","1,768,901","1,788,855","1,798,864","1,818,599" +Pennsylvania,"5,673,599","5,693,314","5,713,345","5,728,788","5,753,908" +Rhode Island,"467,412","468,335","469,289","481,168","483,053" +South Carolina,"2,256,951","2,286,826","2,319,112","2,325,248","2,362,253" +South Dakota,"387,637","392,215","396,817","391,857","396,623" +Tennessee,"2,930,530","2,963,486","2,996,127","3,011,124","3,050,850" +Texas,"10,769,900","10,937,026","11,112,975","11,433,880","11,654,971" +Utah,"1,066,131","1,087,112","1,110,369","1,133,558","1,162,654" +Vermont,"333,013","334,999","337,214","333,519","335,138" +Virginia,"3,491,091","3,514,032","3,537,788","3,596,100","3,625,285" +Washington,"3,064,381","3,106,528","3,150,194","3,170,695","3,216,243" +West Virginia,"890,715","892,182","893,615","859,437","859,142" +Wisconsin,"2,681,232","2,694,527","2,709,444","2,718,369","2,734,511" +Wyoming,"274,985","276,846","278,495","271,818","273,291" +Puerto Rico,"1,563,159","1,560,836","1,559,976","1,553,791","1,563,129" +source: https://data.census.gov/table,,,,, \ No newline at end of file From 077be366d432adea47d17e6489084189cb6a81cd Mon Sep 17 00:00:00 2001 From: lixiliu <36629962+lixiliu@users.noreply.github.com> Date: Thu, 18 Jan 2024 18:34:39 -0700 Subject: [PATCH 06/12] change file type, update changelog --- CHANGELOG.md | 1 + ...nit_counts.csv => CensusTableB25001-dwelling_unit_counts.tsv} | 0 2 files changed, 1 insertion(+) rename resources/{CensusTableB25001-dwelling_unit_counts.csv => CensusTableB25001-dwelling_unit_counts.tsv} (100%) diff --git a/CHANGELOG.md b/CHANGELOG.md index a7462d28b7..718749fe3a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,7 @@ 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)) - Include additional 2022 Cambium 25-year LRMER emissions data ([#1194](https://github.com/NREL/resstock/pull/1194)) +- Add Census dwelling unit count by state table in resstock/resources/ folder ([#1193](https://github.com/NREL/resstock/pull/1193)) Fixes - Remove old HPWH options from options_lookup ([#1190](https://github.com/NREL/resstock/pull/1190)) diff --git a/resources/CensusTableB25001-dwelling_unit_counts.csv b/resources/CensusTableB25001-dwelling_unit_counts.tsv similarity index 100% rename from resources/CensusTableB25001-dwelling_unit_counts.csv rename to resources/CensusTableB25001-dwelling_unit_counts.tsv From 5a9c32f3dc611ac57293a059a3457a438943b281 Mon Sep 17 00:00:00 2001 From: lixiliu <36629962+lixiliu@users.noreply.github.com> Date: Thu, 18 Jan 2024 18:40:02 -0700 Subject: [PATCH 07/12] tsv format --- ...CensusTableB25001-dwelling_unit_counts.tsv | Bin 4049 -> 6014 bytes 1 file changed, 0 insertions(+), 0 deletions(-) diff --git a/resources/CensusTableB25001-dwelling_unit_counts.tsv b/resources/CensusTableB25001-dwelling_unit_counts.tsv index 7abff702e02b2b4309e995d7fc86582001302f6a..e1b34d1fadb269b5bc039b39809e41c6f1567fd4 100644 GIT binary patch literal 6014 zcmbW*TW?%d5(VJ%YNYuOejGHK;Je+tAtIO=2q3QF(J>*hNIJ;v5WCt1nQX=3WTRkSC0bCCCqQ4ElllY0D- zc#70#sq~|;?>05xUp`Nbukti8VOyrV7#gKWkMfyutwuKIBVO;+UW|~NERZ9t&W6RK z5$k(l)8+CoKhN@`JC3r~=PXZ^aY4qAp_ji}Uc8pEZ>NV6Y+Idr*epK``zns9#hGNS zj@-*zwLc#ANsZ(?#bu%}SNWN?12y@>xE5v3fZjM%u}fZPnw*aX!uF zeth8X%lzErc`tFPhL}_YB6hUqB&hmL*RE1ck{y_SHgdS1T5J+EmdRp2Sbd-0#qUMB z<>9tk?AzHYkXUM!>YIPaVKVPJkOVhuZ!RBf>vEmCU^FH}xf~_ijcHgw7ArK%kut*y zPxPzp+SADD@?j9dv&Y-W%MBb7$Hb0TeNgmN#=KB3v3qLwlUbm}Zyx@!t;Kab>}4e$ zsx|8n>S}nCoIU!1Bo`U;>)G7GFIN9K5P34#YCUuzyO+OZFKkHm&r{D6HnlF|)`v2y z&8MUD*0HM6yf$+&;s;qAt!QN)um>74z-Bm4*=$tT>0_P9_4ImF6f?0IVrC9meOc-( zg;p6+y$Y)LoW&55y_z+P=Y#utqcasExJJf<;z&0Adj8MZKyLM`?_|>XY=1Q3-pxL^ zI6K*}zPZX@&B$0l-}yu@md@9%hn!q%|50$c&1|^J+3;%EU<<3-A^OI7pt_A2*6PU$ zpY%P;dm7XCtBEIT?6uzWX{b*m1wzS9+} z^$Hn##MU{@$0nc4RNzT)+9ZS9d~`#(*&4&1tU9bzhL>4p?$guq&R=Di@>o7S2uA$4 z-^$7S(3AGVtTGF&E7>!Nr|MNgetgXRaA?Qzu^yG!r1I{AB7u+{5U;FPyqj|4kWKaa z22ZEH5$Z$Cl~QPgv|E5*=oV zr1up@>IfyIp58Xo^N9R zBy4(^sBx@!KX|scRJ%7lRWUDgu{w1Ul0@7a38~NR4VHh3-JX*sOV3i==_HZ^zN#O6 zvoX7;Y;r)UvMI8g+w8y0S?@G^mfCIxYkR+ddv7`_R<`R3mPl%gvz1H`k&|R3g7)6@ z@vr#u&GXTifIV@{rFkP}4d>zR&fp~I$=DkOPKzCO^phJb%qqy`K|K5%2KBoIWZ3D% zBVmP(=siP}Jq4@lSu%Cyz+LO#hC?^0vN|?C_~W?P^uRoq$i46N@+liS6?%?zntw8KslWU2@k8WJ z5|Lx87>jlNVpY$*-p?zkV3|ONqxQ<^)4?ZqZ~cUOjhL(k)^@^?dn)%7CBsw3ypq|l ztKTR-O}x$wx21lgv%kAo#do{0ilxff(&;|s?!seFjZ zRhBwaRIVqWD$}c)y7N<6KY926{{EN0IzioaCKT**zpTWo>Q!n@rep^3Eu$~D_3@t; zlgquw`9HJnDLU^0vZ=mjJNEK0`$Hy`JGK3uUVcvPH_`UiqSh)`7Wdwu(~DHQ4N90? zrkPY~ruyBbO6IFI?f0)ncR$&B>8yo$y>@mK`+6|NMM7V$;dRe<)ejmr*ymM^{q(ihff*XNsmu5>~}J<8bPc)lOdGYs2@D?4g2f( z`tPhdMO4aOlHGcvlBlQ7OkfkcI!)x?iSlc<%lCFv<$k*;Lpzgu7GWrv z?^%6v=L{Y+lUG6M*%q#w7>us1h8hNySlpSoKv;`{r7*~PfLF^-nz1Tb^UIa{`z>H<*`0{^!E9qd;aLZ zK5jSH(`gy+F4JY+{rqnCr`OlJ@w7j___MikA(`Z>DJfjZQ)g0FO>|D5GEdnQXZ5L= z+$Gb+Do@cGn^>Lv)gSxc{bl#+yLL#4$@rjKIi!@%1n1X7yx+Wi>aksLym#{sa>ZMd^XnWN%*cYn9hYi@J;YPUWW5B z?S2~fliVV+Bb&H-lT%2XZ|7E1D<}D^$#K-nk~lp#dXsF&EhJU1j{V2}p*L6F_!v#> zWIJ|B1SUaaXRck#Y8UFWzOS9B1g}o!dwc|!xV(G~j&D|u3$B=u<%+@MKSZ@8!9{kS z$A3*HJ-%{G4M{#5YlHF4k+EbZ)%86kE>)dTmka=!ll%TO_cJ*$q4Tl>FW7kWMemGV zP0n%&S>veq(;8>8t%P#jAID#(^Jyd+7b$rpnG!7zE+!x6WW z8){mwr{i?)Zz+>EA(2Dd@=A70%(9pFgb{Lk9}}l#0htsBz;R*4@oCsEcQBZ>Ad2Xf;i*qlMSL;JjBHTL8|H~#alh=QUw2&V^6*hI6dd0*2~u>Yxe2b~Q7#mKQm_hy1bDdQcJntfGTySa znh=ZWiUbU|v0Z9*qIjT0-{+2uRDmy0=7^dyPX0bj=Q}x{GDIghVF7jtq*WG6Mc|dD z7@NAaY)EmyJXPOrz9kpqXs)Omq9GmsPC+c=G&MODHcH%Yj>qvdjX)HJKw1xQ)y6dmY<3Q?r`eHGS1nE= z@C=63%jtIP8(Rw4?vz$u)hoqD&9*ZLZtW@PRnI~ z|0t)|Om!43*i^DMNhbjj3`%n4Js53D$@{8=+HSs|F5~=^5({|SawH%LYFbJx?mGe( zZdnP~H=bDy(h*r593{b5+Wq-SJewPTJ2QB$px^$6JB^vK2jsRu8&c0b~Bz%!%W+k zgUCAEYAF+?@X9&4SAkpYUJ*1#?UB5%R8W=UW}IjF|LGHC17uv@SxG9k=VniKfL>h# zUjSr~c3l&>nMj8?nl5L&kQXT3X`8^NH3MDEN3mb4OqqalOLMLw0RsFRrVeFKvbbnO zL&{sHPiVPB4Jn~sYN|jmQMbMwKAwARafM*B;;62UsoDw>(gU-J6%3%3R(lIJXE>!HHfyRTnT$d7 z0zQaHeZB7Q73_iOvMZVk^(ZAl#$b97g&94UkeXC$WmL(n^~a zFW4fQDttk)9$G7y?Z<@k%M}FW|h%GqOTXo@`ksb>=T#1a8D} z9_}VsFYg$a)&YR=Xr01%PlQD=gI%#z5!ugtmKYwkn;(bMX?{F@?sWu$BIH26NW2}S z7KITzqe4OZ8@3=ug%UfFVK}|r{B)RZhuxdGNn<3d^fUHG;t@QGg@m^%6^0i@3<9F< zc)NKwU7l4~=24oljxE?UuCmUcI&!FQnH~Vn-heh1 zrxmW`gHB7WdDkg@-;B2F!H3>Oc1hE3;^z>a@HC`4`UmO+DYl!Rm;NASmPY1u1i==Vw_h*( zh4NkN-VPTjHNkZx1TT2_WjH^egxrzOR{KCeMd%@NZ{qPy4P>*90aT2mq^`e=3}1>4 zu1>CO6&%Vs=H*p45*`{N1U;ho!U{A;s)OimHy?Ur>~yyXUWtG?FQ`_d68tPlUINA@ zbxtQMY#Daep8y`c@=+@LVVIZQ*O2&K05k<$h0;3h)F>?Crtj#&bZGgC<#b5@FwXnw zG>^nVa=;-BWdXJf9$HQqYh^|iM>Lv>%fu5k zbf1-M;s|1SQU~Rp{h&iR<=(A$I&_BC2$D=Q>o`Sgg1?Rbx}F~a+l{ox{qW81uq>bE dZ(hE Date: Fri, 26 Jan 2024 12:08:45 -0700 Subject: [PATCH 08/12] Update README --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c7d2f6d2ce..ba28df67e4 100644 --- a/README.md +++ b/README.md @@ -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) From 16b993ec3eaa0392b6246f42d19ba37e1165f9db Mon Sep 17 00:00:00 2001 From: Anthony Fontanini Date: Fri, 1 Mar 2024 15:21:47 -0700 Subject: [PATCH 09/12] Revert changes to the README.md --- README.md | 7 +------ 1 file changed, 1 insertion(+), 6 deletions(-) diff --git a/README.md b/README.md index ba28df67e4..c7d2f6d2ce 100644 --- a/README.md +++ b/README.md @@ -10,16 +10,11 @@ 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. [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. +- [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. - [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) From d5b1d7d4346fb87a052075ea4e05c78e17f6aacf Mon Sep 17 00:00:00 2001 From: Anthony Fontanini Date: Fri, 1 Mar 2024 15:22:18 -0700 Subject: [PATCH 10/12] Stub out new sections for read_the_docs --- ...CensusTableB25001-dwelling_unit_counts.csv | 57 ++++++++++++++ ...CensusTableB25001-dwelling_unit_counts.tsv | Bin .../workflow_inputs/characteristics.rst | 2 +- .../workflow_inputs/dwelling_unit_counts.rst | 24 ++++++ .../workflow_inputs/emissions_scenarios.rst | 5 ++ .../source/workflow_inputs/index.rst | 5 +- .../modifying_probability_distributions.rst | 66 ---------------- .../source/workflow_inputs/utility_bills.rst | 73 ++++++++++++++++++ .../writing_housing_characteristics.rst | 10 --- 9 files changed, 163 insertions(+), 79 deletions(-) create mode 100644 docs/read_the_docs/source/workflow_inputs/CensusTableB25001-dwelling_unit_counts.csv rename {resources => docs/read_the_docs/source/workflow_inputs}/CensusTableB25001-dwelling_unit_counts.tsv (100%) create mode 100644 docs/read_the_docs/source/workflow_inputs/dwelling_unit_counts.rst create mode 100644 docs/read_the_docs/source/workflow_inputs/emissions_scenarios.rst delete mode 100644 docs/read_the_docs/source/workflow_inputs/modifying_probability_distributions.rst create mode 100644 docs/read_the_docs/source/workflow_inputs/utility_bills.rst delete mode 100644 docs/read_the_docs/source/workflow_inputs/writing_housing_characteristics.rst diff --git a/docs/read_the_docs/source/workflow_inputs/CensusTableB25001-dwelling_unit_counts.csv b/docs/read_the_docs/source/workflow_inputs/CensusTableB25001-dwelling_unit_counts.csv new file mode 100644 index 0000000000..2fbf4df4e4 --- /dev/null +++ b/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 \ No newline at end of file diff --git a/resources/CensusTableB25001-dwelling_unit_counts.tsv b/docs/read_the_docs/source/workflow_inputs/CensusTableB25001-dwelling_unit_counts.tsv similarity index 100% rename from resources/CensusTableB25001-dwelling_unit_counts.tsv rename to docs/read_the_docs/source/workflow_inputs/CensusTableB25001-dwelling_unit_counts.tsv diff --git a/docs/read_the_docs/source/workflow_inputs/characteristics.rst b/docs/read_the_docs/source/workflow_inputs/characteristics.rst index adf58a2c40..ff31ee03a4 100644 --- a/docs/read_the_docs/source/workflow_inputs/characteristics.rst +++ b/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. diff --git a/docs/read_the_docs/source/workflow_inputs/dwelling_unit_counts.rst b/docs/read_the_docs/source/workflow_inputs/dwelling_unit_counts.rst new file mode 100644 index 0000000000..0110604be0 --- /dev/null +++ b/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 `_. + +These data can be used in project files +(like the `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 diff --git a/docs/read_the_docs/source/workflow_inputs/emissions_scenarios.rst b/docs/read_the_docs/source/workflow_inputs/emissions_scenarios.rst new file mode 100644 index 0000000000..f9d59bd1db --- /dev/null +++ b/docs/read_the_docs/source/workflow_inputs/emissions_scenarios.rst @@ -0,0 +1,5 @@ +.. _emissions_scenarios + +Emissions scenarios +=========================================== + diff --git a/docs/read_the_docs/source/workflow_inputs/index.rst b/docs/read_the_docs/source/workflow_inputs/index.rst index 37bb6fcec7..5e45972543 100644 --- a/docs/read_the_docs/source/workflow_inputs/index.rst +++ b/docs/read_the_docs/source/workflow_inputs/index.rst @@ -9,6 +9,7 @@ Contents in :ref:`housing_characteristics` are populated based on the national p .. toctree:: :maxdepth: 2 + dwelling_unit_counts characteristics - modifying_probability_distributions - writing_housing_characteristics + emissions_scenarios + utility_bills diff --git a/docs/read_the_docs/source/workflow_inputs/modifying_probability_distributions.rst b/docs/read_the_docs/source/workflow_inputs/modifying_probability_distributions.rst deleted file mode 100644 index c98a695aed..0000000000 --- a/docs/read_the_docs/source/workflow_inputs/modifying_probability_distributions.rst +++ /dev/null @@ -1,66 +0,0 @@ -Modifying Probability Distributions -=================================== - -This section provides a description of the housing characteristics and their dependencies and options. - -A particular building within the building stock has a set of characteristics (e.g., level of wall insulation, type of lighting, vintage, and a variety of different schedules). Each housing characteristic corresponds to a tab-separated value (tsv) file with the extension `.tsv`. These housing characteristics files are found in the ``/housing_characteristics`` directory. A housing characteristic defines the probability mass function (PMF) of that characteristic in the building stock. - -:math:`Pr(X=A_i) = P(A_i) > 0 \hspace{5mm} and \hspace{5mm} \sum_{A_i\in S_A} P(A_i) = 1 \hspace{5mm} for \hspace{5mm} i=1:n` - -When sampling a discrete random variable :math:`X` to create a representative building, :math:`X` takes a particular **Option** :math:`A_i`. All possible options are collected in the set :math:`S_A=\{A_0,A_1,...,A_n\}` and is size :math:`n`. Since these are probabilities, the entries :math:`P(A_i)` must be greater than 0 and the probability of all possible options must sum to 1. - -For example, a set of options for a building's vintage (when the building was built) may be the following: - -:math:`S_A = {<1950, 1950s, 1960s, 1970s, 1980s, 1990s, 2000s}.` - -Then the probability mass function may look like the following: - -+------------------+-------+-------+-------+-------+-------+-------+-------+ -| :math:`A_i` | <1950 | 1950s | 1960s | 1970s | 1980s | 1990s | 2000s | -+==================+=======+=======+=======+=======+=======+=======+=======+ -| :math:`P(X=A_i)` | 0.020 | 0.060 | 0.090 | 0.230 | 0.370 | 0.130 | 0.090 | -+------------------+-------+-------+-------+-------+-------+-------+-------+ - -Where the probability of a building having a given vintage in this example is - -- 2% built before 1950, -- 6% in the 1950s, -- 9% in the 1960s, -- 23% in the 1970s, -- 37% in the 1980s, -- 13% in the 1900s, and -- 9% in the 2000s. - -However, housing characteristics can have a **Dependency**, :math:`B_i`, to another housing characteristic. All possible values of the dependency are collected in the set :math:`S_B = {B_0,B_1,...B_m}` which is size :math:`m`. If the **Option** of interest :math:`A_j` and the **Dependency** :math:`B_i` is known to have occurred when sampling :math:`X` in the creation of a representative building, then conditional probability of :math:`A_j` given :math:`B_i` is usually written :math:`P(A_j|B_i)=P_{B_i}(A_j)`. - -Using the example from before, the PMF of the vintage depends on location of the particular building stock (which is represented by EPW weather files). In this example the vintage housing characteristic is examined. The first three lines in the ``/housing_characteristics/Vintage.tsv`` are shown in the table below. - -+-----------------------+-------------------------------------------------+-------+-------+-------+-------+-------+-------+-------+ -| | Location EPW (:math:`S_B`) | <1950 | 1950s | 1960s | 1970s | 1980s | 1990s | 2000s | -+-----------------------+-------------------------------------------------+-------+-------+-------+-------+-------+-------+-------+ -| :math:`P(B_0|A_j)` | USA_FL_Key.West.Intl.AP.722010_TMY3.epw | 0.02 | 0.06 | 0.09 | 0.23 | 0.37 | 0.13 | 0.09 | -+-----------------------+-------------------------------------------------+-------+-------+-------+-------+-------+-------+-------+ -| :math:`P(B_1|A_j)` | USA_FL_Miami.Intl.AP.722020_TMY3.epw | 0.05 | 0.13 | 0.13 | 0.18 | 0.17 | 0.18 | 0.16 | -+-----------------------+-------------------------------------------------+-------+-------+-------+-------+-------+-------+-------+ - -The vintage is dependent on the EPW location. The vintage discrete PMF that uses the Key West International Airport weather file, :math:`B_0`, is defined by the following distribution: - -- 2% built before 1950, -- 6% in the 1950s, -- 9% in the 1960s, -- 23% in the 1970s, -- 37% in the 1980s, -- 13% in the 1900s, and -- 9% in the 2000s. - -While the vintage PMF that uses the Miami International Airport weather file, :math:`B_1` is defined by the following distribution: - -- 5% built before 1950, -- 13% in the 1950s, -- 9% in the 1960s, -- 13% in the 1970s, -- 18% in the 1980s, -- 17% in the 1900s, and -- 18% in the 2000s. - -The **Options** can correspond to a Measure in OpenStudio or can be used as a **Dependency** for other housing characteristics. For the list of available options for a given housing characteristic, see the ``resources/options_lookup.tsv`` file. In this file the "Parameter Name" corresponds to the housing characteristic, the "Option Name" corresponds to an available option for the housing characteristic, the "Measure Dir" corresponds to the OpenStudio Measure being used, and the following columns correspond to different arguments needed by the OpenStudio Measure. Each option used in the housing characteristics tsv files must be in this ``resources/options_lookup.tsv``. These options can be modified by the user to model their particular building stock. diff --git a/docs/read_the_docs/source/workflow_inputs/utility_bills.rst b/docs/read_the_docs/source/workflow_inputs/utility_bills.rst new file mode 100644 index 0000000000..ac450232e8 --- /dev/null +++ b/docs/read_the_docs/source/workflow_inputs/utility_bills.rst @@ -0,0 +1,73 @@ +.. _utility-bill-calculations: + +Utility Bill Calculations +========================= +This section discusses the methods available in ResStock to calculate utility bills and data sources available for various fuels. + +.. _utility-bill-calculation-methods: + + +Utility bill calculation methods +********************************* +Details about the data structures can be seen in the ``resources/data/utility_bills`` `directory `_ in the repository. + + +.. _simple-utility-rate-calcuations: + +Simple utility rate calculations +________________________________ + +In the YML file's "simple_filepath" field for utility bill scenario definitions, enter a relative file path to a TSV lookup file (e.g., "resources/data/utility_bills/simple_rates/State.tsv") containing user-defined values corresponding to arguments for fixed costs, marginal rates, and PV. +The first column of the TSV lookup file contains the name of a chosen parameter for which sets of argument values are assigned according to its options. +Any blank fields, or missing options for a parameter not specified in the TSV lookup file, will be defaulted. + +See the Simple section of OpenStudio-HPXML's documentation for `Electricity Rates `_, and `Fuel Rates `_, for more information about arguments for fixed charges, marginal rates, and PV. + + +.. _detailed-utility-rate-calcuations: + +Detailed utility rate calculations +__________________________________ + +In the YML file's "detailed_filepath" field for utility bill scenario definitions, enter a relative file path to a TSV lookup file (e.g., "data/utility_bills/detailed_rates/County.tsv") containing user-defined values corresponding to arguments for electricity tariff file paths, fixed costs and marginal rates for fuels, and PV. +The first column of the TSV lookup file contains the name of a chosen parameter for which sets of argument values are assigned according to its options. +The TSV lookup file's electricity tariff file paths are relative to the parent folder of the "detailed_filepath" (e.g., "Flat/Sample Flat Rate.json"). +Any blank fields, or missing options for a parameter not specified in the TSV lookup file, will be defaulted. + +See the Detailed section of OpenStudio-HPXML's documentation for `Electricity Rates `_, and `Fuel Rates `_, for more information about arguments for electricity tariff file paths, fixed charges, marginal rates, and PV. + +For both Simple and Detailed utility rate structures, refer to BuildStockBatch's documentation for `Residential HPXML Workflow Generator `_ for more information about YML file utility bills -related arguments. + + +.. _utility-bill-data-sources: + +Data sources for utility bill calcuations +***************************************** +Here is a list of data sources typically used in utility bill calculations in ResStock: + + +.. _electricity-rate-data-sources: + +Electricity bill data sources +_____________________________ + +- EIA Form 861 +- URDB + + +.. _natural-gas-bill-data-sources: + +Natural gas bill data sources +_____________________________ + +- American Gas Association +- EIA Form 176 + + +.. fuel-oil-and-propane-bill-data-sources: + +Fuel oil and propane bill data sources +______________________________________ + +EIA Weekly Heating Oil and Propane Prices - Fuel Oil +EIA Weekly Heating Oil and Propane Prices - Propane \ No newline at end of file diff --git a/docs/read_the_docs/source/workflow_inputs/writing_housing_characteristics.rst b/docs/read_the_docs/source/workflow_inputs/writing_housing_characteristics.rst deleted file mode 100644 index 8d5927dbca..0000000000 --- a/docs/read_the_docs/source/workflow_inputs/writing_housing_characteristics.rst +++ /dev/null @@ -1,10 +0,0 @@ -Writing Housing Characteristics -=============================== - -This section provides a description of the standard format for the housing characteristics. In order to stop recommitting entire files and to keep differences easy to read during the review process, a standard format for writing housing characteristics has been created. All housing characteristics shall follow these format guidelines: - -Guidelines ----------- - -1. All lines have the line ending characters '\\r\\n' (i.e., "crlf" or "carriage return, line feed"). -2. Comment lines in the housing characteristics file, indicated by the "#" symbol, can be added. \ No newline at end of file From d1beda9e8bec7d7fa52ab5376f7426eab0d0e8bd Mon Sep 17 00:00:00 2001 From: Anthony Fontanini Date: Mon, 4 Mar 2024 13:28:52 -0700 Subject: [PATCH 11/12] Isolate only the dwelling unit table update Leave emissions and utility bills to a future PR --- .../workflow_inputs/emissions_scenarios.rst | 5 -- .../source/workflow_inputs/index.rst | 4 +- .../source/workflow_inputs/utility_bills.rst | 73 ------------------- 3 files changed, 1 insertion(+), 81 deletions(-) delete mode 100644 docs/read_the_docs/source/workflow_inputs/emissions_scenarios.rst delete mode 100644 docs/read_the_docs/source/workflow_inputs/utility_bills.rst diff --git a/docs/read_the_docs/source/workflow_inputs/emissions_scenarios.rst b/docs/read_the_docs/source/workflow_inputs/emissions_scenarios.rst deleted file mode 100644 index f9d59bd1db..0000000000 --- a/docs/read_the_docs/source/workflow_inputs/emissions_scenarios.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. _emissions_scenarios - -Emissions scenarios -=========================================== - diff --git a/docs/read_the_docs/source/workflow_inputs/index.rst b/docs/read_the_docs/source/workflow_inputs/index.rst index 5e45972543..612032b680 100644 --- a/docs/read_the_docs/source/workflow_inputs/index.rst +++ b/docs/read_the_docs/source/workflow_inputs/index.rst @@ -10,6 +10,4 @@ Contents in :ref:`housing_characteristics` are populated based on the national p :maxdepth: 2 dwelling_unit_counts - characteristics - emissions_scenarios - utility_bills + characteristics \ No newline at end of file diff --git a/docs/read_the_docs/source/workflow_inputs/utility_bills.rst b/docs/read_the_docs/source/workflow_inputs/utility_bills.rst deleted file mode 100644 index ac450232e8..0000000000 --- a/docs/read_the_docs/source/workflow_inputs/utility_bills.rst +++ /dev/null @@ -1,73 +0,0 @@ -.. _utility-bill-calculations: - -Utility Bill Calculations -========================= -This section discusses the methods available in ResStock to calculate utility bills and data sources available for various fuels. - -.. _utility-bill-calculation-methods: - - -Utility bill calculation methods -********************************* -Details about the data structures can be seen in the ``resources/data/utility_bills`` `directory `_ in the repository. - - -.. _simple-utility-rate-calcuations: - -Simple utility rate calculations -________________________________ - -In the YML file's "simple_filepath" field for utility bill scenario definitions, enter a relative file path to a TSV lookup file (e.g., "resources/data/utility_bills/simple_rates/State.tsv") containing user-defined values corresponding to arguments for fixed costs, marginal rates, and PV. -The first column of the TSV lookup file contains the name of a chosen parameter for which sets of argument values are assigned according to its options. -Any blank fields, or missing options for a parameter not specified in the TSV lookup file, will be defaulted. - -See the Simple section of OpenStudio-HPXML's documentation for `Electricity Rates `_, and `Fuel Rates `_, for more information about arguments for fixed charges, marginal rates, and PV. - - -.. _detailed-utility-rate-calcuations: - -Detailed utility rate calculations -__________________________________ - -In the YML file's "detailed_filepath" field for utility bill scenario definitions, enter a relative file path to a TSV lookup file (e.g., "data/utility_bills/detailed_rates/County.tsv") containing user-defined values corresponding to arguments for electricity tariff file paths, fixed costs and marginal rates for fuels, and PV. -The first column of the TSV lookup file contains the name of a chosen parameter for which sets of argument values are assigned according to its options. -The TSV lookup file's electricity tariff file paths are relative to the parent folder of the "detailed_filepath" (e.g., "Flat/Sample Flat Rate.json"). -Any blank fields, or missing options for a parameter not specified in the TSV lookup file, will be defaulted. - -See the Detailed section of OpenStudio-HPXML's documentation for `Electricity Rates `_, and `Fuel Rates `_, for more information about arguments for electricity tariff file paths, fixed charges, marginal rates, and PV. - -For both Simple and Detailed utility rate structures, refer to BuildStockBatch's documentation for `Residential HPXML Workflow Generator `_ for more information about YML file utility bills -related arguments. - - -.. _utility-bill-data-sources: - -Data sources for utility bill calcuations -***************************************** -Here is a list of data sources typically used in utility bill calculations in ResStock: - - -.. _electricity-rate-data-sources: - -Electricity bill data sources -_____________________________ - -- EIA Form 861 -- URDB - - -.. _natural-gas-bill-data-sources: - -Natural gas bill data sources -_____________________________ - -- American Gas Association -- EIA Form 176 - - -.. fuel-oil-and-propane-bill-data-sources: - -Fuel oil and propane bill data sources -______________________________________ - -EIA Weekly Heating Oil and Propane Prices - Fuel Oil -EIA Weekly Heating Oil and Propane Prices - Propane \ No newline at end of file From ef6911ea3fd70bcf372c5bcca808c260bb323ba2 Mon Sep 17 00:00:00 2001 From: Anthony Fontanini Date: Mon, 4 Mar 2024 13:30:29 -0700 Subject: [PATCH 12/12] Remove dublicative table file --- .../CensusTableB25001-dwelling_unit_counts.tsv | Bin 6014 -> 0 bytes 1 file changed, 0 insertions(+), 0 deletions(-) delete mode 100644 docs/read_the_docs/source/workflow_inputs/CensusTableB25001-dwelling_unit_counts.tsv diff --git a/docs/read_the_docs/source/workflow_inputs/CensusTableB25001-dwelling_unit_counts.tsv b/docs/read_the_docs/source/workflow_inputs/CensusTableB25001-dwelling_unit_counts.tsv deleted file mode 100644 index e1b34d1fadb269b5bc039b39809e41c6f1567fd4..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 6014 zcmbW*TW?%d5(VJ%YNYuOejGHK;Je+tAtIO=2q3QF(J>*hNIJ;v5WCt1nQX=3WTRkSC0bCCCqQ4ElllY0D- zc#70#sq~|;?>05xUp`Nbukti8VOyrV7#gKWkMfyutwuKIBVO;+UW|~NERZ9t&W6RK z5$k(l)8+CoKhN@`JC3r~=PXZ^aY4qAp_ji}Uc8pEZ>NV6Y+Idr*epK``zns9#hGNS zj@-*zwLc#ANsZ(?#bu%}SNWN?12y@>xE5v3fZjM%u}fZPnw*aX!uF zeth8X%lzErc`tFPhL}_YB6hUqB&hmL*RE1ck{y_SHgdS1T5J+EmdRp2Sbd-0#qUMB z<>9tk?AzHYkXUM!>YIPaVKVPJkOVhuZ!RBf>vEmCU^FH}xf~_ijcHgw7ArK%kut*y zPxPzp+SADD@?j9dv&Y-W%MBb7$Hb0TeNgmN#=KB3v3qLwlUbm}Zyx@!t;Kab>}4e$ zsx|8n>S}nCoIU!1Bo`U;>)G7GFIN9K5P34#YCUuzyO+OZFKkHm&r{D6HnlF|)`v2y z&8MUD*0HM6yf$+&;s;qAt!QN)um>74z-Bm4*=$tT>0_P9_4ImF6f?0IVrC9meOc-( zg;p6+y$Y)LoW&55y_z+P=Y#utqcasExJJf<;z&0Adj8MZKyLM`?_|>XY=1Q3-pxL^ zI6K*}zPZX@&B$0l-}yu@md@9%hn!q%|50$c&1|^J+3;%EU<<3-A^OI7pt_A2*6PU$ zpY%P;dm7XCtBEIT?6uzWX{b*m1wzS9+} z^$Hn##MU{@$0nc4RNzT)+9ZS9d~`#(*&4&1tU9bzhL>4p?$guq&R=Di@>o7S2uA$4 z-^$7S(3AGVtTGF&E7>!Nr|MNgetgXRaA?Qzu^yG!r1I{AB7u+{5U;FPyqj|4kWKaa z22ZEH5$Z$Cl~QPgv|E5*=oV zr1up@>IfyIp58Xo^N9R zBy4(^sBx@!KX|scRJ%7lRWUDgu{w1Ul0@7a38~NR4VHh3-JX*sOV3i==_HZ^zN#O6 zvoX7;Y;r)UvMI8g+w8y0S?@G^mfCIxYkR+ddv7`_R<`R3mPl%gvz1H`k&|R3g7)6@ z@vr#u&GXTifIV@{rFkP}4d>zR&fp~I$=DkOPKzCO^phJb%qqy`K|K5%2KBoIWZ3D% zBVmP(=siP}Jq4@lSu%Cyz+LO#hC?^0vN|?C_~W?P^uRoq$i46N@+liS6?%?zntw8KslWU2@k8WJ z5|Lx87>jlNVpY$*-p?zkV3|ONqxQ<^)4?ZqZ~cUOjhL(k)^@^?dn)%7CBsw3ypq|l ztKTR-O}x$wx21lgv%kAo#do{0ilxff(&;|s?!seFjZ zRhBwaRIVqWD$}c)y7N<6KY926{{EN0IzioaCKT**zpTWo>Q!n@rep^3Eu$~D_3@t; zlgquw`9HJnDLU^0vZ=mjJNEK0`$Hy`JGK3uUVcvPH_`UiqSh)`7Wdwu(~DHQ4N90? zrkPY~ruyBbO6IFI?f0)ncR$&B>8yo$y>@mK`+6|NMM7V$;dRe<)ejmr*ymM^{q(ihff*XNsmu5>~}J<8bPc)lOdGYs2@D?4g2f( z`tPhdMO4aOlHGcvlBlQ7OkfkcI!)x?iSlc<%lCFv<$k*;Lpzgu7GWrv z?^%6v=L{Y+lUG6M*%q