Skip to content

Commit f59ca97

Browse files
authored
Merge pull request #2867 from martinholmer/improve-tmd-data-documentation
Clarify use of TMD files in user guide
2 parents e18cab9 + 806b541 commit f59ca97

File tree

2 files changed

+20
-6
lines changed

2 files changed

+20
-6
lines changed

docs/guide/python_interface.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,14 @@
11
Python interface
22
================
33

4-
Of the two ways of using Tax-Calculator described in this guide, one requires writing Python programs, the other involves using a command-line tool and requires no computer programming. The detailed information in this guide about policy parameters, input variables, output variables, and assumption parameters, will be useful to you either way you use Tax-Calculator.
4+
Of the two ways of using Tax-Calculator described in this guide, one
5+
requires writing Python programs, the other involves using a
6+
command-line tool and requires no computer programming. The detailed
7+
information in this guide about policy parameters, input variables,
8+
output variables, and assumption parameters, will be useful to you
9+
either way you use Tax-Calculator.
510

6-
If you want to learn more about how to write Python programs that use Tax-Calculator, follow the {doc}`../../recipes/index`, which contains a collection of tested recipes that employ both basic and advanced techniques.
11+
If you want to learn more about how to write Python programs that use
12+
Tax-Calculator, follow the {doc}`../../recipes/index`, which contains
13+
a collection of tested recipes that employ both basic and advanced
14+
techniques.

docs/usage/data.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -67,10 +67,16 @@ produces an input variables file (`tmd.csv`), a national weights file
6767
package beginning with the 3.6.0 release. The `tmd.csv` file is
6868
available only to Tax-Calculator users who have purchased their own
6969
version of the 2015 IRS-SOI PUF. For those users, those three files
70-
are avaiable from the tax-microdata repository. These three tmd files
71-
can be used with the Tax-Calculator Python API (using the
72-
`Records.tmd_constructor()` and `Policy.tmd_constructor()`static methods)
73-
or with the Tax-Calculator CLI tool, `tc`.
70+
are avaiable from the tax-microdata repository. These three TMD files
71+
can be used with Tax-Calculator in two ways:
72+
73+
- with the **Python API** by instantiating a GrowFactors object that
74+
uses TMD factors [gf = GrowFactors("path/to/tmd_growfactors.csv")]
75+
and by using the `Records.tmd_constructor()` and
76+
`Policy.tmd_constructor()`static methods
77+
78+
- with the **CLI tool**, `tc`, when the three TMD files are all in
79+
the same folder
7480

7581
## Using other data with Tax-Calculator
7682

0 commit comments

Comments
 (0)