Deploying to gh-pages from @ e899e7a 🚀

_modules/taxcalc/data.html

@@ -701,7 +701,7 @@ <h1>Source code for taxcalc.data</h1><div class="highlight"><pre>
 <a class="viewcode-back" href="../../api/data.html#taxcalc.data.Data._extrapolate">[docs]</a>
     <span class="k">def</span> <span class="nf">_extrapolate</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">year</span><span class="p">):</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
-<span class="sd">        Apply to dats variables the growth factor values for specified year.</span>
+<span class="sd">        Apply to data variables the growth factor values for specified year.</span>
 <span class="sd">        &quot;&quot;&quot;</span></div>
 </div>
 

_modules/taxcalc/growdiff.html

@@ -413,6 +413,7 @@ <h1>Source code for taxcalc.growdiff</h1><div class="highlight"><pre>
 <span class="kn">import</span> <span class="nn">os</span>
 <span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
 <span class="kn">from</span> <span class="nn">taxcalc.parameters</span> <span class="kn">import</span> <span class="n">Parameters</span>
+<span class="kn">from</span> <span class="nn">taxcalc.policy</span> <span class="kn">import</span> <span class="n">Policy</span>
 <span class="kn">from</span> <span class="nn">taxcalc.growfactors</span> <span class="kn">import</span> <span class="n">GrowFactors</span>
 
 
@@ -434,8 +435,8 @@ <h1>Source code for taxcalc.growdiff</h1><div class="highlight"><pre>
 <span class="sd">    class instance: GrowDiff</span>
 <span class="sd">    &quot;&quot;&quot;</span>
 
-    <span class="n">JSON_START_YEAR</span> <span class="o">=</span> <span class="mi">2013</span>  <span class="c1"># must be same as Policy.JSON_START_YEAR</span>
-    <span class="n">DEFAULT_NUM_YEARS</span> <span class="o">=</span> <span class="mi">22</span>  <span class="c1"># must be same as Policy.DEFAULT_NUM_YEARS</span>
+    <span class="n">JSON_START_YEAR</span> <span class="o">=</span> <span class="n">Policy</span><span class="o">.</span><span class="n">JSON_START_YEAR</span>
+    <span class="n">DEFAULT_NUM_YEARS</span> <span class="o">=</span> <span class="n">Policy</span><span class="o">.</span><span class="n">DEFAULT_NUM_YEARS</span>
     <span class="n">DEFAULTS_FILE_NAME</span> <span class="o">=</span> <span class="s1">&#39;growdiff.json&#39;</span>
     <span class="n">DEFAULTS_FILE_PATH</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">abspath</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">dirname</span><span class="p">(</span><span class="vm">__file__</span><span class="p">))</span>
 
@@ -494,12 +495,17 @@ <h1>Source code for taxcalc.growdiff</h1><div class="highlight"><pre>
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="k">assert</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">growfactors</span><span class="p">,</span> <span class="n">GrowFactors</span><span class="p">)</span>
         <span class="k">for</span> <span class="n">gfvn</span> <span class="ow">in</span> <span class="n">GrowFactors</span><span class="o">.</span><span class="n">VALID_NAMES</span><span class="p">:</span>
-            <span class="n">_gfvn</span> <span class="o">=</span> <span class="s1">&#39;_</span><span class="si">{}</span><span class="s1">&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">gfvn</span><span class="p">)</span>
+            <span class="n">_gfvn</span> <span class="o">=</span> <span class="sa">f</span><span class="s1">&#39;_</span><span class="si">{</span><span class="n">gfvn</span><span class="si">}</span><span class="s1">&#39;</span>
             <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">num_years</span><span class="p">):</span>
                 <span class="n">cyr</span> <span class="o">=</span> <span class="n">i</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">start_year</span>
                 <span class="n">diff_array</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">_gfvn</span><span class="p">)</span>
                 <span class="n">growfactors</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">gfvn</span><span class="p">,</span> <span class="n">cyr</span><span class="p">,</span> <span class="n">diff_array</span><span class="p">[</span><span class="n">i</span><span class="p">])</span></div>
-</div>
+
+
+    <span class="k">def</span> <span class="nf">set_rates</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">        Unimplemented base class method that is not used here.</span>
+<span class="sd">        &quot;&quot;&quot;</span></div>
 
 </pre></div>
 

_modules/taxcalc/growfactors.html

@@ -441,7 +441,7 @@ <h1>Source code for taxcalc.growfactors</h1><div class="highlight"><pre>
 <span class="sd">    Notes</span>
 <span class="sd">    -----</span>
 <span class="sd">    Typical usage is &quot;gfactor = GrowFactors()&quot;, which produces an object</span>
-<span class="sd">    containing the default growth factors in the GrowFactors.FILE_NAME file.</span>
+<span class="sd">    containing growth factors in the GrowFactors.FILE_NAME file.</span>
 <span class="sd">    &quot;&quot;&quot;</span>
 
     <span class="n">FILE_NAME</span> <span class="o">=</span> <span class="s1">&#39;growfactors.csv&#39;</span>
@@ -464,7 +464,7 @@ <h1>Source code for taxcalc.growfactors</h1><div class="highlight"><pre>
                                          <span class="n">growfactors_filename</span><span class="p">)</span>
             <span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isfile</span><span class="p">(</span><span class="n">full_filename</span><span class="p">):</span>
                 <span class="n">gfdf</span> <span class="o">=</span> <span class="n">pd</span><span class="o">.</span><span class="n">read_csv</span><span class="p">(</span><span class="n">full_filename</span><span class="p">,</span> <span class="n">index_col</span><span class="o">=</span><span class="s1">&#39;YEAR&#39;</span><span class="p">)</span>
-            <span class="k">else</span><span class="p">:</span>  <span class="c1"># find file in conda package</span>
+            <span class="k">else</span><span class="p">:</span>  <span class="c1"># find file in package</span>
                 <span class="n">gfdf</span> <span class="o">=</span> <span class="n">read_egg_csv</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">basename</span><span class="p">(</span><span class="n">growfactors_filename</span><span class="p">),</span>
                                     <span class="n">index_col</span><span class="o">=</span><span class="s1">&#39;YEAR&#39;</span><span class="p">)</span>  <span class="c1"># pragma: no cover</span>
         <span class="k">else</span><span class="p">:</span>
@@ -473,7 +473,7 @@ <h1>Source code for taxcalc.growfactors</h1><div class="highlight"><pre>
         <span class="c1"># check validity of gfdf column names</span>
         <span class="n">gfdf_names</span> <span class="o">=</span> <span class="nb">set</span><span class="p">(</span><span class="nb">list</span><span class="p">(</span><span class="n">gfdf</span><span class="p">))</span>
         <span class="k">if</span> <span class="n">gfdf_names</span> <span class="o">!=</span> <span class="n">GrowFactors</span><span class="o">.</span><span class="n">VALID_NAMES</span><span class="p">:</span>
-            <span class="n">msg</span> <span class="o">=</span> <span class="p">(</span><span class="s1">&#39;missing names are: </span><span class="si">{}</span><span class="s1"> and invalid names are: </span><span class="si">{}</span><span class="s1">&#39;</span><span class="p">)</span>
+            <span class="n">msg</span> <span class="o">=</span> <span class="s1">&#39;missing names are: </span><span class="si">{}</span><span class="s1"> and invalid names are: </span><span class="si">{}</span><span class="s1">&#39;</span>
             <span class="n">missing</span> <span class="o">=</span> <span class="n">GrowFactors</span><span class="o">.</span><span class="n">VALID_NAMES</span> <span class="o">-</span> <span class="n">gfdf_names</span>
             <span class="n">invalid</span> <span class="o">=</span> <span class="n">gfdf_names</span> <span class="o">-</span> <span class="n">GrowFactors</span><span class="o">.</span><span class="n">VALID_NAMES</span>
             <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="n">msg</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">missing</span><span class="p">,</span> <span class="n">invalid</span><span class="p">))</span>

_modules/taxcalc/records.html

@@ -504,7 +504,10 @@ <h1>Source code for taxcalc.records</h1><div class="highlight"><pre>
 <span class="sd">    doing when attempting this.</span>
 
 <span class="sd">    Use Records.cps_constructor() to get a Records object instantiated</span>
-<span class="sd">    with CPS input data.</span>
+<span class="sd">    with CPS input data developed in the taxdata repository.</span>
+
+<span class="sd">    Use Records.tmd_constructor() to get a Records object instantiated</span>
+<span class="sd">    with TMD input data developed in the tax-microdata repository.</span>
 <span class="sd">    &quot;&quot;&quot;</span>
     <span class="c1"># suppress pylint warning about constructor having too many arguments:</span>
     <span class="c1"># pylint: disable=too-many-arguments</span>
@@ -515,11 +518,14 @@ <h1>Source code for taxcalc.records</h1><div class="highlight"><pre>
 
     <span class="n">PUFCSV_YEAR</span> <span class="o">=</span> <span class="mi">2011</span>
     <span class="n">CPSCSV_YEAR</span> <span class="o">=</span> <span class="mi">2014</span>
+    <span class="n">TMDCSV_YEAR</span> <span class="o">=</span> <span class="mi">2021</span>
 
     <span class="n">PUF_WEIGHTS_FILENAME</span> <span class="o">=</span> <span class="s1">&#39;puf_weights.csv.gz&#39;</span>
     <span class="n">PUF_RATIOS_FILENAME</span> <span class="o">=</span> <span class="s1">&#39;puf_ratios.csv&#39;</span>
     <span class="n">CPS_WEIGHTS_FILENAME</span> <span class="o">=</span> <span class="s1">&#39;cps_weights.csv.gz&#39;</span>
     <span class="n">CPS_RATIOS_FILENAME</span> <span class="o">=</span> <span class="kc">None</span>
+    <span class="n">TMD_WEIGHTS_FILENAME</span> <span class="o">=</span> <span class="s1">&#39;tmd_weights.csv.gz&#39;</span>
+    <span class="n">TMD_RATIOS_FILENAME</span> <span class="o">=</span> <span class="kc">None</span>
     <span class="n">CODE_PATH</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">abspath</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">dirname</span><span class="p">(</span><span class="vm">__file__</span><span class="p">))</span>
     <span class="n">VARINFO_FILE_NAME</span> <span class="o">=</span> <span class="s1">&#39;records_variables.json&#39;</span>
     <span class="n">VARINFO_FILE_PATH</span> <span class="o">=</span> <span class="n">CODE_PATH</span>
@@ -629,6 +635,28 @@ <h1>Source code for taxcalc.records</h1><div class="highlight"><pre>
                        <span class="n">exact_calculations</span><span class="o">=</span><span class="n">exact_calculations</span><span class="p">)</span></div>
 
 
+    <span class="nd">@staticmethod</span>
+    <span class="k">def</span> <span class="nf">tmd_constructor</span><span class="p">(</span><span class="n">data</span><span class="p">,</span>  <span class="c1"># path to tmd.csv file or dataframe</span>
+                        <span class="n">gfactors</span><span class="o">=</span><span class="n">GrowFactors</span><span class="p">(),</span>
+                        <span class="n">exact_calculations</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>  <span class="c1"># pragma: no cover</span>
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">        Static method returns a Records object instantiated with TMD</span>
+<span class="sd">        input data.  This works in a analogous way to Records(), which</span>
+<span class="sd">        returns a Records object instantiated with PUF input data.</span>
+<span class="sd">        This is a convenience method that eliminates the need to</span>
+<span class="sd">        specify all the details of the TMD input data just as the</span>
+<span class="sd">        default values of the arguments of the Records class constructor</span>
+<span class="sd">        eliminate the need to specify all the details of the PUF input</span>
+<span class="sd">        data.</span>
+<span class="sd">        &quot;&quot;&quot;</span>
+        <span class="n">weights</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">Records</span><span class="o">.</span><span class="n">CODE_PATH</span><span class="p">,</span> <span class="n">Records</span><span class="o">.</span><span class="n">TMD_WEIGHTS_FILENAME</span><span class="p">)</span>
+        <span class="k">return</span> <span class="n">Records</span><span class="p">(</span><span class="n">data</span><span class="o">=</span><span class="n">data</span><span class="p">,</span>
+                       <span class="n">start_year</span><span class="o">=</span><span class="n">Records</span><span class="o">.</span><span class="n">TMDCSV_YEAR</span><span class="p">,</span>
+                       <span class="n">gfactors</span><span class="o">=</span><span class="n">gfactors</span><span class="p">,</span>
+                       <span class="n">weights</span><span class="o">=</span><span class="n">weights</span><span class="p">,</span>
+                       <span class="n">adjust_ratios</span><span class="o">=</span><span class="n">Records</span><span class="o">.</span><span class="n">TMD_RATIOS_FILENAME</span><span class="p">,</span>
+                       <span class="n">exact_calculations</span><span class="o">=</span><span class="n">exact_calculations</span><span class="p">)</span>
+
 <div class="viewcode-block" id="Records.increment_year">
 <a class="viewcode-back" href="../../api/records.html#taxcalc.records.Records.increment_year">[docs]</a>
     <span class="k">def</span> <span class="nf">increment_year</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>