owlplanner 2025.2.6__tar.gz → 2025.2.8__tar.gz

{owlplanner-2025.2.6 → owlplanner-2025.2.8}/PKG-INFO

@@ -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 → owlplanner-2025.2.8}/examples/case_jack+jill.toml

@@ -20,6 +20,7 @@ Names = [ "Jack", "Jill",]
 ["Fixed Income"]
 "Pension amounts" = [ 0.0, 10.5,]
 "Pension ages" = [ 65, 65,]
+"Pension indexed" = [ false, false,]
 "Social security amounts" = [ 28.4, 19.7,]
 "Social security ages" = [ 70, 62,]
 

{owlplanner-2025.2.6 → owlplanner-2025.2.8}/examples/case_joe.toml

@@ -18,6 +18,7 @@ Names = [ "Joe",]
 ["Fixed Income"]
 "Pension amounts" = [ 18.0,]
 "Pension ages" = [ 65,]
+"Pension indexed" = [ true,]
 "Social security amounts" = [ 28.4,]
 "Social security ages" = [ 67,]
 

{owlplanner-2025.2.6 → owlplanner-2025.2.8}/examples/case_john+sally.toml

@@ -20,6 +20,7 @@ Names = [ "John", "Sally",]
 ["Fixed Income"]
 "Pension amounts" = [ 0.0, 0.0,]
 "Pension ages" = [ 65, 65,]
+"Pension indexed" = [ false, false,]
 "Social security amounts" = [ 36.0, 21.6,]
 "Social security ages" = [ 67, 67,]
 

{owlplanner-2025.2.6 → owlplanner-2025.2.8}/examples/case_kim+sam-bequest.toml

@@ -20,6 +20,7 @@ Names = [ "Kim", "Sam",]
 ["Fixed Income"]
 "Pension amounts" = [ 0.0, 0.0,]
 "Pension ages" = [ 65, 65,]
+"Pension indexed" = [ false, false,]
 "Social security amounts" = [ 45.0, 25.0,]
 "Social security ages" = [ 70, 68,]
 

{owlplanner-2025.2.6 → owlplanner-2025.2.8}/examples/case_kim+sam-spending.toml

@@ -20,6 +20,7 @@ Names = [ "Kim", "Sam",]
 ["Fixed Income"]
 "Pension amounts" = [ 0.0, 0.0,]
 "Pension ages" = [ 65, 65,]
+"Pension indexed" = [ false, false,]
 "Social security amounts" = [ 45.0, 25.0,]
 "Social security ages" = [ 70, 68,]
 

{owlplanner-2025.2.6 → owlplanner-2025.2.8}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "owlplanner"
-version = "2025.02.06"
+version = "2025.02.08"
 authors = [
   { name="Martin-D. Lacasse", email="martin.d.lacasse@gmail.com" },
 ]

{owlplanner-2025.2.6 → owlplanner-2025.2.8}/src/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-2025.2.6 → owlplanner-2025.2.8}/src/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-2025.2.8/src/owlplanner/version.py

@@ -0,0 +1 @@
+__version__ = "2025.02.08"

{owlplanner-2025.2.6 → owlplanner-2025.2.8}/tests/test_toml_cases.py

@@ -2,6 +2,18 @@
 import owlplanner as owl
 
 
+def getWac(exdir, base):
+    import os
+    wac = base.replace('case_', '')
+    wac = wac.replace('-spending', '')
+    wac = wac.replace('-bequest', '')
+    wac = exdir + wac + '.xlsx'
+    if os.path.exists(wac):
+        return wac
+    else:
+        return ''
+
+
 def test_allcases():
     exdir = './examples/'
     for case in ['case_john+sally',
@@ -10,6 +22,9 @@ def test_allcases():
                  'case_kim+sam-spending',
                  'case_kim+sam-bequest']:
         p = owl.readConfig(exdir + case)
+        wac = getWac(exdir, case)
+        if wac != '':
+            p.readContributions(wac)
         p.resolve()
 
 
@@ -17,6 +32,9 @@ def test_historical():
     exdir = './examples/'
     case = 'case_jack+jill'
     p = owl.readConfig(exdir + case)
+    wac = getWac(exdir, case)
+    if wac != '':
+        p.readContributions(wac)
     options = p.solverOptions
     objective = p.objective
     p.runHistoricalRange(objective, options, 1969, 2023)
@@ -26,6 +44,9 @@ def test_MC():
     exdir = './examples/'
     case = 'case_jack+jill'
     p = owl.readConfig(exdir + case)
+    wac = getWac(exdir, case)
+    if wac != '':
+        p.readContributions(wac)
     options = p.solverOptions
     objective = p.objective
     p.runMC(objective, options, 20)

{owlplanner-2025.2.6 → owlplanner-2025.2.8}/ui/Asset_Allocation.py

@@ -5,7 +5,7 @@ import owlbridge as owb
 
 
 def getPercentInput(i, j, keybase, text, defval=0):
-    nkey = keybase+str(j)+'_'+str(i)
+    nkey = f"{keybase}{j}_{i}"
     kz.initKey(nkey, defval)
     st.number_input(text, min_value=0, step=1, max_value=100,
                     value=kz.getKey(nkey),
@@ -14,7 +14,7 @@ def getPercentInput(i, j, keybase, text, defval=0):
 
 ACC = ['taxable', 'tax-deferred', 'tax-free']
 ASSET = ['S&P 500', 'Corp Bonds Baa', 'T-Notes', 'Cash Assets']
-DEF = [60, 20, 10, 10]
+DEFALLOC = [60, 20, 10, 10]
 
 
 def getIndividualAllocs(i, title, deco):
@@ -24,25 +24,25 @@ def getIndividualAllocs(i, title, deco):
     cols = st.columns(4, gap='large', vertical_alignment='top')
     for k1 in range(4):
         with cols[k1]:
-            getPercentInput(i, k1, mydeco, ASSET[k1], DEF[k1])
+            getPercentInput(i, k1, mydeco, ASSET[k1], DEFALLOC[k1])
     checkIndividualAllocs(i, mydeco)
 
 
 def getAccountAllocs(i, j, title, deco):
     iname = kz.getKey('iname'+str(i))
-    mydeco = f'j{j}_' + deco
+    mydeco = f"j{j}_" + deco
     st.write("###### %s's %s allocation for %s account (%%)" % (iname, title, ACC[j]))
     cols = st.columns(4, gap='large', vertical_alignment='top')
     for k1 in range(4):
         with cols[k1]:
-            getPercentInput(i, k1, mydeco, ASSET[k1], DEF[k1])
+            getPercentInput(i, k1, mydeco, ASSET[k1], DEFALLOC[k1])
     checkAccountAllocs(i, mydeco)
 
 
 def checkAccountAllocs(i, deco):
     tot = 0
     for k1 in range(4):
-        tot += int(kz.getKey(deco+str(k1)+'_'+str(i)))
+        tot += int(kz.getKey(f"{deco}{k1}_{i}"))
     if abs(100-tot) > 0:
         st.error('Percentages must add to 100%.')
         return False
@@ -52,7 +52,7 @@ def checkAccountAllocs(i, deco):
 def checkIndividualAllocs(i, deco):
     tot = 0
     for k1 in range(4):
-        tot += int(kz.getKey(deco+str(k1)+'_'+str(i)))
+        tot += int(kz.getKey(f"{deco}{k1}_{i}"))
     if abs(100-tot) > 0:
         st.error('Percentages must add to 100%.')
         return False

{owlplanner-2025.2.6 → owlplanner-2025.2.8}/ui/Fixed_Income.py

@@ -3,24 +3,31 @@ import streamlit as st
 import sskeys as kz
 
 
-def getIntInput(i, key, text, defval=0):
+def getIntInput(i, key, thing, defval=0):
     nkey = key+str(i)
     kz.initKey(nkey, defval)
     inamex = kz.getKey('iname'+str(i))
-    st.number_input("%s's %s" % (inamex, text), min_value=0,
+    st.number_input(f"{inamex}'s {thing}", min_value=0,
                     value=kz.getKey(nkey),
                     on_change=kz.setpull, args=[nkey], key='_'+nkey)
 
 
-def getFloatInput(i, key, text, defval=0.):
+def getFloatInput(i, key, thing, defval=0.):
     nkey = key+str(i)
     kz.initKey(nkey, defval)
     inamex = kz.getKey('iname'+str(i))
-    st.number_input("%s's %s" % (inamex, text), min_value=0., help=kz.help1000,
+    st.number_input(f"{inamex}'s {thing}", min_value=0., help=kz.help1000,
                     value=float(kz.getKey(nkey)), format='%.1f', step=10.,
                     on_change=kz.setpull, args=[nkey], key='_'+nkey)
 
 
+def getToggleInput(i, key, thing):
+    nkey = key+str(i)
+    kz.initKey(nkey, False)
+    defval = kz.getKey(nkey)
+    st.toggle(thing, on_change=kz.setpull, value=defval, args=[nkey], key='_'+nkey)
+
+
 ret = kz.titleBar('fixed')
 kz.caseHeader("Fixed Income")
 
@@ -44,8 +51,10 @@ else:
     with col1:
         getFloatInput(0, 'pAmt', 'pension annual amount (\\$k)')
         getIntInput(0, 'pAge', 'pension age', 65)
+        getToggleInput(0, 'pIdx', 'Inflafion adjusted')
 
     with col2:
         if kz.getKey('status') == 'married':
             getFloatInput(1, 'pAmt', 'pension annual amount (\\$k)')
             getIntInput(1, 'pAge', 'pension age', 65)
+            getToggleInput(1, 'pIdx', 'Inflafion adjusted')

{owlplanner-2025.2.6 → owlplanner-2025.2.8}/ui/owlbridge.py

@@ -69,14 +69,14 @@ def prepareRun(plan):
         st.error('Setting account balances failed: %s' % e)
         return
 
-    amounts, ages = kz.getFixedIncome(ni, 'p')
+    amounts, ages, indexed = kz.getFixedIncome(ni, 'p')
     try:
-        plan.setPension(amounts, ages)
+        plan.setPension(amounts, ages, indexed)
     except Exception as e:
         st.error('Failed setting pensions: %s' % e)
         return
 
-    amounts, ages = kz.getFixedIncome(ni, 'ss')
+    amounts, ages, indexed = kz.getFixedIncome(ni, 'ss')
     try:
         plan.setSocialSecurity(amounts, ages)
     except Exception as e:
@@ -597,19 +597,20 @@ def genDic(plan):
         dic['ssAmt'+str(i)] = plan.ssecAmounts[i]/1000
         dic['pAge'+str(i)] = plan.pensionAges[i]
         dic['pAmt'+str(i)] = plan.pensionAmounts[i]/1000
+        dic['pIdx'+str(i)] = plan.pensionIndexed[i]
         for j1 in range(plan.N_j):
             dic[accName[j1]+str(i)] = plan.beta_ij[i, j1]/1000
 
         if plan.ARCoord == 'individual':
             for k1 in range(plan.N_k):
-                dic['j3_init%'+str(k1)+'_'+str(i)] = int(plan.boundsAR['generic'][i][0][k1])
-                dic['j3_fin%'+str(k1)+'_'+str(i)] = int(plan.boundsAR['generic'][i][1][k1])
+                dic[f"j3_init%{k1}_{i}"] = int(plan.boundsAR['generic'][i][0][k1])
+                dic[f"j3_fin%{k1}_{i}"] = int(plan.boundsAR['generic'][i][1][k1])
         elif plan.ARCoord == 'account':
             longAccName = ['taxable', 'tax-deferred', 'tax-free']
             for j2 in range(3):
                 for k2 in range(plan.N_k):
-                    dic[f'j{j2}%d_init%'+str(k2)+'_'+str(i)] = int(plan.boundsAR[longAccName[j2]][i][0][k2])
-                    dic[f'j{j2}_fin%'+str(k2)+'_'+str(i)] = int(plan.boundsAR[longAccName[j2]][i][1][k2])
+                    dic[f"j{j2}_init%{k2}_{i}"] = int(plan.boundsAR[longAccName[j2]][i][0][k2])
+                    dic[f"j{j2}_fin%{k2}_{i}"] = int(plan.boundsAR[longAccName[j2]][i][1][k2])
         else:
             st.error("Only 'individual' and 'account' asset allocations are currently supported")
             return None

{owlplanner-2025.2.6 → owlplanner-2025.2.8}/ui/requirements.txt

@@ -7,4 +7,4 @@ scipy
 streamlit
 toml
 # --extra-index-url https://test.pypi.org/simple
-owlplanner >= 2025.02.06
+owlplanner >= 2025.02.08

{owlplanner-2025.2.6 → owlplanner-2025.2.8}/ui/sskeys.py

@@ -339,44 +339,29 @@ def getSolveParameters():
 
 def getIndividualAllocationRatios():
     generic = []
-    initial = []
-    final = []
-    for k1 in range(4):
-        initial.append(int(getKey('j3_init%'+str(k1)+'_0')))
-        final.append(int(getKey('j3_fin%'+str(k1)+'_0')))
-    gen0 = [initial, final]
-    generic = [gen0]
-
-    if getKey('status') == 'married':
+    ni = 2 if getKey('status') == 'married' else 1
+    for i in range(ni):
         initial = []
         final = []
         for k1 in range(4):
-            initial.append(int(getKey('j3_init%'+str(k1)+'_1')))
-            final.append(int(getKey('j3_fin%'+str(k1)+'_1')))
-        gen1 = [initial, final]
-        generic.append(gen1)
+            initial.append(int(getKey(f"j3_init%{k1}_{i}")))
+            final.append(int(getKey(f"j3_fin%{k1}_{i}")))
+        gen = [initial, final]
+        generic.append(gen)
 
     return generic
 
 
 def getAccountAllocationRatios():
     accounts = [[], [], []]
-    for j1 in range(3):
-        initial = []
-        final = []
-        for k1 in range(4):
-            initial.append(int(getKey(f'j{j1}_init%'+str(k1)+'_0')))
-            final.append(int(getKey(f'j{j1}_fin%'+str(k1)+'_0')))
-        tmp = [initial, final]
-        accounts[j1].append(tmp)
-
-    if getKey('status') == 'married':
+    ni = 2 if getKey('status') == 'married' else 1
+    for i in range(ni):
         for j1 in range(3):
             initial = []
             final = []
             for k1 in range(4):
-                initial.append(int(getKey(f'j{j1}_init%'+str(k1)+'_1')))
-                final.append(int(getKey(f'j{j1}_fin%'+str(k1)+'_1')))
+                initial.append(int(getKey(f"j{j1}_init%{k1}_{i}")))
+                final.append(int(getKey(f"j{j1}_fin%{k1}_{i}")))
             tmp = [initial, final]
             accounts[j1].append(tmp)
 
@@ -396,11 +381,14 @@ def getPreviousMAGIs():
 def getFixedIncome(ni, what):
     amounts = []
     ages = []
+    indexed = []
     for i in range(ni):
         amounts.append(getKey(what+'Amt'+str(i)))
         ages.append(getKey(what+'Age'+str(i)))
+        if what == 'p':
+            indexed.append(getKey(what+'Idx'+str(i)))
 
-    return amounts, ages
+    return amounts, ages, indexed
 
 
 def getIntNum(text, nkey, disabled=False, callback=setpull, step=1, help=None, min_value=0, max_value=None):

owlplanner-2025.2.6/src/owlplanner/version.py

@@ -1 +0,0 @@
-__version__ = "2025.02.06"