owlplanner 2025.2.20__tar.gz → 2025.2.22__tar.gz

{owlplanner-2025.2.20 → owlplanner-2025.2.22}/PKG-INFO

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

@@ -607,8 +607,7 @@ add the market returns to the savings balances.
 	if needed due to RMDs or receiving large sums of money,
 	could be made at the end of the year. Let's formulate this approach
 	in more detail and investigate for potential problems.
-	Timing controls which terms get multiplied by the rate of return $(1 + \tau_{kn})$
-	for a particular asset $k$.
+	Timing controls which terms get multiplied by the rate of return $(1 + \mathcal{T}_{ijn})$.
 	Therefore, our current choice would yield
 	\begin{eqnarray}
 		\label{Eq:C3a}

{owlplanner-2025.2.20 → owlplanner-2025.2.22}/examples/case_jack+jill.toml

@@ -1,4 +1,5 @@
 "Plan Name" = "jack+jill"
+Description = "This example case is for Jack and Jill, a married couple."
 
 ["Basic Info"]
 Status = "married"

{owlplanner-2025.2.20 → owlplanner-2025.2.22}/examples/case_joe.toml

@@ -1,4 +1,5 @@
 "Plan Name" = "joe"
+Description = "This example case is for Joe, a single individual."
 
 ["Basic Info"]
 Status = "single"

{owlplanner-2025.2.20 → owlplanner-2025.2.22}/examples/case_john+sally.toml

@@ -1,4 +1,5 @@
 "Plan Name" = "john+sally"
+Description = "This example reproduces the case of John and Sally, discussed by Eric Sajdak."
 
 ["Basic Info"]
 Status = "married"

owlplanner-2025.2.22/examples/case_jon+jane.toml

@@ -0,0 +1,57 @@
+"Plan Name" = "Jon+Jane"
+Description = "The case of Jon and Jane was the base case discussed by i-orp."
+
+["Basic Info"]
+Status = "married"
+Names = [ "Jon", "Jane",]
+"Birth year" = [ 1965, 1968,]
+"Life expectancy" = [ 92, 92,]
+"Start date" = "01-01"
+
+[Assets]
+"taxable savings balances" = [ 50.0, 0.0,]
+"tax-deferred savings balances" = [ 900.0, 500.0,]
+"tax-free savings balances" = [ 0.0, 0.0,]
+"Beneficiary fractions" = [ 1.0, 1.0, 1.0,]
+"Spousal surplus deposit fraction" = 0.0
+
+["Wages and Contributions"]
+"Contributions file name" = "edited values"
+
+["Fixed Income"]
+"Pension amounts" = [ 0.0, 0.0,]
+"Pension ages" = [ 65, 65,]
+"Pension indexed" = [ false, false,]
+"Social security amounts" = [ 21.0, 21.0,]
+"Social security ages" = [ 65, 65,]
+
+["Rates Selection"]
+"Heirs rate on tax-deferred estate" = 30.0
+"Long-term capital gain tax rate" = 15.0
+"Dividend tax rate" = 2.0
+"TCJA expiration year" = 2026
+Method = "user"
+Values = [ 10.0, 0.0, 0.0, 3.5000000000000004,]
+From = 1928
+To = 2024
+
+["Asset Allocation"]
+"Interpolation method" = "linear"
+"Interpolation center" = 15.0
+"Interpolation width" = 5.0
+Type = "individual"
+generic = [ [ [ 100, 0, 0, 0,], [ 100, 0, 0, 0,],], [ [ 100, 0, 0, 0,], [ 100, 0, 0, 0,],],]
+
+["Optimization Parameters"]
+"Spending profile" = "flat"
+"Surviving spouse spending percent" = 60
+Objective = "maxSpending"
+
+["Solver Options"]
+maxRothConversion = 0.0
+noRothConversions = "None"
+withMedicare = true
+bequest = 30.0
+
+[Results]
+"Default plots" = "today"

{owlplanner-2025.2.20 → owlplanner-2025.2.22}/examples/case_kim+sam-bequest.toml

@@ -1,4 +1,5 @@
 "Plan Name" = "kim+sam-bequest"
+Description = "Kim and Sam is an example case for optimizing bequest and Roth conversions."
 
 ["Basic Info"]
 Status = "married"

{owlplanner-2025.2.20 → owlplanner-2025.2.22}/examples/case_kim+sam-spending.toml

@@ -1,4 +1,5 @@
 "Plan Name" = "kim+sam-spending"
+Description = "Kim and Sam is an example case for optimizing spending and Roth conversions."
 
 ["Basic Info"]
 Status = "married"

{owlplanner-2025.2.20 → owlplanner-2025.2.22}/pyproject.toml

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

{owlplanner-2025.2.20 → owlplanner-2025.2.22}/src/owlplanner/config.py

@@ -28,6 +28,7 @@ def saveConfig(plan, file, mylog):
 
     diconf = {}
     diconf["Plan Name"] = plan._name
+    diconf["Description"] = plan._description
 
     # Basic Info.
     diconf["Basic Info"] = {
@@ -180,11 +181,12 @@ def readConfig(file, *, verbose=True, logstreams=None, readContributions=True):
     # status = diconf['Basic Info']['Status']
     yobs = diconf["Basic Info"]["Birth year"]
     expectancy = diconf["Basic Info"]["Life expectancy"]
-    startDate = diconf["Basic Info"]["Start date"]
+    startDate = diconf["Basic Info"].get("Start date", "today")
     icount = len(yobs)
     s = ["", "s"][icount - 1]
     mylog.vprint(f"Plan for {icount} individual{s}: {inames}.")
     p = plan.Plan(inames, yobs, expectancy, name, startDate=startDate, verbose=True, logstreams=logstreams)
+    plan._description = diconf.get("Description", "")
 
     # Assets.
     balances = {}
@@ -295,6 +297,11 @@ def readConfig(file, *, verbose=True, logstreams=None, readContributions=True):
     # Solver Options.
     p.solverOptions = diconf["Solver Options"]
 
+    # Check consistency of noRothConversions.
+    name = p.solverOptions.get("noRothConversions", "None")
+    if name != "None" and name not in p.inames:
+        raise ValueError(f"Unknown name {name} for noRothConversions.")
+
     # Results.
     p.setDefaultPlots(diconf["Results"]["Default plots"])
 

{owlplanner-2025.2.20 → owlplanner-2025.2.22}/src/owlplanner/plan.py

@@ -239,6 +239,7 @@ class Plan(object):
         self.interpCenter = 15
         self.interpWidth = 5
 
+        self._description = ''
         self.defaultPlots = "nominal"
         self.defaultSolver = "HiGHS"
 
@@ -406,6 +407,12 @@ class Plan(object):
         self.mylog.vprint(f"Renaming plan {self._name} -> {newname}.")
         self._name = newname
 
+    def setDescription(self, description):
+        """
+        Set a text description of the plan.
+        """
+        self._description = description
+
     def setSpousalDepositFraction(self, eta):
         """
         Set spousal deposit and withdrawal fraction. Default 0.5.
@@ -2069,6 +2076,8 @@ class Plan(object):
         now = self.year_n[0]
         dic = {}
         # Results
+        dic["Plan name"] = self._name
+        dic["Brief description"] = self._description
         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[f"Net spending remaining in year {now}"] = u.d(self.g_n[0])
@@ -2895,7 +2904,7 @@ def _stackPlot(x, inames, title, irange, series, snames, location, yformat="\\$k
 
     if len(nonzeroSeries) == 0:
         # print('Nothing to plot for', title)
-        return None
+        return None, None
 
     fig, ax = plt.subplots(figsize=(6, 4))
     plt.grid(visible="both")

owlplanner-2025.2.22/src/owlplanner/version.py

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

{owlplanner-2025.2.20 → owlplanner-2025.2.22}/ui/Create_Case.py

@@ -40,7 +40,6 @@ else:
             on_change=kz.renameCase,
             args=["caseNewName"],
             key="_caseNewName",
-            placeholder="Enter a name",
             help=helpmsg,
         )
 
@@ -61,6 +60,10 @@ else:
             horizontal=True,
         )
 
+    kz.initKey("description", "")
+    helpmsg = "Provide a short distinguishing description of the case."
+    description = kz.getText("Brief description", "description", help=helpmsg)
+
     col1, col2 = st.columns(2, gap="large", vertical_alignment="top")
     with col1:
         kz.initKey("iname0", "")

{owlplanner-2025.2.20 → owlplanner-2025.2.22}/ui/owlbridge.py

@@ -98,6 +98,7 @@ def prepareRun(plan):
             st.error(f"Failed setting beneficiary fractions: {e}")
             return
 
+    plan.setDescription(kz.getKey("description"))
     plan.setHeirsTaxRate(kz.getKey("heirsTx"))
     plan.setLongTermCapitalTaxRate(kz.getKey("gainTx"))
     plan.setDividendRate(kz.getKey("divRate"))
@@ -422,7 +423,11 @@ def plotSingleResults(plan):
         st.write("##### Assets Distribution")
         morecols = st.columns(3, gap="small")
         for fig in figs:
-            morecols[c].pyplot(fig)
+            if fig:
+                morecols[c].pyplot(fig)
+            else:
+                morecols[c].write("#\n<div style='text-align: center'> This plot is empty </div>",
+                                  unsafe_allow_html=True)
             c = (c + 1) % 3
 
 
@@ -557,6 +562,7 @@ def genDic(plan):
     dic = {}
     dic["plan"] = plan
     dic["name"] = plan._name
+    dic["description"] = plan._description
     dic["summary"] = ""
     dic["casetoml"] = ""
     dic["caseStatus"] = "new"

{owlplanner-2025.2.20 → owlplanner-2025.2.22}/ui/requirements.txt

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

{owlplanner-2025.2.20 → owlplanner-2025.2.22}/ui/sskeys.py

@@ -438,7 +438,7 @@ def getNum(
     )
 
 
-def getText(text, nkey, disabled=False, callback=setpull, placeholder=None):
+def getText(text, nkey, disabled=False, callback=setpull, placeholder=None, help=None):
     return st.text_input(
         text,
         value=getKey(nkey),
@@ -447,6 +447,7 @@ def getText(text, nkey, disabled=False, callback=setpull, placeholder=None):
         args=[nkey],
         key="_" + nkey,
         placeholder=placeholder,
+        help=help,
     )
 
 

owlplanner-2025.2.20/src/owlplanner/version.py

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