owlplanner 2025.3.13__tar.gz → 2025.3.14__tar.gz

{owlplanner-2025.3.13 → owlplanner-2025.3.14}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: owlplanner
-Version: 2025.3.13
+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.13 → owlplanner-2025.3.14}/docs/owl.tex

@@ -91,7 +91,7 @@ index name as a subscript, e.g., $N_i$ for index $i$.
 	the end of year $N_n-1$, and therefore $N_n + 1$ years are considered.
 	Year $N_n$ is the first year following the passing of all
 	individuals in the plan. The time period for all decision variables is annual.
-	For spouses, the end of year $n_d-1$ is the year in which the first individual passes while
+	For spouses, the end of year $n_d-1$ is when the first individual is assumed to pass while
 	the survivor will decease at the end of year $N_n-1$ of the plan.
 \item [$t$]
 	Federal income tax bracket. $t$ goes from 0 to $N_t - 1$, from low to high.
@@ -441,8 +441,18 @@ All intermediate variables are in uppercase letters.
 	paid in each tax bracket as
 	\begin{equation}
 		\label{Eq:IncTax0}
-		T_n = \sum_t f_{tn}\bar{\Delta}_{tn}\theta_{tn}.
+		T_n = \sum_t f_{tn}\bar{\Delta}_{tn}\theta_{tn} + 0.10 \sum_i (1 - \mathcal{H}(n - n_{i,60})) w_{i1n},
 	\end{equation}
+        where $H(n - n_{i, 60})$ is a Heavyside step function which is 0 or 1, depending on the sign of
+        its argument:
+        \[
+	\mathcal{H}(x) \def 	
+	\begin{cases}
+         0 & x < 0 \\
+         1 & x \geq 0. \\
+	\end{cases}
+         \]
+        Here, $n_{i, 60}$ is the year when individual $i$ will turn 60.
 	Notice that $G_n$ is also defined by Eq.~(\ref{Eq:Tx1}), and that optimal
 	values of $f_{tn}$ have to
 	minimize $T_n$ when either the bequest or the desired net spending are maximized.

{owlplanner-2025.3.13 → owlplanner-2025.3.14}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "owlplanner"
-version = "2025.03.13"
+version = "2025.03.14"
 authors = [
   { name="Martin-D. Lacasse", email="martin.d.lacasse@gmail.com" },
 ]

{owlplanner-2025.3.13 → owlplanner-2025.3.14}/src/owlplanner/plan.py

@@ -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
@@ -2112,6 +2126,11 @@ class Plan(object):
             dic[f"-- Subtotal in tax bracket {tname}"] = f"{u.d(taxPaidNow)}"
             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)}"
@@ -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-2025.3.13 → owlplanner-2025.3.14}/src/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-2025.3.14/src/owlplanner/version.py

@@ -0,0 +1 @@
+__version__ = "2025.03.14"

{owlplanner-2025.3.13 → owlplanner-2025.3.14}/tests/test_regressions.py

@@ -89,7 +89,7 @@ def createPlan(ni, name, ny, topAge):
 
 def test_withdrawal1():
     n = 10
-    p = createPlan(1, 'withdrawal1', n, 64)
+    p = createPlan(1, 'withdrawal1', n, 70)
     amount = 3.0
     p.setAccountBalances(taxable=[0], taxDeferred=[amount], taxFree=[0])
     p.setAllocationRatios('individual', generic=[[[0, 0, 0, 100], [0, 0, 0, 100]]])
@@ -102,7 +102,7 @@ def test_withdrawal1():
 
 def test_withdrawal2():
     n = 10
-    p = createPlan(1, 'withdrawal2', n, 64)
+    p = createPlan(1, 'withdrawal2', n, 70)
     # Small taxable income creates an income smaller than standard deduction. Testing e_n.
     amount = 40.0
     p.setAccountBalances(taxable=[0], taxDeferred=[amount], taxFree=[0])
@@ -116,7 +116,7 @@ def test_withdrawal2():
 
 def test_withdrawal2_2():
     n = 10
-    p = createPlan(2, 'withdrawal2_2', n, 64)
+    p = createPlan(2, 'withdrawal2_2', n, 70)
     # Small taxable income creates an income smaller than standard deduction. Testing e_n.
     amount = 50
     p.setAccountBalances(taxable=[0, 0], taxDeferred=[amount/2, amount/2], taxFree=[0, 0])
@@ -130,7 +130,7 @@ def test_withdrawal2_2():
 
 def test_withdrawal3():
     n = 6
-    p = createPlan(1, 'withdrawal3', n, 64)
+    p = createPlan(1, 'withdrawal3', n, 70)
     amount = 60
     p.setAccountBalances(taxable=[0], taxDeferred=[0], taxFree=[amount])
     p.setAllocationRatios('individual', generic=[[[0, 0, 0, 100], [0, 0, 0, 100]]])
@@ -143,7 +143,7 @@ def test_withdrawal3():
 
 def test_withdrawal3_2():
     n = 6
-    p = createPlan(2, 'withdrawal3', n, 64)
+    p = createPlan(2, 'withdrawal3', n, 70)
     amount = 60
     p.setAccountBalances(taxable=[0, 0], taxDeferred=[0, 0], taxFree=[amount/2, amount/2])
     p.setAllocationRatios('spouses', generic=[[0, 0, 0, 100], [0, 0, 0, 100]])
@@ -156,7 +156,7 @@ def test_withdrawal3_2():
 
 def test_taxfreegrowth1():
     n = 12
-    p = createPlan(1, 'taxfreegrowth1', n, 64)
+    p = createPlan(1, 'taxfreegrowth1', n, 72)
     amount = 120
     p.setAccountBalances(taxable=[0], taxDeferred=[0], taxFree=[amount])
     p.setAllocationRatios('individual', generic=[[[0, 0, 100, 0], [0, 0, 100, 0]]])
@@ -170,7 +170,7 @@ def test_taxfreegrowth1():
 
 def test_taxfreegrowth1_2():
     n = 12
-    p = createPlan(2, 'taxfreegrowth1', n, 64)
+    p = createPlan(2, 'taxfreegrowth1', n, 72)
     amount = 120
     p.setAccountBalances(taxable=[0, 0], taxDeferred=[0, 0], taxFree=[amount/2, amount/2])
     p.setAllocationRatios('spouses', generic=[[0, 0, 100, 0], [0, 0, 100, 0]])
@@ -184,7 +184,7 @@ def test_taxfreegrowth1_2():
 
 def test_taxfreegrowth2():
     n = 15
-    p = createPlan(1, 'taxfreegrowth2', n, 64)
+    p = createPlan(1, 'taxfreegrowth2', n, 75)
     amount = 120
     p.setAccountBalances(taxable=[0], taxDeferred=[0], taxFree=[amount])
     p.setAllocationRatios('individual', generic=[[[0, 50, 50, 0], [0, 50, 50, 0]]])
@@ -198,7 +198,7 @@ def test_taxfreegrowth2():
 
 def test_taxfreegrowth2_2():
     n = 15
-    p = createPlan(2, 'taxfreegrowth2', n, 64)
+    p = createPlan(2, 'taxfreegrowth2', n, 75)
     amount = 120
     p.setAccountBalances(taxable=[0, 0], taxDeferred=[0, 0], taxFree=[amount/2, amount/2])
     p.setAllocationRatios('spouses', generic=[[0, 50, 50, 0], [0, 50, 50, 0]])
@@ -212,7 +212,7 @@ def test_taxfreegrowth2_2():
 
 def test_taxfreegrowth3():
     n = 15
-    p = createPlan(1, 'taxfreegrowth3', n, 64)
+    p = createPlan(1, 'taxfreegrowth3', n, 75)
     amount = 120
     p.setAccountBalances(taxable=[0], taxDeferred=[0], taxFree=[amount])
     p.setAllocationRatios('individual', generic=[[[50, 50, 0, 0], [50, 50, 0, 0]]])
@@ -226,7 +226,7 @@ def test_taxfreegrowth3():
 
 def test_taxfreegrowth3_2():
     n = 15
-    p = createPlan(2, 'taxfreegrowth3', n, 64)
+    p = createPlan(2, 'taxfreegrowth3', n, 75)
     amount = 120
     p.setAccountBalances(taxable=[0, 0], taxDeferred=[0, 0], taxFree=[amount/2, amount/2])
     p.setAllocationRatios('spouses', generic=[[50, 50, 0, 0], [50, 50, 0, 0]])
@@ -240,7 +240,7 @@ def test_taxfreegrowth3_2():
 
 def test_taxfreegrowth4():
     n = 16
-    p = createPlan(1, 'taxfreegrowth4', n, 64)
+    p = createPlan(1, 'taxfreegrowth4', n, 76)
     amount = 120
     p.setAccountBalances(taxable=[0], taxDeferred=[0], taxFree=[amount])
     p.setAllocationRatios('individual', generic=[[[0, 50, 50, 0], [0, 50, 50, 0]]])
@@ -255,7 +255,7 @@ def test_taxfreegrowth4():
 
 def test_taxfreegrowth4_2():
     n = 16
-    p = createPlan(2, 'taxfreegrowth4', n, 64)
+    p = createPlan(2, 'taxfreegrowth4', n, 76)
     amount = 120
     p.setAccountBalances(taxable=[0, 0], taxDeferred=[0, 0], taxFree=[amount/2, amount/2])
     p.setAllocationRatios('spouses', generic=[[0, 50, 50, 0], [0, 50, 50, 0]])
@@ -270,7 +270,7 @@ def test_taxfreegrowth4_2():
 
 def test_taxfreegrowth5():
     n = 15
-    p = createPlan(1, 'taxfreegrowth5', n, 64)
+    p = createPlan(1, 'taxfreegrowth5', n, 76)
     amount = 120
     p.setAccountBalances(taxable=[0], taxDeferred=[0], taxFree=[amount])
     p.setAllocationRatios('individual', generic=[[[0, 0, 100, 0], [0, 0, 100, 0]]])
@@ -284,7 +284,7 @@ def test_taxfreegrowth5():
 
 def test_taxfreegrowth5_2():
     n = 15
-    p = createPlan(2, 'taxfreegrowth5', n, 64)
+    p = createPlan(2, 'taxfreegrowth5', n, 76)
     amount = 120
     p.setAccountBalances(taxable=[0, 0], taxDeferred=[0, 0], taxFree=[amount/2, amount/2])
     p.setAllocationRatios('spouses', generic=[[0, 0, 100, 0], [0, 0, 100, 0]])
@@ -298,7 +298,7 @@ def test_taxfreegrowth5_2():
 
 def test_taxfreegrowth6():
     n = 15
-    p = createPlan(1, 'taxfreegrowth6', n, 64)
+    p = createPlan(1, 'taxfreegrowth6', n, 76)
     amount = 120
     p.setAccountBalances(taxable=[0], taxDeferred=[0], taxFree=[amount])
     p.setAllocationRatios('individual', generic=[[[0, 0, 0, 100], [0, 0, 0, 100]]])
@@ -312,7 +312,7 @@ def test_taxfreegrowth6():
 
 def test_taxfreegrowth6_2():
     n = 15
-    p = createPlan(2, 'taxfreegrowth6', n, 64)
+    p = createPlan(2, 'taxfreegrowth6', n, 76)
     amount = 120
     p.setAccountBalances(taxable=[0, 0], taxDeferred=[0, 0], taxFree=[amount/2, amount/2])
     p.setAllocationRatios('spouses', generic=[[0, 0, 0, 100], [0, 0, 0, 100]])
@@ -326,7 +326,7 @@ def test_taxfreegrowth6_2():
 
 def test_taxfreegrowth7():
     n = 15
-    p = createPlan(1, 'taxfreegrowth7', n, 64)
+    p = createPlan(1, 'taxfreegrowth7', n, 76)
     amount = 120
     p.setAccountBalances(taxable=[0], taxDeferred=[0], taxFree=[amount])
     p.setAllocationRatios('individual', generic=[[[0, 100, 0, 0], [0, 100, 0, 0]]])
@@ -340,7 +340,7 @@ def test_taxfreegrowth7():
 
 def test_taxfreegrowth7_2():
     n = 15
-    p = createPlan(2, 'taxfreegrowth7', n, 64)
+    p = createPlan(2, 'taxfreegrowth7', n, 76)
     amount = 120
     p.setAccountBalances(taxable=[0, 0], taxDeferred=[0, 0], taxFree=[amount/2, amount/2])
     p.setAllocationRatios('spouses', generic=[[0, 100, 0, 0], [0, 100, 0, 0]])
@@ -354,7 +354,7 @@ def test_taxfreegrowth7_2():
 
 def test_taxfreegrowth8():
     n = 15
-    p = createPlan(1, 'taxfreegrowth8', n, 64)
+    p = createPlan(1, 'taxfreegrowth8', n, 76)
     amount = 120
     p.setAccountBalances(taxable=[0], taxDeferred=[0], taxFree=[amount])
     p.setAllocationRatios('individual', generic=[[[100, 0, 0, 0], [100, 0, 0, 0]]])
@@ -368,7 +368,7 @@ def test_taxfreegrowth8():
 
 def test_taxfreegrowth8_2():
     n = 15
-    p = createPlan(2, 'taxfreegrowth8', n, 64)
+    p = createPlan(2, 'taxfreegrowth8', n, 76)
     amount = 120
     p.setAccountBalances(taxable=[0, 0], taxDeferred=[0, 0], taxFree=[amount/2, amount/2])
     p.setAllocationRatios('spouses', generic=[[100, 0, 0, 0], [100, 0, 0, 0]])
@@ -382,7 +382,7 @@ def test_taxfreegrowth8_2():
 
 def test_annuity1():
     n = 12
-    p = createPlan(1, 'annuity1', n, 64)
+    p = createPlan(1, 'annuity1', n, 76)
     amount = 120
     p.setAccountBalances(taxable=[0], taxDeferred=[0], taxFree=[amount])
     p.setAllocationRatios('individual', generic=[[[0, 0, 100, 0], [0, 0, 100, 0]]])
@@ -400,7 +400,7 @@ def test_annuity1():
 
 def test_annuity1_2():
     n = 12
-    p = createPlan(2, 'annuity1', n, 64)
+    p = createPlan(2, 'annuity1', n, 76)
     amount = 120
     p.setAccountBalances(taxable=[0, 0], taxDeferred=[0, 0], taxFree=[amount/2, amount/2])
     p.setAllocationRatios('spouses', generic=[[0, 0, 100, 0], [0, 0, 100, 0]])
@@ -418,7 +418,7 @@ def test_annuity1_2():
 
 def test_annuity2():
     n = 18
-    p = createPlan(1, 'annuity2', n, 64)
+    p = createPlan(1, 'annuity2', n, 76)
     amount = 120
     p.setAccountBalances(taxable=[0], taxDeferred=[0], taxFree=[amount])
     p.setAllocationRatios('individual', generic=[[[0, 0, 100, 0], [0, 0, 100, 0]]])
@@ -436,7 +436,7 @@ def test_annuity2():
 
 def test_annuity2_2():
     n = 18
-    p = createPlan(2, 'annuity2', n, 64)
+    p = createPlan(2, 'annuity2', n, 78)
     amount = 120
     p.setAccountBalances(taxable=[0, 0], taxDeferred=[0, 0], taxFree=[amount/2, amount/2])
     p.setAllocationRatios('spouses', generic=[[0, 0, 100, 0], [0, 0, 100, 0]])
@@ -454,7 +454,7 @@ def test_annuity2_2():
 
 def test_annuity3():
     n = 30
-    p = createPlan(1, 'annuity2', n, 64)
+    p = createPlan(1, 'annuity2', n, 90)
     amount = 100
     p.setAccountBalances(taxable=[0], taxDeferred=[0], taxFree=[amount])
     p.setAllocationRatios('individual', generic=[[[0, 0, 100, 0], [0, 0, 100, 0]]])
@@ -472,7 +472,7 @@ def test_annuity3():
 
 def test_annuity3_2():
     n = 30
-    p = createPlan(2, 'annuity2', n, 64)
+    p = createPlan(2, 'annuity2', n, 90)
     amount = 100
     p.setAccountBalances(taxable=[0, 0], taxDeferred=[0, 0], taxFree=[amount/2, amount/2])
     p.setAllocationRatios('spouses', generic=[[0, 0, 100, 0], [0, 0, 100, 0]])

{owlplanner-2025.3.13 → owlplanner-2025.3.14}/ui/Rates_Selection.py

@@ -93,10 +93,11 @@ else:
 
         col1, col2, col3, col4 = st.columns(4, gap="large", vertical_alignment="top")
         with col1:
+            maxValue = owb.TO if kz.getKey("varyingType") == "historical" else kz.getKey("yto") - 1
             st.number_input(
                 "Starting year",
                 min_value=owb.FROM,
-                max_value=kz.getKey("yto") - 1,
+                max_value=maxValue,
                 value=kz.getKey("yfrm"),
                 on_change=updateRates,
                 args=["yfrm"],

{owlplanner-2025.3.13 → owlplanner-2025.3.14}/ui/requirements.txt

@@ -7,4 +7,4 @@ scipy
 streamlit
 toml
 # --extra-index-url https://test.pypi.org/simple
-owlplanner >= 2025.03.13
+owlplanner >= 2025.03.14

owlplanner-2025.3.13/src/owlplanner/version.py

@@ -1 +0,0 @@
-__version__ = "2025.03.13"