owlplanner 2025.3.30__tar.gz → 2025.4.2__tar.gz

{owlplanner-2025.3.30 → owlplanner-2025.4.2}/.flake8

@@ -1,6 +1,6 @@
 [flake8]
 max-line-length = 120
-max-complexity = 60
+max-complexity = 70
 # These checks violate PEP8 so let's ignore them
 extend-ignore = E203
 # extend-exclude = */site-packages/*

{owlplanner-2025.3.30 → owlplanner-2025.4.2}/PKG-INFO

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

@@ -329,7 +329,7 @@ or an s-curve as in
 	Income tax rate on long-term capital gain and qualified dividends, typically 15\%.
 \item [$\eta$]
 	Spousal ratio for surplus deposits, which goes from 0 to 1, as the fraction
-	that goes to the $i = 1$ second spouse's account. Therefore, a surplus $s_n$ in year $n$
+	that goes to the $i = 1$ spouse's account. Therefore, a surplus $s_n$ in year $n$
 	will result in a deposit $d$ in the taxable account of individual $i$ as
 	\begin{eqnarray}
 		\label{Eq:eta}

{owlplanner-2025.3.30 → owlplanner-2025.4.2}/pyproject.toml

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

{owlplanner-2025.3.30 → owlplanner-2025.4.2}/requirements.txt

@@ -3,6 +3,7 @@ matplotlib
 seaborn
 pandas
 openpyxl
+odfpy
 scipy
 streamlit
 toml

{owlplanner-2025.3.30 → owlplanner-2025.4.2}/src/owlplanner/config.py

@@ -12,6 +12,7 @@ Disclaimer: This program comes with no guarantee. Use at your own risk.
 import toml as toml
 from io import StringIO, BytesIO
 import numpy as np
+from datetime import date
 import os
 
 from owlplanner import plan
@@ -302,6 +303,11 @@ def readConfig(file, *, verbose=True, logstreams=None, readContributions=True):
     if name != "None" and name not in p.inames:
         raise ValueError(f"Unknown name {name} for noRothConversions.")
 
+    # Rebase startRothConversions on year change.
+    thisyear = date.today().year
+    year = p.solverOptions.get("startRothConversions", thisyear)
+    diconf["Solver Options"]["startRothConversions"] = max(year, thisyear)
+
     # Results.
     p.setDefaultPlots(diconf["Results"]["Default plots"])
 

{owlplanner-2025.3.30 → owlplanner-2025.4.2}/src/owlplanner/plan.py

@@ -1122,16 +1122,17 @@ class Plan(object):
             B.set0_Ub(_q1(Ce, n, Nn), self.sigmaBar_n[n])
 
         # Roth conversions equalities/inequalities.
-        if "maxRothConversion" in options:
-            if options["maxRothConversion"] == "file":
-                # self.mylog.vprint(f"Fixing Roth conversions to those from file {self.timeListsFileName}.")
-                for i in range(Ni):
-                    for n in range(self.horizons[i]):
-                        rhs = self.myRothX_in[i][n]
-                        B.setRange(_q2(Cx, i, n, Ni, Nn), rhs, rhs)
-            else:
+        # This condition supercedes everything else.
+        if "maxRothConversion" in options and options["maxRothConversion"] == "file":
+            # self.mylog.vprint(f"Fixing Roth conversions to those from file {self.timeListsFileName}.")
+            for i in range(Ni):
+                for n in range(self.horizons[i]):
+                    rhs = self.myRothX_in[i][n]
+                    B.setRange(_q2(Cx, i, n, Ni, Nn), rhs, rhs)
+        else:
+            if "maxRothConversion" in options:
                 rhsopt = options["maxRothConversion"]
-                assert isinstance(rhsopt, (int, float)), "Specified maxConversion is not a number."
+                assert isinstance(rhsopt, (int, float)), "Specified maxRothConversion is not a number."
                 rhsopt *= units
                 if rhsopt < 0:
                     # self.mylog.vprint('Unlimited Roth conversions (<0)')
@@ -1143,16 +1144,28 @@ class Plan(object):
                             #  Should we adjust Roth conversion cap with inflation?
                             B.set0_Ub(_q2(Cx, i, n, Ni, Nn), rhsopt)
 
-        # Process noRothConversions option. Also valid when N_i == 1, why not?
-        if "noRothConversions" in options and options["noRothConversions"] != "None":
-            rhsopt = options["noRothConversions"]
-            try:
-                i_x = self.inames.index(rhsopt)
-            except ValueError:
-                raise ValueError(f"Unknown individual {rhsopt} for noRothConversions:")
+            # Process startRothConversions option.
+            if "startRothConversions" in options:
+                rhsopt = options["startRothConversions"]
+                assert isinstance(rhsopt, (int, float)), "Specified startRothConversions is not a number."
+                thisyear = date.today().year
+                yearn = max(rhsopt - thisyear, 0)
 
-            for n in range(Nn):
-                B.set0_Ub(_q2(Cx, i_x, n, Ni, Nn), zero)
+                for i in range(Ni):
+                    nstart = min(yearn, self.horizons[i])
+                    for n in range(0, nstart):
+                        B.set0_Ub(_q2(Cx, i, n, Ni, Nn), zero)
+
+            # Process noRothConversions option. Also valid when N_i == 1, why not?
+            if "noRothConversions" in options and options["noRothConversions"] != "None":
+                rhsopt = options["noRothConversions"]
+                try:
+                    i_x = self.inames.index(rhsopt)
+                except ValueError:
+                    raise ValueError(f"Unknown individual {rhsopt} for noRothConversions:")
+
+                for n in range(Nn):
+                    B.set0_Ub(_q2(Cx, i_x, n, Ni, Nn), zero)
 
         # Impose withdrawal limits on taxable and tax-exempt accounts.
         for i in range(Ni):
@@ -1197,7 +1210,7 @@ class Plan(object):
             # Account for time elapsed in the current year.
             spending *= units * self.yearFracLeft
             # self.mylog.vprint('Maximizing bequest with desired net spending of:', u.d(spending))
-            # To allow slack in first year, Cg can be made Nn+1 and store basis in g[Nn]. 
+            # To allow slack in first year, Cg can be made Nn+1 and store basis in g[Nn].
             A.addNewRow({_q1(Cg, 0, Nn): 1}, spending, spending)
 
         # Set initial balances through constraints.
@@ -1616,16 +1629,17 @@ class Plan(object):
         knownObjectives = ["maxBequest", "maxSpending"]
         knownSolvers = ["HiGHS", "MOSEK"]
         knownOptions = [
-            "units",
-            "maxRothConversion",
-            "netSpending",
-            "spendingSlack",
             "bequest",
             "bigM",
+            "maxRothConversion",
+            "netSpending",
             "noRothConversions",
-            "withMedicare",
-            "solver",
             "previousMAGIs",
+            "solver",
+            "spendingSlack",
+            "startRothConversions",
+            "units",
+            "withMedicare",
         ]
         # We will modify options if required.
         if options is None:

owlplanner-2025.4.2/src/owlplanner/version.py

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

{owlplanner-2025.3.30 → owlplanner-2025.4.2}/ui/About_Owl.py

@@ -30,6 +30,7 @@ Copyright © 2024 - Martin-D. Lacasse
     [Seaborn](https://seaborn.pydata.org),
     [Scipy](https://scipy.org),
     [openpyxl](https://openpyxl.readthedocs.io),
+    [odfpy](https://https://pypi.org/project/odfpy),
     [toml](https://toml.io),
  and [Streamlit](https://streamlit.io) for the front-end
 - Contributors: Josh (noimjosh@gmail.com) for Docker image code.
@@ -41,7 +42,7 @@ or directly by [email](mailto://martin.d.lacasse@gmail.com).
 
 #### :orange[Privacy]
 - This app does not store or forward any information. All data entered is lost
-after a session is closed. You can choose to download selected part of your
+after a session is closed. You can choose to download selected parts of your
 own data to your computer before closing the session.
 
 #### :orange[Disclaimer]

{owlplanner-2025.3.30 → owlplanner-2025.4.2}/ui/Current_Assets.py

@@ -51,7 +51,8 @@ else:
         col1, col2, col3 = st.columns(3, gap="large", vertical_alignment="top")
         with col1:
             kz.initKey("surplusFraction", 0.5)
-            helpmsg = "When beneficiary fractions are not all 1, set surplus deposits to all go to survivor's account."
+            helpmsg = ("When beneficiary fractions not all 1, "
+                       "set surplus deposits to all go to account of first spouse to pass.")
             ret = kz.getNum(
                 f"Fraction deposited in {iname1}'s taxable account",
                 "surplusFraction",

{owlplanner-2025.3.30 → owlplanner-2025.4.2}/ui/Documentation.py

@@ -55,7 +55,8 @@ are entered and reported in unit dollars.
 
 If you are accessing Owl through the Chrome browser,
 the performance manager might be configured to disable hidden or inactive tabs.
-This will cause your Owl session to inadvertently reset, and losing the state of the calculator.
+This could cause your Owl session to inadvertently reset when idling for too long,
+and losing the state of the calculator.
 To avoid this, configure Chrome to keep the page active using
 `More Tools` -> `Performance` -> `Always keep these sites active` and
 add the site *owlplanner.streamlit.app*.
@@ -80,8 +81,13 @@ and life expectancies are required. A starting date for the plan determines when
 starts in the first year. Plan still ends at the end of the year when all individuals
 have passed according to the specified life expectancies.
 
+A typical workflow will involve creating
+a base case, and duplicating it a few times with slight parameter changes
+for investigating the resulting effects.
+It is recommended to rename the case to reflect the change in parameters.
 When duplicating a scenario, make sure to visit all pages in the **Case Setup** section
-and verify that all parameters are as intended.
+and verify that all parameters are as intended. When all cases were succussfully run,
+results of the different cases can be compared side-by-side in the `Output Files` section.
 
 ##### Initializing the life parameters for the realization
 Start with the `Case selector` box and choose one of `New case...` or `Upload case file...`.
@@ -276,6 +282,8 @@ button is toggled, in which case Roth conversions will not be optimized,
 but will rather be performed according to
 the `Roth conv` column on the
 [Wages and Contributions](#wages-and-contributions) page.
+A year from which Roth conversions can begin to be considered can also be selected: no Roth
+conversions will be allowed before the year specified.
 
 Calculations of Medicare and IRMAA can be turned on or off. This will typically speed up
 the calculations by a factor of 2 to 3, which can be useful when running Monte Carlo simulations.

{owlplanner-2025.3.30 → owlplanner-2025.4.2}/ui/Optimization_Parameters.py

@@ -1,4 +1,5 @@
 import streamlit as st
+from datetime import date
 
 import sskeys as kz
 import owlbridge as owb
@@ -49,10 +50,15 @@ else:
         kz.initKey("readRothX", False)
         fromFile = kz.getKey("readRothX")
         kz.initKey("maxRothConversion", 50)
-        ret = kz.getNum("Maximum Roth conversion (\\$k)", "maxRothConversion", disabled=fromFile, help=helpmsg)
+        ret = kz.getNum("Maximum annual Roth conversion (\\$k)", "maxRothConversion", disabled=fromFile, help=helpmsg)
         ret = kz.getToggle("Convert as in wages and contributions tables", "readRothX")
 
     with col2:
+        helpmsg = "Do not perform Roth conversions before that year."
+        thisyear = date.today().year
+        kz.initKey("startRothConversions", thisyear)
+        ret = kz.getIntNum("Year to start considering Roth conversions", "startRothConversions", min_value=thisyear,
+                           disabled=fromFile, help=helpmsg)
         if kz.getKey("status") == "married":
             iname1 = kz.getKey("iname1")
             choices = ["None", iname0, iname1]

{owlplanner-2025.3.30 → owlplanner-2025.4.2}/ui/requirements.txt

@@ -3,8 +3,9 @@ matplotlib
 seaborn
 pandas
 openpyxl
+odfpy
 scipy
 streamlit
 toml
 # --extra-index-url https://test.pypi.org/simple
-owlplanner >= 2025.03.30
+owlplanner >= 2025.04.02

{owlplanner-2025.3.30 → owlplanner-2025.4.2}/ui/sskeys.py

@@ -360,7 +360,7 @@ def getSolveParameters():
         objective = "maxBequest"
 
     options = {}
-    optList = ["netSpending", "maxRothConversion", "noRothConversions",
+    optList = ["netSpending", "maxRothConversion", "noRothConversions", "startRothConversions",
                "withMedicare", "bequest", "solver", "spendingSlack"]
     for opt in optList:
         val = getKey(opt)

owlplanner-2025.3.30/src/owlplanner/version.py

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