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.

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

Prepare 3.0.0 #2474

Merged
merged 7 commits into from
Aug 24, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ TAXCALC_JSON_FILES := $(shell ls -l ./taxcalc/*json | awk '{print $$9}')
TESTS_JSON_FILES := $(shell ls -l ./taxcalc/tests/*json | awk '{print $$9}')
PYLINT_FILES := $(shell grep -rl --include="*py" disable=locally-disabled .)
PYLINT_OPTIONS = --disable=locally-disabled --score=no --jobs=4
RECIPE_FILES := $(shell ls -l ./docs/cookbook/recipe*py | awk '{print $$9}')
MattHJensen marked this conversation as resolved.
Show resolved Hide resolved
RECIPE_FILES := $(shell ls -l ./docs/cookbook/recipe*ipynb | awk '{print $$9}')
PYLINT_IGNORE = C0103,C0111,E0401,E1120,R0913,R0914,W0401,W0614
RECIPE_OPTIONS = --disable=$(PYLINT_IGNORE) --score=no --jobs=4

Expand Down
24 changes: 2 additions & 22 deletions RELEASING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ RELEASING TAX-CALCULATOR CONDA PACKAGES
```
====> CREATE NEW TAXCALC PACKAGES <====

--> on branch X-Y-Z, edit RELEASES.md and CHANGES.md to finalize X.Y.Z info
--> on branch X-Y-Z, edit RELEASES.md to finalize X.Y.Z info

--> specify release X.Y.Z in setup.py and taxcalc/__init__.py

Expand All @@ -18,9 +18,7 @@ RELEASING TAX-CALCULATOR CONDA PACKAGES

--> cd taxcalc/validation ; ./tests.sh ; .fix. ; cd ../..

--> cd docs ; ./uguide_results.sh ; .fix. ; python make_uguide.py

--> specify release X.Y.Z in index.htmx ; python make_tc_pages.py
--> specify release X.Y.Z in index.md

--> cd .. ; make clean [to remove taxcalc package]

Expand Down Expand Up @@ -49,24 +47,6 @@ RELEASING TAX-CALCULATOR CONDA PACKAGES

--> create Behavioral-Responses packages

====> CREATE NEW PYTHON COOKBOOK <====

--> run `conda install -c PSLmodels behresp --yes` [to make behresp available]

--> on new branch X-Y-Z-cookbook

--> cd docs/cookbook ; python test_recipes.py ; .fix. ; python make_cookbook.py

--> merge X-Y-Z-cookbook branch and push to origin

--> merge X-Y-Z-cookbook branch into master branch on GitHub

--> on local master branch, ./gitsync

--> execute `touch docs/index.html`
--> execute `touch docs/uguide.html`
--> execute `touch docs/cookbook.html`

====> NOTIFY OTHER DEVELOPERS <====

--> email policybrain-modelers list about the new release and packages
Expand Down
267 changes: 0 additions & 267 deletions docs/about/changes.md

This file was deleted.

26 changes: 26 additions & 0 deletions docs/about/releases.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,32 @@ Go [here](https://github.com/PSLmodels/Tax-Calculator/pulls?q=is%3Apr+is%3Aclose
for a complete commit history.


2020-08-22 Release 3.0.0
------------------------
(last merged pull request is
[#2474](https://github.com/PSLmodels/Tax-Calculator/pull/2474))

**This is a major release with changes that make Tax-Calculator incompatible with earlier releases.**

**API Changes**
- Adopt the [ParamTools library](https://github.com/PSLmodels/ParamTools) for parameter processing and validation, allowing easier integration with other projects that rely on ParamTools, less code for the Tax-Calculator project to maintain, and other benefits for Tax-Calculator users. Backwards compatibiltiy was maintained except for a minor API change: The parameter values that are accessible as instance attributes (e.g. pol.II_em) are not casted down into a lower dimension. So, if the year is 2017, then pol.II_em returns [4050.0] instead of 4050.0. [[#2401](https://github.com/PSLmodels/Tax-Calculator/pull/2401) by Hank Doupe]
- CPI_offset was replaced by parameter_indexing_CPI_offset, which has slightly different behavior: When parameter_indexing_CPI_offset is specified in a reform, that value is no longer added to the existing parameter_indexing_CPI_offset as was the case with CPI_offset. Rather, the specified value becomes the offset from the baseline unchained CPI. This new behavior is consistent with what is expected from all other Tax-Calculator parameters. [[#2413](https://github.com/PSLmodels/Tax-Calculator/pull/2413) by Peter Metz]
- Replace the variable reporting the number of dependents under 5 years old (nu05) with the number under 6 years old (nu06) to support recent policy proposals. [[#2443](https://github.com/PSLmodels/Tax-Calculator/pull/2443) by Peter Metz, with primary work in [TaxData PR #329](https://github.com/PSLmodels/taxdata/pull/329) by Anderson Frailey]
- Remove the changes.md file to consolidate version reporting in this file, releases.md. [[#2474](https://github.com/PSLmodels/Tax-Calculator/pull/2474) by Matt Jensen]

**New Features**
- Enable Windows users to convert TAXSIM input files to the interface required by Tax-Calculator's tc Command Line Interface by replacing validation script taxcalc.sh with taxcalc.py [[#2408](https://github.com/PSLmodels/Tax-Calculator/pull/2408) by Peter Metz based on feedback from Ernie Tedeschi]
- Add automated testing for Python 3.8 to ensure a bug-free experience for users on the latest version of Python. [[#2414](https://github.com/PSLmodels/Tax-Calculator/pull/2414) by Hank Doupe]
- Include UBI amounts, when introduced by user reforms, to variables that report total benefits. [[#2418](https://github.com/PSLmodels/Tax-Calculator/pull/2418) by Jason DeBacker]
- Improve [documentation site](https://pslmodels.github.io/Tax-Calculator/) with [Jupyter Book](https://jupyterbook.org/intro.html) [[#2420](https://github.com/PSLmodels/Tax-Calculator/pull/2420) by Max Ghenis with auxiliary PRs by Jason DeBacker]
- Add documentation for the Tax-Calculator API to the docs site. [[#2441](https://github.com/PSLmodels/Tax-Calculator/pull/2441) by Jason DeBacker]
- Add documentation for Tax-Calculator parameters to the docs site. [[#2450](https://github.com/PSLmodels/Tax-Calculator/pull/2450) by Hank Doupe]
- Port from SAS to Python the creation of the CPS tax unit file that is packaged with Tax-Calculator. [[#2444](https://github.com/PSLmodels/Tax-Calculator/pull/2444) by Peter Metz, with primary work in [TaxData PR #314](https://github.com/PSLmodels/taxdata/pull/314) by Anderson Frailey]
- Update the Tax-Calculator baseline or the CBO's July 2 report, "An Update to the Economic Outlook: 2020-2030." [[#2462](https://github.com/PSLmodels/Tax-Calculator/pull/2462) by Peter Metz, with primary work in [TaxData PR #332](https://github.com/PSLmodels/taxdata/pull/314) by Jacob Chuslo]

**Bug Fixes**
- Adjustments to the CPI_offset set under current law previously overwrite the scheduled expiration of TCJA tax cut for parameters that are inflation indexed. The adoption of the new parameter_indexing_CPI_offset fixes this bug. We are unware of any users encountering this issue. [[#2413](https://github.com/PSLmodels/Tax-Calculator/pull/2413) by Peter Metz]

2020-03-18 Release 2.9.0
------------------------
(last merged pull request is
Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ The cross-model validation work with NBER's TAXSIM-27 model is described

## Latest release

{doc}`2.9.0 (2020-03-18) <about/releases>`
{doc}`3.0.0 (2020-08-22) <about/releases>`

If you are already using Tax-Calculator, upgrade using the following command:

Expand Down
3 changes: 2 additions & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
with open('README.md') as f:
longdesc = f.read()

version = '2.9.0'
version = '3.0.0'

config = {
'description': 'Tax Calculator',
Expand All @@ -30,6 +30,7 @@
'Programming Language :: Python :: 3',
'Programming Language :: Python :: 3.6',
'Programming Language :: Python :: 3.7',
'Programming Language :: Python :: 3.8',
'Topic :: Software Development :: Libraries :: Python Modules'],
'tests_require': ['pytest'],
'entry_points': {
Expand Down
2 changes: 1 addition & 1 deletion taxcalc/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@
from taxcalc.utils import *
from taxcalc.cli import *

__version__ = '2.9.0'
__version__ = '3.0.0'
Loading