# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).


## [0.14.2] - 2022-03-02

### Changed

- Re-weighting procedure improved with consolidated categories and added income source targeting.

## [0.14.1] - 2022-03-04

### Added

- Added a production-based carbon emissions parameter.

## [0.14.0] - 2022-02-28

### Changed

- Re-weighting procedure formalised with cross-validation and logging.

## [0.13.0] - 2022-02-28

### Added

- Pensioner exemption switch for Income Tax rate and threshold reforms.

## [0.12.4] - 2022-02-25

### Added

- Historical carbon emissions parameter.

## [0.12.3] - 2022-02-14

### Changed

- Set basic income phaseout threshold default to 0.

## [0.12.2] - 2022-02-14

### Added

- Basic income parameters and logic.

## [0.12.1] - 2022-02-14

### Changed

* OpenFisca-Tools bumped to v0.3

## [0.12.0] - 2022-02-06

### Added

* The Energy Bills Rebate scheme.

## [0.11.0] - 2022-02-04

## Added

* Re-weighting routine for the Family Resources Survey, matching aggregates, participation and populations.

## [0.10.10] - 2022-01-22

## Added

* Unit test for benefit unit rent.

## Changed

* OpenFisca-Tools dependency patch increased.

## [0.10.9] - 2022-01-22

### Fixed

* Baseline HBAI-excluded income variable now uses the Synthetic FRS when the enhanced FRS is not available.

## [0.10.8] - 2022-01-18

### Added

* Metadata (period, unit, name, label) for all Universal Credit parameters.

## [0.10.7] - 2022-01-17

### Fixed

* Household gross income calculated directly from household benefits and market income.
* Savings allowance was previously set to zero erroneously for households in Scotland at the starter or intermediate bands.

## [0.10.6] - 2022-01-17

### Added

- Stocks/flows metadata for PolicyEngine-facing variables.

## [0.10.5] - 2022-01-16

### Added

- When datasets are not available, a prompt is displayed to download them or use synthetic data.
- CLI interface trigger changed from `openfisca-uk-setup` to `openfisca-uk` and default years updated.

## [0.10.4] - 2022-01-14

### Changed

- OpenFisca-UK-Data version increased to 0.7.0.

## [0.10.3] - 2022-01-12

### Changed

- Education benefits summed in a formula.

### Added

- Sure Start Maternity Grant (reported).

### Fixed

- Some maternity benefits (SSMG, SMP) and WFA not included in benefits.

## [0.10.2] - 2022-01-08

### Changed

- Removes the `u` prefix from all variable label strings.

## [0.10.1] - 2022-01-08

### Changed

- Label metadata for tax variables.

## [0.10.0] - 2022-01-07

### Added

- Parameter representing the Child Tax Credit's child limit.

### Changed

- Renamed parameter representing Universal Credit's child limit.

## [0.9.2] - 2022-01-07

### Added

- Metadata for the Dividend, Property and Trading Allowances.

## [0.9.1] - 2021-12-29

### Added

- Microsimulation tests and YAML data for Child Benefit, Tax Credits and Council Tax.
- Documentation page for Tax Credits.
- Simplified dataset usage to enhanced FRS only.

## [0.9.0] - 2021-12-29

### Added

- Minimum tax credit benefit amount.

## [0.8.1] - 2021-12-29

### Removed

- Benefit unit- and household-level saved random numbers for take-up.

## [0.8.0] - 2021-12-27

### Added

- Historical Working Tax Credit parameters since 2002 (previously since 2016).
- Legislative references for Working Tax Credit parameters.

### Changed

- Working Tax Credit child care parameters represent the maximum amount, prior to the share covered.

### Fixed

- Apply Working Tax Credit old-age provision to 60-year-olds.
- Qualify people working 30 hours for the Working Tax Credit.
- Point AFCS to AFCS_reported instead of AA_reported.
- Fix units on some variables.

## [0.7.17] - 2021-12-23

### Added

- Units for some variables.

### Changed

- Code refactoring.

## 0.4.0 - 2021-07-05

### Added

- Tests for variable naming conventions.
- Postcode lookup optional features available.
- LHA rates for all BRMA areas added.

### Changed

- OpenFisca-UK now runs from the official OpenFisca-Core.

## 0.3.0

### Added

- New interface for microsimulation.
- Sources in tax logic.
- Tests.

### Changed

- Microdata now generated and loaded in-model.
- Variable time periods made more consistent.
- Derivative calculations made more efficient and have more options.

## 0.2.3 - 2021-04-21

### Changed

- MicroDataFrame and MicroSeries returned by default.

### Fixed

- Bugs.

## 0.2.2

### Added

- Jupyter-Book documentation.
- More detailed disability variables.

### Fixed

- IndividualSim reform handling.

## 0.2.1

### Changed

- Improved documentation of parameters.
- Tests now occur in 2021 to ensure FY20-21 parameters are used.

### Fixed

- Bug in CB-HITC that caused overestimation.

## 0.2.0 - 2020-12-05

### Changed

- Time periods now appropriate, using an implementation of WEEK for most benefits.
- MTRs handled properly and include a breakdown.
- Simulation tools are improved and included in a class.

## 0.1.0 - 2020-11-08

### Added

- Income Tax and National Insurance.
- All benefits are at least taken from survey reporting (can be switched on-off).
- Child Benefit is modelled, others such as Income Support, JSA (both types), Tax Credits can be simulated/reformed but require more reviewing in how to account for discrepancies caused by take-up rates.
- Four budget-neutral UBI reforms are implemented.
- 15 test cases (unit and integration) testing benefits and taxes.
- Simulation helper tools.
