owlplanner 2025.3.12__py3-none-any.whl → 2025.3.14__py3-none-any.whl

owlplanner/plan.py

@@ -34,7 +34,7 @@ from owlplanner import logging
 from owlplanner import progress
 
 
-# This makes all graphs appear have the same height.
+# This makes all graphs to have the same height.
 plt.rcParams.update({'figure.autolayout': True})
 
 
@@ -266,6 +266,9 @@ class Plan(object):
         # self.horizons = [yobs[i] + expectancy[i] - thisyear + 1 for i in range(self.N_i)]
         self.N_n = np.max(self.horizons)
         self.year_n = np.linspace(thisyear, thisyear + self.N_n - 1, self.N_n, dtype=np.int32)
+        # Year in the plan (if any) where individuals turn 59. For 10% withdrawal penalty.
+        self.n59 = 59 - thisyear + self.yobs
+        self.n59[self.n59 < 0] = 0
         # Handle passing of one spouse before the other.
         if self.N_i == 2 and np.min(self.horizons) != np.max(self.horizons):
             self.n_d = np.min(self.horizons)
@@ -1289,6 +1292,11 @@ class Plan(object):
             for t in range(Nt):
                 row.addElem(_q2(CF, t, n, Nt, Nn), self.theta_tn[t, n])
 
+            # Minus 10% penalty on early withdrawals.
+            if n < self.n59[i]:
+                row.addElem(_q3(Cw, i, 1, n, Ni, Nj, Nn), 0.1)
+                row.addElem(_q3(Cw, i, 2, n, Ni, Nj, Nn), 0.1)
+
             A.addRow(row, rhs, rhs)
 
         # Impose income profile.
@@ -1970,6 +1978,12 @@ class Plan(object):
         self.G_n = np.sum(self.F_tn, axis=0)
         self.T_tn = self.F_tn * self.theta_tn
         self.T_n = np.sum(self.T_tn, axis=0)
+        self.penalty_n = np.zeros(Nn)
+        # Add early withdrawal penalties if any.
+        for i in range(Ni):
+            self.penalty_n[0:self.n59[i]] += 0.1*(self.w_ijn[i, 1, 0:self.n59[i]] + self.w_ijn[i, 2, 0:self.n59[i]])
+
+        self.T_n += self.penalty_n
 
         tau_0 = np.array(self.tau_kn[0, :])
         tau_0[tau_0 < 0] = 0
@@ -2094,33 +2108,38 @@ class Plan(object):
         totIncome = np.sum(self.g_n, axis=0)
         totIncomeNow = np.sum(self.g_n / self.gamma_n[:-1], axis=0)
         dic["Total net spending"] = f"{u.d(totIncomeNow)}"
-        dic["- Total net spending (nominal)"] = f"{u.d(totIncome)}"
+        dic["[Total net spending]"] = 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["Total Roth conversions"] = f"{u.d(totRothNow)}"
-        dic["- Total Roth conversions (nominal)"] = f"{u.d(totRoth)}"
+        dic["[Total Roth conversions]"] = 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["Total income tax paid on ordinary income"] = f"{u.d(taxPaidNow)}"
-        dic["- Total income tax paid on ordinary income (nominal)"] = f"{u.d(taxPaid)}"
+        dic["[Total income tax paid on ordinary income]"] = 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)}"
+            dic[f"-- [Subtotal in tax bracket {tname}]"] = f"{u.d(taxPaid)}"
+
+        penaltyPaid = np.sum(self.penalty_n, axis=0)
+        penaltyPaidNow = np.sum(self.penalty_n / self.gamma_n[:-1], axis=0)
+        dic["-- Subtotal in early withdrawal penalty"] = f"{u.d(penaltyPaidNow)}"
+        dic["-- [Subtotal in early withdrawal penalty]"] = f"{u.d(penaltyPaid)}"
 
         taxPaid = np.sum(self.U_n, axis=0)
         taxPaidNow = np.sum(self.U_n / self.gamma_n[:-1], axis=0)
         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)}"
+        dic["[Total tax paid on gains and dividends]"] = 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["Total Medicare premiums paid"] = f"{u.d(taxPaidNow)}"
-        dic["- Total Medicare premiums paid (nominal)"] = f"{u.d(taxPaid)}"
+        dic["[Total Medicare premiums paid]"] = 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)
@@ -2135,24 +2154,24 @@ 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)"] = (
+            dic[f"[Sum of spousal transfer to {iname_s} in year {ynx}]"] = (
                 f"{u.d(totSpousal)}")
-            dic[f"-- Spousal transfer to {iname_s} in year {ynx} - taxable (nominal)"] = (
+            dic[f"-- [Spousal transfer to {iname_s} in year {ynx} - taxable]"] = (
                 f"{u.d(q_j[0])}")
-            dic[f"-- Spousal transfer to {iname_s} in year {ynx} - tax-def (nominal)"] = (
+            dic[f"-- [Spousal transfer to {iname_s} in year {ynx} - tax-def]"] = (
                 f"{u.d(q_j[1])}")
-            dic[f"-- Spousal transfer to {iname_s} in year {ynx} - tax-free (nominal)"] = (
+            dic[f"-- [Spousal transfer to {iname_s} in year {ynx} - tax-free]"] = (
                 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)"] = (
+            dic[f"[Sum of post-tax non-spousal bequests from {iname_d} in year {ynx}]"] = (
                 f"{u.d(totOthers)}")
-            dic[f"-- Post-tax non-spousal bequests from {iname_d} in year {ynx} - taxable (nominal)"] = (
+            dic[f"-- [Post-tax non-spousal bequests from {iname_d} in year {ynx} - taxable]"] = (
                 f"{u.d(p_j[0])}")
-            dic[f"-- Post-tax non-spousal bequests from {iname_d} in year {ynx} - tax-def (nominal)"] = (
+            dic[f"-- [Post-tax non-spousal bequests from {iname_d} in year {ynx} - tax-def]"] = (
                 f"{u.d(p_j[1])}")
-            dic[f"-- Post-tax non-spousal bequests from {iname_d} in year {ynx} - tax-free (nominal)"] = (
+            dic[f"-- [Post-tax non-spousal bequests from {iname_d} in year {ynx} - tax-free]"] = (
                 f"{u.d(p_j[2])}")
 
         estate = np.sum(self.b_ijn[:, :, self.N_n], axis=0)
@@ -2161,10 +2180,10 @@ class Plan(object):
         totEstate = np.sum(estate)
         totEstateNow = totEstate / self.gamma_n[-1]
         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[f"[Total estate value at the end of {lastyear}]"] = (f"{u.d(totEstate)}")
+        dic[f"-- [Post-tax account value at the end of {lastyear} - taxable]"] = (f"{u.d(estate[0])}")
+        dic[f"-- [Post-tax account value at the end of {lastyear} - tax-def]"] = (f"{u.d(estate[1])}")
+        dic[f"-- [Post-tax account value at the end of {lastyear} - tax-free]"] = (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}")
@@ -2507,6 +2526,7 @@ class Plan(object):
 
         title = self._name + "\nRaw Income Sources"
         stypes = self.sources_in.keys()
+        # stypes = [item for item in stypes if "RothX" not in item]
 
         if tag != "":
             title += " - " + tag
@@ -2517,7 +2537,7 @@ class Plan(object):
         else:
             yformat = "\\$k (" + str(self.year_n[0]) + "\\$)"
             sources_in = {}
-            for key in self.sources_in:
+            for key in stypes:
                 sources_in[key] = self.sources_in[key] / self.gamma_n[:-1]
 
         fig, ax = _stackPlot(

owlplanner/utils.py

@@ -70,8 +70,8 @@ def getUnits(units) -> int:
     return fac
 
 
-# Could be a one-line lambda function:
-# krond = lambda a, b: 1 if a == b else 0
+# Next two functins could be a one-line lambda functions.
+# e.g., krond = lambda a, b: 1 if a == b else 0
 def krond(a, b) -> int:
     """
     Kronecker integer delta function.
@@ -79,6 +79,13 @@ def krond(a, b) -> int:
     return 1 if a == b else 0
 
 
+def heavyside(x) -> int:
+    """
+    Heavyside step function.
+    """
+    return 1 if x >= 0 else 0
+
+
 def roundCents(values, decimals=2):
     """
     Round values in NumPy array down to second decimal.

owlplanner/version.py

@@ -1 +1 @@
-__version__ = "2025.03.12"
+__version__ = "2025.03.14"

{owlplanner-2025.3.12.dist-info → owlplanner-2025.3.14.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: owlplanner
-Version: 2025.3.12
+Version: 2025.3.14
 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.3.12.dist-info → owlplanner-2025.3.14.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=uJ6jZ9Rx2CB2P5cFRscsUCXOW6uml7I4pta2ozjW0uo,12263
 owlplanner/logging.py,sha256=tYMw04O-XYSzjTj36fmKJGLcE1VkK6k6oJNeqtKXzuc,2530
-owlplanner/plan.py,sha256=mCcoocK9g1nCUpQDaMVUTiwugKPuDZaEYbrSPPi0sBY,115404
+owlplanner/plan.py,sha256=2uS_N121p-fPhCboVSAthdt_uVw109ltLTvCLeGouuo,116263
 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=nHgfINF2PnODSOO9bLDEpnzh97BOhFuEmlbblPAAeZY,28
+owlplanner/utils.py,sha256=WpJgn79YZfH8UCkcmhd-AZlxlGuz1i1-UDBRXImsY6I,2485
+owlplanner/version.py,sha256=gPOv802nGWM84uQsfLVWHJKlgbpuozzBAjyW-OgDkzE,28
 owlplanner/data/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 owlplanner/data/rates.csv,sha256=6fxg56BVVORrj9wJlUGFdGXKvOX5r7CSca8uhUbbuIU,3734
-owlplanner-2025.3.12.dist-info/METADATA,sha256=8xb-RhkQGUz2oxEs7Ux_QgQ4f31gaeFdPA_CJ5rOjrw,53801
-owlplanner-2025.3.12.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-owlplanner-2025.3.12.dist-info/licenses/LICENSE,sha256=IwGE9guuL-ryRPEKi6wFPI_zOhg7zDZbTYuHbSt_SAk,35823
-owlplanner-2025.3.12.dist-info/RECORD,,
+owlplanner-2025.3.14.dist-info/METADATA,sha256=C5BlpAPu2CwtVQmuBUPDTYi7mXg86T3b0dYR5anPUak,53801
+owlplanner-2025.3.14.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+owlplanner-2025.3.14.dist-info/licenses/LICENSE,sha256=IwGE9guuL-ryRPEKi6wFPI_zOhg7zDZbTYuHbSt_SAk,35823
+owlplanner-2025.3.14.dist-info/RECORD,,