Merge branch 'master' of https://github.com/PolicyEngine/policyengine…

…-canada into YiweiJ/issue470

CHANGELOG.md

@@ -5,6 +5,12 @@ 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.87.0] - 2023-11-09 20:50:26
+
+### Added
+
+- New Brunswick pension benefit.
+
 ## [0.86.2] - 2023-10-08 04:38:29
 
 ## [0.86.1] - 2023-10-06 11:22:22
@@ -670,6 +676,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 
 
+[0.87.0]: https://github.com/PolicyEngine/policyengine-canada/compare/0.86.2...0.87.0
 [0.86.2]: https://github.com/PolicyEngine/policyengine-canada/compare/0.86.1...0.86.2
 [0.86.1]: https://github.com/PolicyEngine/policyengine-canada/compare/0.86.0...0.86.1
 [0.86.0]: https://github.com/PolicyEngine/policyengine-canada/compare/0.85.1...0.86.0

changelog.yaml

@@ -556,3 +556,8 @@
     removed:
     - numpy pin.
   date: 2023-10-08 04:38:29
+- bump: minor
+  changes:
+    added:
+    - New Brunswick pension benefit.
+  date: 2023-11-09 20:50:26

policyengine_canada/parameters/gov/provinces/nb/benefits/pension_benefit/cap.yaml

@@ -0,0 +1,11 @@
+description: New Brunswick provides this maximum pension benefit.
+values:
+  2022-01-01: 1_000
+metadata:
+  unit: currency-CAD
+  label: New Brunswick pension benefit max amount
+  reference:
+  - title: Government of Canada - Province of New Brunswick
+    href: https://www.canada.ca/en/revenue-agency/services/forms-publications/tax-packages-years/general-income-tax-benefit-package/new-brunswick/5004-pc/information-residents-new-brunswick.html#P64_5140
+  - title: New Brunswick Income Tax Act
+    href: https://laws.gnb.ca/en/pdf/cs/N-6.001.pdf#page=31

policyengine_canada/tests/gov/provinces/nb/pension_benefits/nb_pension_benefit.yaml

@@ -0,0 +1,16 @@
+- name: Max Pension Benefit 
+  period: 2023
+  input:
+    province_code: NB
+    pension_and_savings_plan_income: 20_000
+  output:
+    nb_pension_benefit: 1_000
+
+- name: Pension Benefit Below Maximum Amount
+  period: 2023
+  input:
+    province_code: NB
+    pension_and_savings_plan_income: 800
+  output:
+    nb_pension_benefit: 800
+

policyengine_canada/variables/gov/provinces/nb/benefits/pension_benefit/nb_pension_benefit.py

@@ -0,0 +1,19 @@
+from policyengine_canada.model_api import *
+
+
+class nb_pension_benefit(Variable):
+    value_type = float
+    entity = Person
+    label = "New Brunswick pension benefit"
+    unit = CAD
+    definition_period = YEAR
+    defined_for = ProvinceCode.NB
+
+    def formula(person, period, parameters):
+        age = person("age", period)
+        pension_income = person("pension_and_savings_plan_income", period)
+        max_amount = parameters(
+            period
+        ).gov.provinces.nb.benefits.pension_benefit.cap
+        # Capped at a certain amount
+        return min_(max_amount, pension_income)

setup.py

@@ -42,7 +42,7 @@
 
 setup(
     name="policyengine-canada",
-    version="0.86.2",
+    version="0.87.0",
     author="PolicyEngine",
     author_email="[email protected]",
     classifiers=[