Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

updated readme #154

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

updated readme #154

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
014c61f
updated readme, added inputs and outputs
noman404 Dec 16, 2024
f9bd73b
updated sentence and table alignment in the readme
noman404 Dec 17, 2024
22c5174
updated suggestions, enhanced sentences, updated ToC mappings
noman404 Dec 19, 2024
b9d28d5
readme updated and added mortgage in input list
noman404 Dec 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
75 changes: 46 additions & 29 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,11 @@ A TAXSIM emulator using the PolicyEngine US federal and state tax calculator.
- [Installation](#installation)
- [From Source](#from-source)
- [From PyPI](#from-pypi)
- [Uninstall](#uninstall)
- [Usage](#usage)
- [How to Run](#how-to-run)
- [Input Variables](#input-variables)
- [Demographics](#demographics)
- [Income](#income)
- [Supported Inputs](#supported-inputs)
- [Output Types](#output-types)
- [Household Types](#household-types)
- [Contributing](#contributing)
Expand Down Expand Up @@ -54,6 +55,13 @@ This project provides an emulator for TAXSIM-35, utilizing PolicyEngine's US fed
```bash
pip install -e . --upgrade
```
## Uninstall

If you encounter any unexpected system errors, you can uninstall the package and reinstall it

```bash
pip uninstall policyengine_taxsim
```

### From PyPI

Expand All @@ -63,53 +71,62 @@ pip install git+https://github.com/PolicyEngine/policyengine-taxsim.git

## Usage

### How to Run

Run the simulation by providing your input CSV file:

```bash
python policyengine_taxsim/cli.py your_input_file.csv
```

The output will be generated as `output.csv` in the same directory.
The output will be generated as `output.txt` in the same directory. (Note that the file can be used as CSV when the output type is only `idtl = 0, 2`)

## Input Variables

The emulator accepts CSV files with the following variables:

### Demographics

| Variable | Description | Notes |
|-----------|--------------------------------|---------------------------------------------|
| taxsimid | Unique identifier | |
| year | Tax year | |
| state | State code | |
| mstat | Marital status | Only supports: 1 (single), 2 (joint) |
| page | Primary taxpayer age | |
| sage | Spouse age | |
| depx | Number of dependents | |
| age1 | First dependent's age | |
| age2 | Second dependent's age | |
| ageN | Nth dependent's age | Taxsim only allow upto 8 children dependent |

### Income
### Supported Inputs

| Variable | Description | Notes |
|-----------|------------------------------------------------------------|-----------------------------------------------------------------------------------|
| taxsimid | Unique identifier | |
| year | Tax year | |
| state | [State code (FIPS)](https://taxsim.nber.org/statesoi.html) | Two-digit code, e.g. 44 for Texas (Default is Texas if no state code is provided) |
| mstat | Marital status | Only supports: 1 (single), 2 (joint) |
| page | Primary taxpayer age | |
| sage | Spouse age | |
| depx | Number of dependents | |
| age1 | First dependent's age | |
| age2 | Second dependent's age | |
| ageN | Nth dependent's age | Taxsim only allows upto 8 child dependents |
| pwages | Primary taxpayer wages | |
| swages | Spouse wages | |
| psemp | Self-employment income of primary taxpayer | |
| ssemp | Self-employment income of secondary taxpayer | |
| dividends | Dividend Income | |
| intrec | Taxable Interest Received | |
| stcg | Short Term Capital Gains or losses | |
| ltcg | Long Term Capital Gains or losses | |
| gssi | Gross Social Security Benefits | |
| pensions | Taxable Pensions and IRA distributions | |
| rentpaid | Rent Paid | |
| mortgage | Mortgage Interest | |

| Variable | Description |
|-----------|--------------------------------|
| pwages | Primary taxpayer wages |
| swages | Spouse wages |

### Output Types

Depending on the idtl input value it can generate output types as following:

| idtl | Description |
|------|-----------------|
| 0 | Standard output |
| 2 | Full output |
| idtl | Description |
|------|------------------------------------------------|
| 0 | Standard output (Outputs 10 result columns) |
| 2 | Full output (Outputs 45 result columns) |
| 5 | Full text output (human-readable explanations) |

### Household Types

| Supported household types |
|----------------------------------------|
| Supported household types |
|-----------------------------------------|
| Single |
| Joint |
| Household with Dependent |
Expand Down
Loading