owlplanner 2025.2.6__py3-none-any.whl → 2025.2.8__py3-none-any.whl

owlplanner/config.py

@@ -52,6 +52,7 @@ def saveConfig(plan, file, mylog):
     # Fixed Income.
     diconf['Fixed Income'] = {'Pension amounts': (plan.pensionAmounts/1000).tolist(),
                               'Pension ages': plan.pensionAges.tolist(),
+                              'Pension indexed': plan.pensionIndexed,
                               'Social security amounts': (plan.ssecAmounts/1000).tolist(),
                               'Social security ages': plan.ssecAges.tolist(),
                               }
@@ -213,7 +214,8 @@ def readConfig(file, *, verbose=True, logstreams=None, readContributions=True):
     p.setSocialSecurity(ssecAmounts, ssecAges)
     pensionAmounts = np.array(diconf['Fixed Income']['Pension amounts'], dtype=np.float32)
     pensionAges = np.array(diconf['Fixed Income']['Pension ages'], dtype=np.int32)
-    p.setPension(pensionAmounts, pensionAges)
+    pensionIndexed = diconf['Fixed Income']['Pension indexed']
+    p.setPension(pensionAmounts, pensionAges, pensionIndexed)
 
     # Rate Selection.
     p.setDividendRate(float(diconf['Rate Selection']['Dividend tax rate']))

owlplanner/plan.py

@@ -286,6 +286,7 @@ class Plan(object):
         self.zeta_in = np.zeros((self.N_i, self.N_n))
         self.pensionAmounts = np.zeros(self.N_i)
         self.pensionAges = 65 * np.ones(self.N_i, dtype=np.int32)
+        self.pensionIndexed = [False, False]
         self.ssecAmounts = np.zeros(self.N_i)
         self.ssecAges = 67 * np.ones(self.N_i, dtype=np.int32)
 
@@ -481,13 +482,14 @@ class Plan(object):
         self.nu = nu
         self.caseStatus = 'modified'
 
-    def setPension(self, amounts, ages, units='k'):
+    def setPension(self, amounts, ages, indexed=[False, False], units='k'):
         """
         Set value of pension for each individual and commencement age.
         Units are in $k, unless specified otherwise: 'k', 'M', or '1'.
         """
         assert len(amounts) == self.N_i, 'Amounts must have %d entries.' % self.N_i
         assert len(ages) == self.N_i, 'Ages must have %d entries.' % self.N_i
+        assert len(indexed) >= self.N_i, 'Indexed list must have at least %d entries.' % self.N_i
 
         fac = u.getUnits(units)
         amounts = u.rescale(amounts, fac)
@@ -508,7 +510,9 @@ class Plan(object):
 
         self.pensionAmounts = np.array(amounts)
         self.pensionAges = np.array(ages, dtype=np.int32)
+        self.pensionIndexed = indexed
         self.caseStatus = 'modified'
+        self._adjustedParameters = False
 
     def setSocialSecurity(self, amounts, ages, units='k'):
         """
@@ -1001,6 +1005,10 @@ class Plan(object):
             self.zetaBar_in = self.zeta_in * self.gamma_n[:-1]
             self.sigmaBar_n = self.sigma_n * self.gamma_n[:-1]
             self.xiBar_n = self.xi_n * self.gamma_n[:-1]
+            self.piBar_in = self.pi_in
+            for i in range(self.N_i):
+                if self.pensionIndexed[i]:
+                    self.piBar_in[i] *= self.gamma_n[:-1]
 
             self._adjustedParameters = True
 
@@ -1269,7 +1277,7 @@ class Plan(object):
                 rhs += (
                     self.omega_in[i, n]
                     + self.zetaBar_in[i, n]
-                    + self.pi_in[i, n]
+                    + self.piBar_in[i, n]
                     + self.Lambda_in[i, n]
                     - 0.5 * fac * self.mu * self.kappa_ijn[i, 0, n]
                 )
@@ -1299,7 +1307,7 @@ class Plan(object):
             row = A.newRow()
             row.addElem(_q1(Ce, n, Nn), 1)
             for i in range(Ni):
-                rhs += self.omega_in[i, n] + 0.85 * self.zetaBar_in[i, n] + self.pi_in[i, n]
+                rhs += self.omega_in[i, n] + 0.85 * self.zetaBar_in[i, n] + self.piBar_in[i, n]
                 # Taxable income from tax-deferred withdrawals.
                 row.addElem(_q3(Cw, i, 1, n, Ni, Nj, Nn), -1)
                 row.addElem(_q2(Cx, i, n, Ni, Nn), -1)
@@ -2000,7 +2008,7 @@ class Plan(object):
         sources = {}
         sources['wages'] = self.omega_in
         sources['ssec'] = self.zetaBar_in
-        sources['pension'] = self.pi_in
+        sources['pension'] = self.piBar_in
         sources['txbl acc wdrwl'] = self.w_ijn[:, 0, :]
         sources['RMD'] = self.rmd_in
         sources['+dist'] = self.dist_in
@@ -2706,7 +2714,7 @@ class Plan(object):
         cashFlowDic = {
             'net spending': self.g_n,
             'all wages': np.sum(self.omega_in, axis=0),
-            'all pensions': np.sum(self.pi_in, axis=0),
+            'all pensions': np.sum(self.piBar_in, axis=0),
             'all soc sec': np.sum(self.zetaBar_in, axis=0),
             "all BTI's": np.sum(self.Lambda_in, axis=0),
             'all wdrwls': np.sum(self.w_ijn, axis=(0, 1)),

owlplanner/version.py

@@ -1 +1 @@
-__version__ = "2025.02.06"
+__version__ = "2025.02.08"

{owlplanner-2025.2.6.dist-info → owlplanner-2025.2.8.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: owlplanner
-Version: 2025.2.6
+Version: 2025.2.8
 Summary: Owl: Retirement planner with great wisdom
 Project-URL: HomePage, https://github.com/mdlacasse/owl
 Project-URL: Repository, https://github.com/mdlacasse/owl

{owlplanner-2025.2.6.dist-info → owlplanner-2025.2.8.dist-info}/RECORD

@@ -1,17 +1,17 @@
 owlplanner/__init__.py,sha256=QqrdT0Qks20osBTg7h0vJHAxpP9lL7DA99xb0nYbtw4,254
 owlplanner/abcapi.py,sha256=eemIsdbtzdWCIj5VuuswgphxXMcxJ_GZfUlDi6lttFM,6658
-owlplanner/config.py,sha256=ouADb6YES5Zgv0UwnEK9Axwvs8drp-ahboQjI4WTrr0,12069
+owlplanner/config.py,sha256=1gofMnUUyOy4KXSWSPEij5yUKjvPu6kiPXcS_Nii4Rg,12220
 owlplanner/logging.py,sha256=pXg_mMgBll-kklqaDRLDNVUFo-5DAa-yqTKtiVrhNWw,2530
-owlplanner/plan.py,sha256=YwoL__VZMvMw68CXv7r2STv5E5h4X2sJNsBvF7pY4o0,113811
+owlplanner/plan.py,sha256=UBmOPVfpHPUZUo8Th6sROwTsCUi6PBuv11TD2x3XK70,114255
 owlplanner/progress.py,sha256=YZjL5_m4MMgKPlWlhhKacPLt54tVhVGF1eXxxZapMYs,386
 owlplanner/rates.py,sha256=aKOmau8i3uqxZGi7HQJpzooT3X-yAZhga5MZJ56pBzk,15627
 owlplanner/tax2025.py,sha256=b2RgM6TBQa8ggo6ODyh0p_J7j79UUm8z5NiENqa1l_k,7016
 owlplanner/timelists.py,sha256=WwymsYAGWcrEzMtc-wrLbn1EVA2fhqXGN4NHLJsH3Fs,4110
 owlplanner/utils.py,sha256=adIwqGVQFfvekke0JCxYJD3PKHbptVCj3NrQT2TQIB4,2351
-owlplanner/version.py,sha256=OeB3AdF6hfNV0DmgfMQqEkdZFvxVGsng1sOxEcAPIvU,28
+owlplanner/version.py,sha256=Voi7cBnkUuxoqJIUjmHB47rz-PDQTzK8NO_H0JraUMA,28
 owlplanner/data/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 owlplanner/data/rates.csv,sha256=6fxg56BVVORrj9wJlUGFdGXKvOX5r7CSca8uhUbbuIU,3734
-owlplanner-2025.2.6.dist-info/METADATA,sha256=IZrzEziUXuCTbdjt9eOsL0-N0PdRtSJl7Y0_cq3evUE,63946
-owlplanner-2025.2.6.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-owlplanner-2025.2.6.dist-info/licenses/LICENSE,sha256=IwGE9guuL-ryRPEKi6wFPI_zOhg7zDZbTYuHbSt_SAk,35823
-owlplanner-2025.2.6.dist-info/RECORD,,
+owlplanner-2025.2.8.dist-info/METADATA,sha256=c8WdLd8PAtMZtmRULpn-Q3BrV7edwrnpXCsRrbLbiz8,63946
+owlplanner-2025.2.8.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+owlplanner-2025.2.8.dist-info/licenses/LICENSE,sha256=IwGE9guuL-ryRPEKi6wFPI_zOhg7zDZbTYuHbSt_SAk,35823
+owlplanner-2025.2.8.dist-info/RECORD,,