owlplanner 2025.1.29__py3-none-any.whl → 2025.2.1__py3-none-any.whl

owlplanner/plan.py

@@ -397,16 +397,6 @@ class Plan(object):
 
         return None
 
-    def setPreviousMAGI(self, magi, units='k'):
-        """
-        Set MAGI for two previous years to the plan. Values are in nominal $k.
-        """
-        assert len(magi) == 2, "MAGI must have two values."
-        fac = u.getUnits(units)
-        u.rescale(magi, fac)
-        self.mylog.vprint('Setting previous years MAGI to:', [u.d(magi[i]) for i in range(2)])
-        self.prevMAGI = np.array(magi)
-
     def rename(self, newname):
         """
         Override name of the plan. Plan name is used
@@ -869,12 +859,12 @@ class Plan(object):
 
                 'year',
                 'anticipated wages',
-                'ctrb taxable',
-                'ctrb 401k',
-                'ctrb Roth 401k',
-                'ctrb IRA',
-                'ctrb Roth IRA',
-                'Roth X',
+                'taxable ctrb',
+                '401k ctrb',
+                'Roth 401k ctrb',
+                'IRA ctrb',
+                'Roth IRA ctrb',
+                'Roth conv',
                 'big-ticket items'
 
         in any order. A template is provided as an example.
@@ -900,12 +890,12 @@ class Plan(object):
         for i, iname in enumerate(self.inames):
             h = self.horizons[i]
             self.omega_in[i, :h] = self.timeLists[iname]['anticipated wages'].iloc[:h]
-            self.kappa_ijn[i, 0, :h] = self.timeLists[iname]['ctrb taxable'].iloc[:h]
-            self.kappa_ijn[i, 1, :h] = self.timeLists[iname]['ctrb 401k'].iloc[:h]
-            self.kappa_ijn[i, 2, :h] = self.timeLists[iname]['ctrb Roth 401k'].iloc[:h]
-            self.kappa_ijn[i, 1, :h] += self.timeLists[iname]['ctrb IRA'].iloc[:h]
-            self.kappa_ijn[i, 2, :h] += self.timeLists[iname]['ctrb Roth IRA'].iloc[:h]
-            self.myRothX_in[i, :h] = self.timeLists[iname]['Roth X'].iloc[:h]
+            self.kappa_ijn[i, 0, :h] = self.timeLists[iname]['taxable ctrb'].iloc[:h]
+            self.kappa_ijn[i, 1, :h] = self.timeLists[iname]['401k ctrb'].iloc[:h]
+            self.kappa_ijn[i, 2, :h] = self.timeLists[iname]['Roth 401k ctrb'].iloc[:h]
+            self.kappa_ijn[i, 1, :h] += self.timeLists[iname]['IRA ctrb'].iloc[:h]
+            self.kappa_ijn[i, 2, :h] += self.timeLists[iname]['Roth IRA ctrb'].iloc[:h]
+            self.myRothX_in[i, :h] = self.timeLists[iname]['Roth conv'].iloc[:h]
             self.Lambda_in[i, :h] = self.timeLists[iname]['big-ticket items'].iloc[:h]
 
         #  In 1st year, reduce wages and contribution depending on starting date.
@@ -957,8 +947,8 @@ class Plan(object):
         self.myRothX_in[:, :] = 0.
         self.kappa_ijn[:, :, :] = 0.
 
-        cols = ['year', 'anticipated wages', 'ctrb taxable', 'ctrb 401k',
-                'ctrb Roth 401k', 'ctrb IRA', 'ctrb Roth IRA', 'Roth X', 'big-ticket items']
+        cols = ['year', 'anticipated wages', 'taxable ctrb', '401k ctrb',
+                'Roth 401k ctrb', 'IRA ctrb', 'Roth IRA ctrb', 'Roth conv', 'big-ticket items']
         for i, iname in enumerate(self.inames):
             h = self.horizons[i]
             df = pd.DataFrame(0, index=np.arange(h), columns=cols)
@@ -1619,6 +1609,7 @@ class Plan(object):
             'noRothConversions',
             'withMedicare',
             'solver',
+            'previousMAGIs',
         ]
         # We will modify options if required.
         if options is None:
@@ -1647,6 +1638,17 @@ class Plan(object):
         if objective == 'maxSpending' and 'bequest' not in myoptions:
             self.mylog.vprint('Using bequest of $1.')
 
+        if 'previousMAGIs' in myoptions:
+            magi = myoptions['previousMAGIs']
+            if len(magi) != 2:
+                raise ValueError("previousMAGIs must have two values.")
+
+            if 'units' in options:
+                units = u.getUnits(options['units'])
+            else:
+                units = 1000
+            self.prevMAGI = units * np.array(magi)
+
         self._adjustParameters()
 
         if 'solver' in options:
@@ -1991,8 +1993,8 @@ class Plan(object):
             'wages',
             'ssec',
             'pension',
-            'dist',
-            'rmd',
+            '+dist',
+            'RMD',
             'RothX',
             'wdrwl taxable',
             'wdrwl tax-free',
@@ -2002,12 +2004,12 @@ class Plan(object):
         sources['wages'] = self.omega_in
         sources['ssec'] = self.zetaBar_in
         sources['pension'] = self.pi_in
-        sources['wdrwl taxable'] = self.w_ijn[:, 0, :]
-        sources['rmd'] = self.rmd_in
-        sources['dist'] = self.dist_in
+        sources['taxable wdrwl'] = self.w_ijn[:, 0, :]
+        sources['RMD'] = self.rmd_in
+        sources['+dist'] = self.dist_in
         sources['RothX'] = self.x_in
-        sources['wdrwl tax-free'] = self.w_ijn[:, 2, :]
-        sources['bti'] = self.Lambda_in
+        sources['tax-free wdrwl'] = self.w_ijn[:, 2, :]
+        sources['BTI'] = self.Lambda_in
 
         savings = {}
         savings['taxable'] = self.b_ijn[:, 0, :]
@@ -2717,7 +2719,7 @@ class Plan(object):
             'all wages': np.sum(self.omega_in, axis=0),
             'all pensions': np.sum(self.pi_in, axis=0),
             'all soc sec': np.sum(self.zetaBar_in, axis=0),
-            "all bti's": np.sum(self.Lambda_in, axis=0),
+            "all BTI's": np.sum(self.Lambda_in, axis=0),
             'all wdrwls': np.sum(self.w_ijn, axis=(0, 1)),
             'all deposits': -np.sum(self.d_in, axis=0),
             'ord taxes': -self.T_n,
@@ -2733,12 +2735,12 @@ class Plan(object):
             'wages': self.sources_in['wages'],
             'social sec': self.sources_in['ssec'],
             'pension': self.sources_in['pension'],
-            'txbl acc wdrwl': self.sources_in['wdrwl taxable'],
-            'RMDs': self.sources_in['rmd'],
-            '+distributions': self.sources_in['dist'],
-            'Roth conversion': self.sources_in['RothX'],
-            'tax-free wdrwl': self.sources_in['wdrwl tax-free'],
-            'big-ticket items': self.sources_in['bti'],
+            'txbl acc wdrwl': self.sources_in['txbl acc wdrwl'],
+            'RMDs': self.sources_in['RMD'],
+            '+distributions': self.sources_in['+dist'],
+            'Roth conv': self.sources_in['RothX'],
+            'tax-free wdrwl': self.sources_in['tax-free wdrwl'],
+            'big-ticket items': self.sources_in['BTI'],
         }
 
         for i in range(self.N_i):
@@ -2749,13 +2751,14 @@ class Plan(object):
         # Account balances except final year.
         accDic = {
             'taxable bal': self.b_ijn[:, 0, :-1],
+            'taxable ctrb': self.kappa_ijn[:, 0, :],
             'taxable dep': self.d_in,
             'taxable wdrwl': self.w_ijn[:, 0, :],
             'tax-deferred bal': self.b_ijn[:, 1, :-1],
             'tax-deferred ctrb': self.kappa_ijn[:, 1, :],
             'tax-deferred wdrwl': self.w_ijn[:, 1, :],
             '(included RMDs)': self.rmd_in[:, :],
-            'Roth conversion': self.x_in,
+            'Roth conv': self.x_in,
             'tax-free bal': self.b_ijn[:, 2, :-1],
             'tax-free ctrb': self.kappa_ijn[:, 2, :],
             'tax-free wdrwl': self.w_ijn[:, 2, :],
@@ -2854,7 +2857,7 @@ class Plan(object):
             planData[self.inames[i] + ' tx-def ctrb'] = self.kappa_ijn[i, 1, :]
             planData[self.inames[i] + ' tx-def wdrl'] = self.w_ijn[i, 1, :]
             planData[self.inames[i] + ' (RMD)'] = self.rmd_in[i, :]
-            planData[self.inames[i] + ' Roth conversion'] = self.x_in[i, :]
+            planData[self.inames[i] + ' Roth conv'] = self.x_in[i, :]
             planData[self.inames[i] + ' tx-free bal'] = self.b_ijn[i, 2, :-1]
             planData[self.inames[i] + ' tx-free ctrb'] = self.kappa_ijn[i, 2, :]
             planData[self.inames[i] + ' tax-free wdrwl'] = self.w_ijn[i, 2, :]

owlplanner/timelists.py

@@ -23,12 +23,12 @@ import pandas as pd
 timeHorizonItems = [
     'year',
     'anticipated wages',
-    'ctrb taxable',
-    'ctrb 401k',
-    'ctrb Roth 401k',
-    'ctrb IRA',
-    'ctrb Roth IRA',
-    'Roth X',
+    'taxable ctrb',
+    '401k ctrb',
+    'Roth 401k ctrb',
+    'IRA ctrb',
+    'Roth IRA ctrb',
+    'Roth conv',
     'big-ticket items',
 ]
 
@@ -38,8 +38,8 @@ def read(finput, inames, horizons, mylog):
     Read listed parameters from an excel spreadsheet or through
     a dictionary of dataframes through Pandas.
     Use one sheet for each individual with the following 9 columns:
-    year, anticipated wages, ctrb taxable, ctrb 401k, ctrb Roth 401k,
-    ctrb IRA, ctrb Roth IRA, Roth X, and big-ticket items.
+    year, anticipated wages, taxable ctrb, 401k ctrb, Roth 401k ctrb,
+    IRA ctrb, Roth IRA ctrb, Roth conv, and big-ticket items.
     Supports xls, xlsx, xlsm, xlsb, odf, ods, and odt file extensions.
     Returs a dictionary of dataframes by individual's names.
     """

owlplanner/version.py

@@ -1 +1 @@
-__version__ = "2025.1.29"
+__version__ = "2025.02.01"

{owlplanner-2025.1.29.dist-info → owlplanner-2025.2.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: owlplanner
-Version: 2025.1.29
+Version: 2025.2.1
 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.1.29.dist-info → owlplanner-2025.2.1.dist-info}/RECORD

@@ -2,16 +2,16 @@ owlplanner/__init__.py,sha256=QqrdT0Qks20osBTg7h0vJHAxpP9lL7DA99xb0nYbtw4,254
 owlplanner/abcapi.py,sha256=eemIsdbtzdWCIj5VuuswgphxXMcxJ_GZfUlDi6lttFM,6658
 owlplanner/config.py,sha256=ouADb6YES5Zgv0UwnEK9Axwvs8drp-ahboQjI4WTrr0,12069
 owlplanner/logging.py,sha256=pXg_mMgBll-kklqaDRLDNVUFo-5DAa-yqTKtiVrhNWw,2530
-owlplanner/plan.py,sha256=4Kuulsp3uUAt9w0sLKPPGPry2tPnY74SMNSOTcVIs40,115575
+owlplanner/plan.py,sha256=kVuv7OfnLnoTxO6LZgRY56Np-yWifGNg_vtlB8R_jZQ,115626
 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=ifxbyMlRW3IMwsiu8zsoodA1CKJQthgk3iPq50vQIds,4104
+owlplanner/timelists.py,sha256=WwymsYAGWcrEzMtc-wrLbn1EVA2fhqXGN4NHLJsH3Fs,4110
 owlplanner/utils.py,sha256=adIwqGVQFfvekke0JCxYJD3PKHbptVCj3NrQT2TQIB4,2351
-owlplanner/version.py,sha256=31a542RcfLaOTSP2qZRfQPdngqGSa6FlROIHXM1qDdc,27
+owlplanner/version.py,sha256=0gSeVv3M2dXUJh4tEDh_HPMJgzKSY9PHw3rX05-ggH8,28
 owlplanner/data/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 owlplanner/data/rates.csv,sha256=6fxg56BVVORrj9wJlUGFdGXKvOX5r7CSca8uhUbbuIU,3734
-owlplanner-2025.1.29.dist-info/METADATA,sha256=EreFCtwuHeBO7xbqqQrLBET1Gdy5e-o9VsOeMvLN_rQ,64515
-owlplanner-2025.1.29.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-owlplanner-2025.1.29.dist-info/licenses/LICENSE,sha256=IwGE9guuL-ryRPEKi6wFPI_zOhg7zDZbTYuHbSt_SAk,35823
-owlplanner-2025.1.29.dist-info/RECORD,,
+owlplanner-2025.2.1.dist-info/METADATA,sha256=FUY7f2ri_UxQlUMZDllEohMHAVge-wmCp5bhnpi-gkA,64514
+owlplanner-2025.2.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+owlplanner-2025.2.1.dist-info/licenses/LICENSE,sha256=IwGE9guuL-ryRPEKi6wFPI_zOhg7zDZbTYuHbSt_SAk,35823
+owlplanner-2025.2.1.dist-info/RECORD,,