owlplanner 2025.2.27__py3-none-any.whl → 2025.3.11__py3-none-any.whl

owlplanner/config.py

@@ -55,7 +55,7 @@ def saveConfig(myplan, file, mylog):
     diconf["Fixed Income"] = {
         "Pension amounts": (myplan.pensionAmounts / 1000).tolist(),
         "Pension ages": myplan.pensionAges.tolist(),
-        "Pension indexed": myplan.pensionIndexed,
+        "Pension indexed": myplan.pensionIsIndexed,
         "Social security amounts": (myplan.ssecAmounts / 1000).tolist(),
         "Social security ages": myplan.ssecAges.tolist(),
     }
@@ -222,8 +222,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)
-    pensionIndexed = diconf["Fixed Income"]["Pension indexed"]
-    p.setPension(pensionAmounts, pensionAges, pensionIndexed)
+    pensionIsIndexed = diconf["Fixed Income"]["Pension indexed"]
+    p.setPension(pensionAmounts, pensionAges, pensionIsIndexed)
 
     # Rates Selection.
     p.setDividendRate(float(diconf["Rates Selection"]["Dividend tax rate"]))

owlplanner/plan.py

@@ -291,7 +291,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.pensionIsIndexed = [False, False]
         self.ssecAmounts = np.zeros(self.N_i)
         self.ssecAges = 67 * np.ones(self.N_i, dtype=np.int32)
 
@@ -531,7 +531,7 @@ class Plan(object):
 
         self.pensionAmounts = np.array(amounts)
         self.pensionAges = np.array(ages, dtype=np.int32)
-        self.pensionIndexed = indexed
+        self.pensionIsIndexed = indexed
         self.caseStatus = "modified"
         self._adjustedParameters = False
 
@@ -1008,7 +1008,7 @@ class Plan(object):
             self.xiBar_n = self.xi_n * self.gamma_n[:-1]
             self.piBar_in = np.array(self.pi_in)
             for i in range(self.N_i):
-                if self.pensionIndexed[i]:
+                if self.pensionIsIndexed[i]:
                     self.piBar_in[i] *= self.gamma_n[:-1]
 
             self._adjustedParameters = True
@@ -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
@@ -2105,6 +2105,12 @@ class Plan(object):
         taxPaidNow = np.sum(self.T_n / self.gamma_n[:-1], axis=0)
         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)
@@ -2129,12 +2135,17 @@ class Plan(object):
             iname_s = self.inames[self.i_s]
             iname_d = self.inames[self.i_d]
             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 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)"] = (
@@ -2156,7 +2167,7 @@ class Plan(object):
         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[f"Cumulative inflation factor from start date to end of {lastyear}"] = 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.27"
+__version__ = "2025.03.11"

{owlplanner-2025.2.27.dist-info → owlplanner-2025.3.11.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: owlplanner
-Version: 2025.2.27
+Version: 2025.3.11
 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).
 
@@ -759,7 +765,7 @@ mathematical model can be found [here](https://raw.github.com/mdlacasse/Owl/main
 It is anticipated that most end users will use Owl through the graphical interface
 either at [owlplanner.streamlit.app](https://owlplanner.streamlit.app)
 or [installed](INSTALL.md) on their own computer.
-The underlying Python package can also be used directly through Python scripts or a Jupyter Notebook
+The underlying Python package can also be used directly through Python scripts or Jupyter Notebooks
 as described [here](USER_GUIDE.md).
 
 Not every retirement decision strategy can be framed as an easy-to-solve optimization problem.
@@ -792,7 +798,7 @@ Asset allocations are selected for the duration of the plan, and these can glide
 or along a configurable s-curve over the lifespan of the individual.
 
 Spending profiles are adjusted for inflation, and so are all other indexable quantities. Proflies can be
-flat or follow a *smile* curve which is also adjustable through two simple parameters.
+flat or follow a *smile* curve which is also adjustable through three simple parameters.
 
 Available rates are from 1928 to last year and can be used to test historical performance.
 Fixed rates can also be provided, as well as *histochastic* rates, which are generated using
@@ -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.27.dist-info → owlplanner-2025.3.11.dist-info}/RECORD

@@ -1,17 +1,17 @@
 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/config.py,sha256=uJ6jZ9Rx2CB2P5cFRscsUCXOW6uml7I4pta2ozjW0uo,12263
 owlplanner/logging.py,sha256=tYMw04O-XYSzjTj36fmKJGLcE1VkK6k6oJNeqtKXzuc,2530
-owlplanner/plan.py,sha256=Wadr5IlsXJbOvnw7dDIb4nVD7PuUCiUI_HXCvyF4sF0,114925
+owlplanner/plan.py,sha256=mCcoocK9g1nCUpQDaMVUTiwugKPuDZaEYbrSPPi0sBY,115404
 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=2dWgos-zzkuXchJJ940RNcgSbRClj6bmX8bVv2KOl-A,28
+owlplanner/version.py,sha256=HrtvlhxZp9gln32M2lagzUjBWC3oqV1rUecAVUAAJj8,28
 owlplanner/data/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 owlplanner/data/rates.csv,sha256=6fxg56BVVORrj9wJlUGFdGXKvOX5r7CSca8uhUbbuIU,3734
-owlplanner-2025.2.27.dist-info/METADATA,sha256=WT4eGtSQ125dYyOb8PgZ175f_WHrKvGssaEJQ5qd5P0,53506
-owlplanner-2025.2.27.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-owlplanner-2025.2.27.dist-info/licenses/LICENSE,sha256=IwGE9guuL-ryRPEKi6wFPI_zOhg7zDZbTYuHbSt_SAk,35823
-owlplanner-2025.2.27.dist-info/RECORD,,
+owlplanner-2025.3.11.dist-info/METADATA,sha256=h06pbBAcJCEqWvY_zOybpnIk5xEaVhax8R2YESfn73o,53801
+owlplanner-2025.3.11.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+owlplanner-2025.3.11.dist-info/licenses/LICENSE,sha256=IwGE9guuL-ryRPEKi6wFPI_zOhg7zDZbTYuHbSt_SAk,35823
+owlplanner-2025.3.11.dist-info/RECORD,,