owlplanner 2025.2.4__py3-none-any.whl → 2025.2.5__py3-none-any.whl

owlplanner/plan.py

@@ -1413,11 +1413,11 @@ class Plan(object):
 
         progcall.finish()
         self.mylog.resetVerbose()
-        fig, summary = self._showResults(objective, df, N, figure)
-        self.mylog.print(summary.getvalue())
+        fig, description = self._showResults(objective, df, N, figure)
+        self.mylog.print(description.getvalue())
 
         if figure:
-            return fig, summary.getvalue()
+            return fig, description.getvalue()
 
         return N, df
 
@@ -1469,11 +1469,11 @@ class Plan(object):
 
         progcall.finish()
         self.mylog.resetVerbose()
-        fig, summary = self._showResults(objective, df, N, figure)
-        self.mylog.print(summary.getvalue())
+        fig, description = self._showResults(objective, df, N, figure)
+        self.mylog.print(description.getvalue())
 
         if figure:
-            return fig, summary.getvalue()
+            return fig, description.getvalue()
 
         return N, df
 
@@ -1483,9 +1483,9 @@ class Plan(object):
         """
         import seaborn as sbn
 
-        summary = io.StringIO()
+        description = io.StringIO()
 
-        print('Success rate: %s on %d samples.' % (u.pc(len(df) / N), N), file=summary)
+        print('Success rate: %s on %d samples.' % (u.pc(len(df) / N), N), file=description)
         title = '$N$ = %d, $P$ = %s' % (N, u.pc(len(df) / N))
         means = df.mean(axis=0, numeric_only=True)
         medians = df.median(axis=0, numeric_only=True)
@@ -1498,7 +1498,7 @@ class Plan(object):
         # or if solution led to empty accounts at the end of first spouse's life.
         if np.all(self.phi_j == 1) or medians.iloc[0] < 1:
             if medians.iloc[0] < 1:
-                print('Optimized solutions all have null partial bequest in year %d.' % my[0], file=summary)
+                print('Optimized solutions all have null partial bequest in year %d.' % my[0], file=description)
             df.drop('partial', axis=1, inplace=True)
             means = df.mean(axis=0, numeric_only=True)
             medians = df.median(axis=0, numeric_only=True)
@@ -1550,16 +1550,16 @@ class Plan(object):
             # plt.show()
 
         for q in range(len(means)):
-            print('%12s: Median (%d $): %s' % (leads[q], self.year_n[0], u.d(medians.iloc[q])), file=summary)
-            print('%12s:   Mean (%d $): %s' % (leads[q], self.year_n[0], u.d(means.iloc[q])), file=summary)
+            print('%12s: Median (%d $): %s' % (leads[q], self.year_n[0], u.d(medians.iloc[q])), file=description)
+            print('%12s:   Mean (%d $): %s' % (leads[q], self.year_n[0], u.d(means.iloc[q])), file=description)
             print(
                 '%12s:           Range: %s - %s'
                 % (leads[q], u.d(1000 * df.iloc[:, q].min()), u.d(1000 * df.iloc[:, q].max())),
-                file=summary)
+                file=description)
             nzeros = len(df.iloc[:, q][df.iloc[:, q] < 0.001])
-            print('%12s:  N zero solns: %d' % (leads[q], nzeros), file=summary)
+            print('%12s:  N zero solns: %d' % (leads[q], nzeros), file=description)
 
-        return fig, summary
+        return fig, description
 
     def resolve(self):
         """
@@ -2038,141 +2038,133 @@ class Plan(object):
     @_checkCaseStatus
     def summary(self):
         """
-        Print summary of values.
+        Print summary in logs.
         """
         self.mylog.print('SUMMARY ================================================================')
-        lines = self.summaryList()
-        for line in lines:
-            self.mylog.print(line)
+        dic = self.summaryDic()
+        for key, value in dic.items():
+            self.mylog.print(f"{key}: {value}")
         self.mylog.print('------------------------------------------------------------------------')
 
         return None
 
+    def summaryList(self):
+        """
+        Return summary as a list.
+        """
+        mylist = []
+        dic = self.summaryDic()
+        for key, value in dic.items():
+            mylist.append(f"{key}: {value}")
+
+        return mylist
+
     def summaryString(self):
         """
-        Print summary of values in a string.
+        Return summary as a string.
         """
-        string = ''
-        lines = self.summaryList()
-        for line in lines:
-            string += line + '\n'
+        string = 'Synopsis\n'
+        dic = self.summaryDic()
+        for key, value in dic.items():
+            string += f"{key:>70}: {value}\n"
+            # string += "%60s: %s\n" % (key, value)
 
         return string
 
-    def summaryList(self):
+    def summaryDic(self):
         """
-        Return string with summary of values.
+        Return dictionary containing summary of values.
         """
         now = self.year_n[0]
-        lines = []
-        lines.append('Plan name: %s' % self._name)
-        for i in range(self.N_i):
-            lines.append("%12s's %02d-year life horizon: %d -> %d"
-                         % (self.inames[i], self.horizons[i], now, now + self.horizons[i] - 1))
-        lines.append('Contributions file: %s' % self.timeListsFileName)
-        lines.append('Initial balances [taxable, tax-deferred, tax-free]:')
-        for i in range(self.N_i):
-            lines.append("%12s's accounts: %s" % (self.inames[i], [u.d(self.beta_ij[i][j]) for j in range(self.N_j)]))
-
-        lines.append('Return rates: %s' % self.rateMethod)
-        if self.rateMethod in ['historical', 'historical average', 'histochastic']:
-            lines.append('Rates used: from %d to %d' % (self.rateFrm, self.rateTo))
-        elif self.rateMethod == 'stochastic':
-            lines.append(
-                'Mean rates used (%%): %s' % (['{:.1f}'.format(100 * self.rateValues[k]) for k in range(self.N_k)])
-            )
-            lines.append(
-                'Standard deviation used (%%): %s'
-                % (['{:.1f}'.format(100 * self.rateStdev[k]) for k in range(self.N_k)])
-            )
-            lines.append('Correlation matrix used:')
-            lines.append('\t\t' + str(self.rateCorr).replace('\n', '\n\t\t'))
-        else:
-            lines.append('Rates used (%%): %s' % (['{:.1f}'.format(100 * self.rateValues[k]) for k in range(self.N_k)]))
-        lines.append("This year's starting date: %s" % self.startDate)
-        lines.append('Optimized for: %s' % self.objective)
-        lines.append('Solver options: %s' % self.solverOptions)
-        lines.append('Number of decision variables: %d' % self.A.nvars)
-        lines.append('Number of constraints: %d' % self.A.ncons)
-        lines.append('Spending profile: %s' % self.spendingProfile)
-        if self.spendingProfile == 'smile':
-            lines.append('\twith increase: %d%%, dip: %d%%, delay: %dy'
-                         % (self.smileIncrease, self.smileDip, self.smileDelay))
-        if self.N_i == 2:
-            lines.append('Surviving spouse spending needs: %s' % u.pc(self.chi, f=0))
-
-        lines.append('Net yearly spending in year %d: %s' % (now, u.d(self.g_n[0] / self.yearFracLeft)))
-        lines.append('Net spending remaining in year %d: %s' % (now, u.d(self.g_n[0])))
-        lines.append('Net yearly spending profile basis in %d$: %s' % (now, u.d(self.g_n[0] / self.xi_n[0])))
-
-        lines.append('Assumed heirs marginal tax rate: %s' % u.pc(self.nu, f=0))
-
-        if self.N_i == 2 and self.n_d < self.N_n:
-            lines.append("Spousal surplus deposit fraction in %s's taxable account: %s"
-                         % (self.inames[1], self.eta))
-            lines.append('Spousal beneficiary fractions to %s: %s' % (self.inames[self.i_s], self.phi_j.tolist()))
-            p_j = self.partialEstate_j * (1 - self.phi_j)
-            p_j[1] *= 1 - self.nu
-            nx = self.n_d - 1
-            totOthers = np.sum(p_j)
-            totOthersNow = totOthers / self.gamma_n[nx + 1]
-            q_j = self.partialEstate_j * self.phi_j
-            totSpousal = np.sum(q_j)
-            totSpousalNow = totSpousal / self.gamma_n[nx + 1]
-            lines.append('Spousal wealth transfer from %s to %s in year %d (nominal):'
-                         % (self.inames[self.i_d], self.inames[self.i_s], self.year_n[nx]))
-            lines.append('    taxable: %s  tax-def: %s  tax-free: %s' % (u.d(q_j[0]), u.d(q_j[1]), u.d(q_j[2])))
-            lines.append('Sum of spousal bequests to %s in year %d in %d$: %s (%s nominal)'
-                         % (self.inames[self.i_s], self.year_n[nx], now, u.d(totSpousalNow), u.d(totSpousal)))
-            lines.append(
-                'Post-tax non-spousal bequests from %s in year %d (nominal):' % (self.inames[self.i_d], self.year_n[nx])
-            )
-            lines.append('    taxable: %s  tax-def: %s  tax-free: %s' % (u.d(p_j[0]), u.d(p_j[1]), u.d(p_j[2])))
-            lines.append(
-                'Sum of post-tax non-spousal bequests from %s in year %d in %d$: %s (%s nominal)'
-                % (self.inames[self.i_d], self.year_n[nx], now, u.d(totOthersNow), u.d(totOthers))
-            )
+        dic = {}
+        # Results
+        dic[f"Net yearly spending basis in {now}$"] = (u.d(self.g_n[0] / self.xi_n[0]))
+        dic[f"Net yearly spending for year {now}"] = (u.d(self.g_n[0] / self.yearFracLeft))
+        dic[f"Net spending remaining in year {now}"] = u.d(self.g_n[0])
 
         totIncome = np.sum(self.g_n, axis=0)
         totIncomeNow = np.sum(self.g_n / self.gamma_n[:-1], axis=0)
-        lines.append('Total net spending in %d$: %s (%s nominal)' % (now, u.d(totIncomeNow), u.d(totIncome)))
+        dic[f"Total net spending in {now}$"] = (
+            "%s (%s nominal)" % (u.d(totIncomeNow), u.d(totIncome))
+        )
 
         totRoth = np.sum(self.x_in, axis=(0, 1))
         totRothNow = np.sum(np.sum(self.x_in, axis=0) / self.gamma_n[:-1], axis=0)
-        lines.append('Total Roth conversions in %d$: %s (%s nominal)' % (now, u.d(totRothNow), u.d(totRoth)))
+        dic[f"Total Roth conversions in {now}$"] = (
+            "%s (%s nominal)" % (u.d(totRothNow), u.d(totRoth))
+        )
 
         taxPaid = np.sum(self.T_n, axis=0)
         taxPaidNow = np.sum(self.T_n / self.gamma_n[:-1], axis=0)
-        lines.append('Total income tax paid on ordinary income in %d$: %s (%s nominal)'
-                     % (now, u.d(taxPaidNow), u.d(taxPaid)))
+        dic[f"Total income tax paid on ordinary income in {now}$"] = (
+            "%s (%s nominal)" % (u.d(taxPaidNow), u.d(taxPaid))
+        )
 
         taxPaid = np.sum(self.U_n, axis=0)
         taxPaidNow = np.sum(self.U_n / self.gamma_n[:-1], axis=0)
-        lines.append('Total tax paid on gains and dividends in %d$: %s (%s nominal)'
-                     % (now, u.d(taxPaidNow), u.d(taxPaid)))
+        dic[f"Total tax paid on gains and dividends in {now}$"] = (
+            "%s (%s nominal)" % (u.d(taxPaidNow), u.d(taxPaid))
+        )
 
         taxPaid = np.sum(self.M_n, axis=0)
         taxPaidNow = np.sum(self.M_n / self.gamma_n[:-1], axis=0)
-        lines.append('Total Medicare premiums paid in %d$: %s (%s nominal)' % (now, u.d(taxPaidNow), u.d(taxPaid)))
+        dic[f"Total Medicare premiums paid in {now}$"] = (
+            "%s (%s nominal)" % (u.d(taxPaidNow), u.d(taxPaid))
+        )
+
+        if self.N_i == 2 and self.n_d < self.N_n:
+            p_j = self.partialEstate_j * (1 - self.phi_j)
+            p_j[1] *= 1 - self.nu
+            nx = self.n_d - 1
+            totOthers = np.sum(p_j)
+            totOthersNow = totOthers / self.gamma_n[nx + 1]
+            q_j = self.partialEstate_j * self.phi_j
+            totSpousal = np.sum(q_j)
+            totSpousalNow = totSpousal / self.gamma_n[nx + 1]
+            dic["Spousal wealth transfer from %s to %s in year %d (nominal)" %
+                (self.inames[self.i_d], self.inames[self.i_s], self.year_n[nx])] = (
+                "taxable: %s  tax-def: %s  tax-free: %s" % (u.d(q_j[0]), u.d(q_j[1]), u.d(q_j[2]))
+            )
+
+            dic["Sum of spousal bequests to %s in year %d in %d$" %
+                (self.inames[self.i_s], self.year_n[nx], now)] = (
+                "%s (%s nominal)" % (u.d(totSpousalNow), u.d(totSpousal))
+            )
+            dic["Post-tax non-spousal bequests from %s in year %d (nominal)" %
+                (self.inames[self.i_d], self.year_n[nx])] = (
+                "taxable: %s  tax-def: %s  tax-free: %s" % (u.d(p_j[0]), u.d(p_j[1]), u.d(p_j[2]))
+            )
+            dic["Sum of post-tax non-spousal bequests from %s in year %d in %d$" %
+                (self.inames[self.i_d], self.year_n[nx], now)] = (
+               "%s (%s nominal)" % (u.d(totOthersNow), u.d(totOthers))
+            )
 
         estate = np.sum(self.b_ijn[:, :, self.N_n], axis=0)
         estate[1] *= 1 - self.nu
-        lines.append('Post-tax account values at the end of final plan year %d: (nominal)' % self.year_n[-1])
-        lines.append('    taxable: %s  tax-def: %s  tax-free: %s' % (u.d(estate[0]), u.d(estate[1]), u.d(estate[2])))
+        dic["Post-tax account values at the end of final plan year %d (nominal)" % self.year_n[-1]] = (
+            "taxable: %s  tax-def: %s  tax-free: %s" % (u.d(estate[0]), u.d(estate[1]), u.d(estate[2]))
+        )
 
         totEstate = np.sum(estate)
         totEstateNow = totEstate / self.gamma_n[-1]
-        lines.append(
-            'Total estate value at the end of final plan year %d in %d$: %s (%s nominal)'
-            % (self.year_n[-1], now, u.d(totEstateNow), u.d(totEstate))
+        dic["Total estate value at the end of final plan year %d in %d$" % (self.year_n[-1], now)] = (
+            "%s (%s nominal)" % (u.d(totEstateNow), u.d(totEstate))
         )
-        lines.append(
-            "Inflation factor from this year's start date to the end of plan final year: %.2f" % self.gamma_n[-1]
+        dic["Plan starting date"] = str(self.startDate)
+        dic["Cumulative inflation factor from start date to end of plan"] = (
+            "%.2f" % (self.gamma_n[-1])
         )
+        for i in range(self.N_i):
+            dic["%12s's %02d-year life horizon" % (self.inames[i], self.horizons[i])] = (
+                "%d -> %d" % (now, now + self.horizons[i] - 1)
+            )
 
-        lines.append('Case executed on: %s' % self._timestamp)
+        dic["Plan name"] = self._name
+        dic["Number of decision variables"] = str(self.A.nvars)
+        dic["Number of constraints"] = str(self.A.ncons)
+        dic["Case executed on"] = str(self._timestamp)
 
-        return lines
+        return dic
 
     def showRatesCorrelations(self, tag='', shareRange=False, figure=False):
         """

owlplanner/version.py

@@ -1 +1 @@
-__version__ = "2025.02.04"
+__version__ = "2025.02.05"

{owlplanner-2025.2.4.dist-info → owlplanner-2025.2.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: owlplanner
-Version: 2025.2.4
+Version: 2025.2.5
 Summary: Owl: Retirement planner with great wisdom
 Project-URL: HomePage, https://github.com/mdlacasse/owl
 Project-URL: Repository, https://github.com/mdlacasse/owl
@@ -731,7 +731,8 @@ This is exactly where this tool fits it. Given your savings capabilities and spe
 it can generate different future realizations of
 your strategy under different market assumptions, helping to better understand your financial situation.
 
-Disclaimers: I am not a financial planner. You make your own decisions. This program comes with no guarantee. Use at your own risk.
+Disclaimers: I am not a financial planner. You make your own decisions.
+This program comes with no guarantee. Use at your own risk.
 
 More disclaimers: While some output of the code has been verified with other approaches,
 this code is still under development and I cannot guarantee the accuracy of the results.
@@ -975,47 +976,31 @@ The output of the last command reports that if future rates are exactly like tho
 starting from 1969 and the following years, Jack and Jill could afford an annual spending of
  \\$97k starting this year
 (with a basis of \\$88.8k - the basis multiplies the profile which can vary over the course of the plan).
-The summary also contains many more details:
+The summary also contains some details:
 ```
 SUMMARY ================================================================
+Net yearly spending basis in 2025$: $91,812
+Net yearly spending for year 2025: $100,448
+Net spending remaining in year 2025: $100,448
+Total net spending in 2025$: $2,809,453 ($7,757,092 nominal)
+Total Roth conversions in 2025$: $320,639 ($456,454 nominal)
+Total income tax paid on ordinary income in 2025$: $247,788 ($469,522 nominal)
+Total tax paid on gains and dividends in 2025$: $3,313 ($3,768 nominal)
+Total Medicare premiums paid in 2025$: $117,660 ($343,388 nominal)
+Spousal wealth transfer from Jack to Jill in year 2051 (nominal): taxable: $0  tax-def: $57,224  tax-free: $2,102,173
+Sum of spousal bequests to Jill in year 2051 in 2025$: $499,341 ($2,159,397 nominal)
+Post-tax non-spousal bequests from Jack in year 2051 (nominal): taxable: $0  tax-def: $0  tax-free: $0
+Sum of post-tax non-spousal bequests from Jack in year 2051 in 2025$: $0 ($0 nominal)
+Post-tax account values at the end of final plan year 2057 (nominal): taxable: $0  tax-def: $0  tax-free: $2,488,808
+Total estate value at the end of final plan year 2057 in 2025$: $500,000 ($2,488,808 nominal)
+Plan starting date: 01-01
+Cumulative inflation factor from start date to end of plan: 4.98
+        Jack's 27-year life horizon: 2025 -> 2051
+        Jill's 33-year life horizon: 2025 -> 2057
 Plan name: jack & jill - tutorial
-        Jack's life horizon: 2024 -> 2051
-        Jill's life horizon: 2024 -> 2057
-Contributions file: examples/jack+jill.xlsx
-Initial balances [taxable, tax-deferred, tax-free]:
-        Jack's accounts: ['$90,500', '$600,500', '$70,000']
-        Jill's accounts: ['$60,200', '$150,000', '$40,000']
-Return rates: historical
-Rates used: from 1969 to 2002
-This year's starting date: 01-01
-Optimized for: maxSpending
-Solver options: {'maxRothConversion': 100, 'bequest': 500, 'noRothConversions': 'Jill'}
-Number of decision variables: 1026
-Number of constraints: 894
-Spending profile: smile
-Surviving spouse spending needs: 60%
-Net yearly spending in year 2024: $97,098
-Net spending remaining in year 2024: $97,098
-Net yearly spending profile basis in 2024$: $88,763
-Assumed heirs tax rate: 30%
-Spousal surplus deposit fraction: 0.5
-Spousal beneficiary fractions to Jill: [1, 1, 1]
-Spousal wealth transfer from Jack to Jill in year 2051 (nominal):
-    taxable: $0  tax-def: $63,134  tax-free: $2,583,303
-Sum of spousal bequests to Jill in year 2051 in 2024$: $592,103 ($2,646,437 nominal)
-Post-tax non-spousal bequests from Jack in year 2051 (nominal):
-    taxable: $0  tax-def: $0  tax-free: $0
-Sum of post-tax non-spousal bequests from Jack in year 2051 in 2024$: $0 ($0 nominal)
-Total net spending in 2024$: $2,804,910 ($7,916,623 nominal)
-Total Roth conversions in 2024$: $311,760 ($443,005 nominal)
-Total ordinary income tax paid in 2024$: $236,710 ($457,922 nominal)
-Total dividend tax paid in 2024$: $3,437 ($3,902 nominal)
-Total Medicare premiums paid in 2024$: $117,817 ($346,404 nominal)
-Post-tax account values at the end of final plan year 2057: (nominal)
-    taxable: $0  tax-def: $0  tax-free: $2,553,871
-Total estate value at the end of final plan year 2057 in 2024$: $500,000 ($2,553,871 nominal)
-Inflation factor from this year's start date to the end of plan final year: 5.11
-Case executed on: 2024-12-09 at 22:11:57
+Number of decision variables: 996
+Number of constraints: 867
+Case executed on: 2025-02-04 at 22:55:03
 ------------------------------------------------------------------------
 ```
 And an Excel workbook can be saved with all the detailed amounts over the years by using the following command:

{owlplanner-2025.2.4.dist-info → owlplanner-2025.2.5.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=OOWdiHP8JgGDNEGHt8wh0KAVmGKfyJH1N7QKLTUuuN0,115535
+owlplanner/plan.py,sha256=LJwNf6UngC2WepPyvO6zQzx9V0RbsQd2H9LAg5V8Fto,113815
 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=UHxI9fx8sgEBJIv9Rpqya5vi1GQzbbVBQbvZ--mDf5k,28
+owlplanner/version.py,sha256=3SB4x2fk8FWUTRIEqgNzXA2CeRNyNlNPfgW0-yoyV_A,28
 owlplanner/data/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 owlplanner/data/rates.csv,sha256=6fxg56BVVORrj9wJlUGFdGXKvOX5r7CSca8uhUbbuIU,3734
-owlplanner-2025.2.4.dist-info/METADATA,sha256=XevR8g172VU0QlRBahuybzDxucINqhiTLgvuyuMjmYo,64514
-owlplanner-2025.2.4.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-owlplanner-2025.2.4.dist-info/licenses/LICENSE,sha256=IwGE9guuL-ryRPEKi6wFPI_zOhg7zDZbTYuHbSt_SAk,35823
-owlplanner-2025.2.4.dist-info/RECORD,,
+owlplanner-2025.2.5.dist-info/METADATA,sha256=RpUVgZp48DCU53VP6HjcQvojsnaZPsqSaav2jJ0OglA,63946
+owlplanner-2025.2.5.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+owlplanner-2025.2.5.dist-info/licenses/LICENSE,sha256=IwGE9guuL-ryRPEKi6wFPI_zOhg7zDZbTYuHbSt_SAk,35823
+owlplanner-2025.2.5.dist-info/RECORD,,