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 3 commits into
base: main
Choose a base branch
from
Open

updated readme #154

Changes from 1 commit
Commits
Show all changes
3 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
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
61 changes: 37 additions & 24 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,13 @@ This project provides an emulator for TAXSIM-35, utilizing PolicyEngine's US fed
```bash
pip install -e . --upgrade
```
## Uninstall

incase of any unexpected system error happens, you can uninstall the package

```bash
pip uninstall policyengine_taxsim
```

### From PyPI

Expand All @@ -75,36 +82,42 @@ The output will be generated as `output.csv` in the same directory.

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 | |
| 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 |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Child dependents or total dependents?

Suggested change
| ageN | Nth dependent's age | Taxsim only allow upto 8 children dependent |
| ageN | Nth dependent's age | Taxsim only allows up to 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 | |

| 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 |
| 2 | Full output |
| 5 | Full text output |

### Household Types

Expand Down
Loading