owlplanner 2025.2.25__py3-none-any.whl → 2025.3.7__py3-none-any.whl

owlplanner/plan.py

@@ -1968,8 +1968,8 @@ class Plan(object):
         self.dist_in = self.w_ijn[:, 1, :] - self.rmd_in
         self.dist_in[self.dist_in < 0] = 0
         self.G_n = np.sum(self.F_tn, axis=0)
-        T_tn = self.F_tn * self.theta_tn
-        self.T_n = np.sum(T_tn, axis=0)
+        self.T_tn = self.F_tn * self.theta_tn
+        self.T_n = np.sum(self.T_tn, axis=0)
 
         tau_0 = np.array(self.tau_kn[0, :])
         tau_0[tau_0 < 0] = 0
@@ -2062,6 +2062,12 @@ class Plan(object):
 
         return mylist
 
+    def summaryDf(self):
+        """
+        Return summary as a dataframe.
+        """
+        return pd.DataFrame(self.summaryDic(), index=[self._name])
+
     def summaryString(self):
         """
         Return summary as a string.
@@ -2081,29 +2087,40 @@ class Plan(object):
         dic = {}
         # Results
         dic["Plan name"] = self._name
-        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["Net yearly spending basis"] = u.d(self.g_n[0] / self.xi_n[0])
+        dic[f"Net 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)
-        dic[f"Total net spending in {now}$"] = f"{u.d(totIncomeNow)} ({u.d(totIncome)} nominal)"
+        dic["Total net spending"] = f"{u.d(totIncomeNow)}"
+        dic["- Total net spending (nominal)"] = f"{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)
-        dic[f"Total Roth conversions in {now}$"] = f"{u.d(totRothNow)} ({u.d(totRoth)} nominal)"
+        dic["Total Roth conversions"] = f"{u.d(totRothNow)}"
+        dic["- Total Roth conversions (nominal)"] = f"{u.d(totRoth)}"
 
         taxPaid = np.sum(self.T_n, axis=0)
         taxPaidNow = np.sum(self.T_n / self.gamma_n[:-1], axis=0)
-        dic[f"Total income tax paid on ordinary income in {now}$"] = f"{u.d(taxPaidNow)} ({u.d(taxPaid)} nominal)"
+        dic["Total income tax paid on ordinary income"] = f"{u.d(taxPaidNow)}"
+        dic["- Total income tax paid on ordinary income (nominal)"] = f"{u.d(taxPaid)}"
+        for t in range(self.N_t):
+            taxPaid = np.sum(self.T_tn[t], axis=0)
+            taxPaidNow = np.sum(self.T_tn[t] / self.gamma_n[:-1], axis=0)
+            tname = tx.taxBracketNames[t]
+            dic[f"-- Subtotal in tax bracket {tname}"] = f"{u.d(taxPaidNow)}"
+            dic[f"--- Subtotal in tax bracket {tname} (nominal)"] = f"{u.d(taxPaid)}"
 
         taxPaid = np.sum(self.U_n, axis=0)
         taxPaidNow = np.sum(self.U_n / self.gamma_n[:-1], axis=0)
-        dic[f"Total tax paid on gains and dividends in {now}$"] = f"{u.d(taxPaidNow)} ({u.d(taxPaid)} nominal)"
+        dic["Total tax paid on gains and dividends"] = f"{u.d(taxPaidNow)}"
+        dic["- Total tax paid on gains and dividends (nominal)"] = f"{u.d(taxPaid)}"
 
         taxPaid = np.sum(self.M_n, axis=0)
         taxPaidNow = np.sum(self.M_n / self.gamma_n[:-1], axis=0)
-        dic[f"Total Medicare premiums paid in {now}$"] = f"{u.d(taxPaidNow)} ({u.d(taxPaid)} nominal)"
+        dic["Total Medicare premiums paid"] = f"{u.d(taxPaidNow)}"
+        dic["- Total Medicare premiums paid (nominal)"] = f"{u.d(taxPaid)}"
 
         if self.N_i == 2 and self.n_d < self.N_n:
             p_j = self.partialEstate_j * (1 - self.phi_j)
@@ -2117,30 +2134,40 @@ class Plan(object):
             totSpousalNow = totSpousal / self.gamma_n[nx + 1]
             iname_s = self.inames[self.i_s]
             iname_d = self.inames[self.i_d]
-            dic[f"Spousal wealth transfer from {iname_d} to {iname_s} in year {ynx} (nominal)"] = (
-                f"taxable: {u.d(q_j[0])}  tax-def: {u.d(q_j[1])}  tax-free: {u.d(q_j[2])}")
-
-            dic[f"Sum of spousal bequests to {iname_s} in year {ynx} in {now}$"] = (
-                f"{u.d(totSpousalNow)} ({u.d(totSpousal)} nominal)")
-            dic[
-                f"Post-tax non-spousal bequests from {iname_d} in year {ynx} (nominal)"] = (
-                f"taxable: {u.d(p_j[0])}  tax-def: {u.d(p_j[1])}  tax-free: {u.d(p_j[2])}")
-            dic[
-                f"Sum of post-tax non-spousal bequests from {iname_d} in year {ynx} in {now}$"] = (
-                f"{u.d(totOthersNow)} ({u.d(totOthers)} nominal)")
+            dic[f"Sum of spousal transfer to {iname_s} in year {ynx}"] = (f"{u.d(totSpousalNow)}")
+            dic[f"- Sum of spousal transfer to {iname_s} in year {ynx} (nominal)"] = (
+                f"{u.d(totSpousal)}")
+            dic[f"-- Spousal transfer to {iname_s} in year {ynx} - taxable (nominal)"] = (
+                f"{u.d(q_j[0])}")
+            dic[f"-- Spousal transfer to {iname_s} in year {ynx} - tax-def (nominal)"] = (
+                f"{u.d(q_j[1])}")
+            dic[f"-- Spousal transfer to {iname_s} in year {ynx} - tax-free (nominal)"] = (
+                f"{u.d(q_j[2])}")
+
+            dic[f"Sum of post-tax non-spousal bequests from {iname_d} in year {ynx}"] = (
+                f"{u.d(totOthersNow)}")
+            dic[f"- Sum of post-tax non-spousal bequests from {iname_d} in year {ynx} (nominal)"] = (
+                f"{u.d(totOthers)}")
+            dic[f"-- Post-tax non-spousal bequests from {iname_d} in year {ynx} - taxable (nominal)"] = (
+                f"{u.d(p_j[0])}")
+            dic[f"-- Post-tax non-spousal bequests from {iname_d} in year {ynx} - tax-def (nominal)"] = (
+                f"{u.d(p_j[1])}")
+            dic[f"-- Post-tax non-spousal bequests from {iname_d} in year {ynx} - tax-free (nominal)"] = (
+                f"{u.d(p_j[2])}")
 
         estate = np.sum(self.b_ijn[:, :, self.N_n], axis=0)
         estate[1] *= 1 - self.nu
         lastyear = self.year_n[-1]
-        dic[f"Post-tax account values at the end of final plan year {lastyear} (nominal)"] = (
-            f"taxable: {u.d(estate[0])}  tax-def: {u.d(estate[1])}  tax-free: {u.d(estate[2])}")
-
         totEstate = np.sum(estate)
         totEstateNow = totEstate / self.gamma_n[-1]
-        dic[f"Total estate value at the end of final plan year {lastyear} in {now}$"] = (
-            f"{u.d(totEstateNow)} ({u.d(totEstate)} nominal)")
+        dic[f"Total estate value at the end of {lastyear}"] = (f"{u.d(totEstateNow)}")
+        dic[f"- Total estate value at the end of {lastyear} (nominal)"] = (f"{u.d(totEstate)}")
+        dic[f"-- Post-tax account value at the end of {lastyear} - taxable (nominal)"] = (f"{u.d(estate[0])}")
+        dic[f"-- Post-tax account value at the end of {lastyear} - tax-def (nominal)"] = (f"{u.d(estate[1])}")
+        dic[f"-- Post-tax account value at the end of {lastyear} - tax-free (nominal)"] = (f"{u.d(estate[2])}")
+
         dic["Plan starting date"] = str(self.startDate)
-        dic["Cumulative inflation factor from start date to end of plan"] = f"{self.gamma_n[-1]:.2f}"
+        dic[f"Cumulative inflation factor from start date to end of {lastyear}"] = (f"{self.gamma_n[-1]:.2f}")
         for i in range(self.N_i):
             dic[f"{self.inames[i]:>12}'s {self.horizons[i]:02}-year life horizon"] = (
                 f"{now} -> {now + self.horizons[i] - 1}")

owlplanner/version.py

@@ -1 +1 @@
-__version__ = "2025.02.25"
+__version__ = "2025.03.07"

{owlplanner-2025.2.25.dist-info → owlplanner-2025.3.7.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: owlplanner
-Version: 2025.2.25
+Version: 2025.3.7
 Summary: Owl: Retirement planner with great wisdom
 Project-URL: HomePage, https://github.com/mdlacasse/owl
 Project-URL: Repository, https://github.com/mdlacasse/owl
@@ -711,7 +711,13 @@ Description-Content-Type: text/markdown
 -------------------------------------------------------------------------------------
 
 ### TL;DR
-Owl is a planning tool that uses a linear programming optimization algorithm to provide guidance on retirement decisions. There are a few ways to run Owl.
+Owl is a retirement planning tool that uses a linear programming optimization algorithm
+to provide guidance on retirement decisions, including Roth conversions.
+Users can select varying return rates to perform historical back testing,
+stochastic rates for performing Monte Carlo analyses,
+or fixed rates either derived from historical averages, or set by the user.
+
+There are a few ways to run Owl:
 
 - Run Owl directly on the Streamlit Community Server at [owlplanner.streamlit.app](https://owlplanner.streamlit.app).
 
@@ -868,7 +874,7 @@ assets to support, even with no estate being left.
 ---------------------------------------------------------------
 ## Documentation
 
-- Documentation for the app user interface is available from the interface itself.
+- Documentation for the app user interface is available from the interface [itself](https://owlplanner.streamlit.app/Documentation).
 - Installation guide and software requirements can be found [here](INSTALL.md).
 - User guide for the underlying Python package as used in a Jupyter notebook can be found [here](USER_GUIDE.md).
 

{owlplanner-2025.2.25.dist-info → owlplanner-2025.3.7.dist-info}/RECORD

@@ -2,16 +2,16 @@ owlplanner/__init__.py,sha256=QqrdT0Qks20osBTg7h0vJHAxpP9lL7DA99xb0nYbtw4,254
 owlplanner/abcapi.py,sha256=LbzW_KcNy0IeHp42MUHwGu_H67B2h_e1_vu-c2ACTkQ,6646
 owlplanner/config.py,sha256=bvqoOWrdPrWYQF9-PS_n00MoyZkAsmMOSczhTUFRGVU,12257
 owlplanner/logging.py,sha256=tYMw04O-XYSzjTj36fmKJGLcE1VkK6k6oJNeqtKXzuc,2530
-owlplanner/plan.py,sha256=cUXGyTgDGolGyLM8be7KhpJMpci8gGs0QTi4Aop89t0,113914
+owlplanner/plan.py,sha256=KSQafUjDijtAFS-G6SK-0qrbML8MOOWZboHVkFwU-yk,115398
 owlplanner/progress.py,sha256=8jlCvvtgDI89zXVNMBg1-lnEyhpPvKQS2X5oAIpoOVQ,384
 owlplanner/rates.py,sha256=TN407qU4n-bac1oymkQ_n2QKEPwFQxy6JZVGwgIkLQU,15585
 owlplanner/tax2025.py,sha256=B-A5eU3wxdcAaxRCbT3qI-JEKoD_ZeNbg_86XhNdQEI,7745
 owlplanner/timelists.py,sha256=tYieZU67FT6TCcQQis36JaXGI7dT6NqD7RvdEjgJL4M,4026
 owlplanner/utils.py,sha256=HM70W60qB41zfnbl2LltNwAuLYHyy5XYbwnbNcaa6FE,2351
-owlplanner/version.py,sha256=lWe1D4H8ZnLL1iNVPfsd_IJiZYc-uM_0FpLtePMlE8c,28
+owlplanner/version.py,sha256=oFLGanJ_QJZi21IR_SCxLKDCLsykO3ijgdBcyw2kymg,28
 owlplanner/data/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 owlplanner/data/rates.csv,sha256=6fxg56BVVORrj9wJlUGFdGXKvOX5r7CSca8uhUbbuIU,3734
-owlplanner-2025.2.25.dist-info/METADATA,sha256=8ioe1et4gjwsawDxV8U2BOqDhPTwQuS2ZsBhNm9_hdU,53506
-owlplanner-2025.2.25.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-owlplanner-2025.2.25.dist-info/licenses/LICENSE,sha256=IwGE9guuL-ryRPEKi6wFPI_zOhg7zDZbTYuHbSt_SAk,35823
-owlplanner-2025.2.25.dist-info/RECORD,,
+owlplanner-2025.3.7.dist-info/METADATA,sha256=BSvC46OldPiE6rDniinaJbgHwagtlXnTVFs1xTqlnGg,53799
+owlplanner-2025.3.7.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+owlplanner-2025.3.7.dist-info/licenses/LICENSE,sha256=IwGE9guuL-ryRPEKi6wFPI_zOhg7zDZbTYuHbSt_SAk,35823
+owlplanner-2025.3.7.dist-info/RECORD,,