owlplanner 2025.3.16__tar.gz → 2025.3.27__tar.gz

{owlplanner-2025.3.16 → owlplanner-2025.3.27}/PKG-INFO

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

@@ -288,6 +288,10 @@ or an s-curve as in
 	These are large expenses or influx of money
 	that can be planned. Therefore, $\Lambda^\pm$ can be positive
 	(e.g., sell a house, inheritance) or negative (e.g., buy a house, large gifts).
+\item [$\lambda$]
+        Allowed deviation from the desired net spending profile during one year. Parameter
+        $\lambda$ can be better understood as a percentage.
+
 \item [$\pi_{in}$]
 	Sum of pension benefits for individual $i$ in year $n$. These amounts are typically
 	specified along with the ages at which these benefits begin.
@@ -1237,14 +1241,38 @@ minimize the inner product $c\cdot y$, where $c$ is
 \end{eqnarray}
 and 0 otherwise. See Eq.~\ref{Eq:C5}.
 
+\paragraph*{Maximum variable net spending}
+If instead of maximizing a basis for net spending that is multiplied by a profile $\bar{\xi}_n$,
+one maximizes the sum of net spending over the full duration
+of the plan, in today's dollars. In that case, the quantity to optimize is
+\begin{eqnarray}
+	c[q_g(n)] &=& -1/\gamma_n,
+\end{eqnarray}
+and 0 otherwise.
+In that case, constraint equality Eq.~\ref{Eq:C5} will need to be changed to an inequality. 
+Instead of obeying 
+\begin{equation}
+	g_n \xi_0 - g_0 \bar{\xi}_n = 0,
+\end{equation}
+we now impose the following inequality constraint
+\begin{equation}
+        \label{Eq:C15}
+	(1 - \lambda/100) g_0 \bar{\xi}_n/\xi_0 <= g_n <= (1 + \lambda/100) g_0 \bar{\xi}_n/\xi_0 ,
+\end{equation}
+where $\lambda$ is the percentage that the annual net spending is allowed to deviate
+from the desired profile. It should be noticed that when $\lambda = 0$ the two
+last equations are equivalent.
+
 \paragraph*{Maximum bequest}
-If, on the other hand, one would like to maximize the bequest under the constraint of a desired net spending $g_o$,
+If, on the other hand, one would like to maximize the bequest under the constraint of a desired
+net spending $g_o$, specified for the first year,
 one would add the following row to $A_ey = v$
 \begin{eqnarray}
 	\label{Eq:FixedIncome}
 	A_e[I(0), q_g(0)] &=& 1, \nonumber \\
-	v[I(0)] &=& g_o.
+	v[I(0)] &=& g_o,
 \end{eqnarray}
+subject to the net spending $g_n$ obeying Eq.~\ref{Eq:C5} over time.
 
 The objective function would then be derived from Eq.~(\ref{Eq:Bequest}) as
 minimizing the inner product $c\cdot y$, where $c$ is

{owlplanner-2025.3.16 → owlplanner-2025.3.27}/pyproject.toml

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

{owlplanner-2025.3.16 → owlplanner-2025.3.27}/src/owlplanner/plan.py

@@ -307,6 +307,9 @@ class Plan(object):
         # Previous 2 years for Medicare.
         self.prevMAGI = np.zeros((2))
 
+        # Default slack on profile.
+        self.lambdha = 0
+
         # Scenario starts at the beginning of this year and ends at the end of the last year.
         s = ["", "s"][self.N_i - 1]
         self.mylog.vprint(f"Preparing scenario of {self.N_n} years for {self.N_i} individual{s}.")
@@ -1071,6 +1074,9 @@ class Plan(object):
         Cx = self.C["x"]
         Cz = self.C["z"]
 
+        spLo = 1 - self.lambdha
+        spHi = 1 + self.lambdha
+
         tau_ijn = np.zeros((Ni, Nj, Nn))
         for i in range(Ni):
             for j in range(Nj):
@@ -1191,7 +1197,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))
-            A.addNewRow({_q1(Cg, 0): 1}, spending, spending)
+            A.addNewRow({_q1(Cg, 0): 1}, spLo * spending, spHi * spending)
 
         # Set initial balances through constraints.
         for i in range(Ni):
@@ -1297,8 +1303,10 @@ class Plan(object):
 
         # Impose income profile.
         for n in range(1, Nn):
-            rowDic = {_q1(Cg, 0, Nn): -self.xiBar_n[n], _q1(Cg, n, Nn): self.xiBar_n[0]}
-            A.addNewRow(rowDic, zero, zero)
+            rowDic = {_q1(Cg, 0, Nn): -spLo * self.xiBar_n[n], _q1(Cg, n, Nn): self.xiBar_n[0]}
+            A.addNewRow(rowDic, zero, inf)
+            rowDic = {_q1(Cg, 0, Nn): spHi * self.xiBar_n[n], _q1(Cg, n, Nn): -self.xiBar_n[0]}
+            A.addNewRow(rowDic, zero, inf)
 
         # Taxable ordinary income.
         for n in range(Nn):
@@ -1362,7 +1370,9 @@ class Plan(object):
         # Now build a solver-neutral objective vector.
         c = abc.Objective(self.nvars)
         if objective == "maxSpending":
-            c.setElem(_q1(Cg, 0, Nn), -1)
+            # c.setElem(_q1(Cg, 0, Nn), -1)
+            for n in range(Nn):
+                c.setElem(_q1(Cg, n, Nn), -1/self.gamma_n[n])
         elif objective == "maxBequest":
             for i in range(Ni):
                 c.setElem(_q3(Cb, i, 0, Nn, Ni, Nj, Nn + 1), -1)
@@ -1608,6 +1618,7 @@ class Plan(object):
             "units",
             "maxRothConversion",
             "netSpending",
+            "spendingSlack",
             "bequest",
             "bigM",
             "noRothConversions",
@@ -1642,6 +1653,7 @@ class Plan(object):
         if objective == "maxSpending" and "bequest" not in myoptions:
             self.mylog.vprint("Using bequest of $1.")
 
+        self.prevMAGI = np.zeros(2)
         if "previousMAGIs" in myoptions:
             magi = myoptions["previousMAGIs"]
             if len(magi) != 2:
@@ -1653,6 +1665,13 @@ class Plan(object):
                 units = 1000
             self.prevMAGI = units * np.array(magi)
 
+        self.lambdha = 0
+        if "spendingSlack" in myoptions:
+            lambdha = myoptions["spendingSlack"]
+            if lambdha < 0 or lambdha > 50:
+                raise ValueError(f"Slack value out of range {lambdha}.")
+            self.lambdha = lambdha / 100
+
         self._adjustParameters()
 
         if "solver" in options:

owlplanner-2025.3.27/src/owlplanner/version.py

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

owlplanner-2025.3.27/ttt2.py

@@ -0,0 +1,24 @@
+import streamlit as st
+from streamlit_theme import st_theme
+
+header = st.container()
+with header:
+    # Print the entire theme dictionary
+    st.write("Getting theme settings...")
+
+    # Get the current theme
+    current_theme = st_theme()
+
+if current_theme:
+    print(current_theme)
+else:
+    print('Got none', current_theme)
+
+# Check if the theme is dark or light
+# if current_theme["isDark"]:
+    # st.write("Current theme is dark")
+# else:
+    # st.write("Current theme is light")
+
+# Print the entire theme dictionary
+st.write("Current theme settings:", current_theme)

owlplanner-2025.3.27/ttt3.py

@@ -0,0 +1,6 @@
+import streamlit as st
+
+bc = st.get_option("theme.backgroundColor")
+tc = st.get_option("theme.textColor")
+
+st.write(f"text color is {tc} with background color {bc}")

{owlplanner-2025.3.16 → owlplanner-2025.3.27}/ui/About_Owl.py

@@ -4,8 +4,8 @@ import sskeys as kz
 import owlbridge as owb
 
 
-st.write("## About Owl 🦉")
-kz.orangeDivider()
+st.write("# About Owl 🦉")
+kz.divider("orange")
 
 st.write(f"This is Owl version {owb.version()} running on Streamlit {st.__version__}.")
 # st.balloons()

{owlplanner-2025.3.16 → owlplanner-2025.3.27}/ui/Documentation.py

@@ -4,8 +4,8 @@ import sskeys as kz
 
 col1, col2, col3 = st.columns([0.69, 0.02, 0.29], gap="large")
 with col1:
-    st.write("## Documentation")
-    kz.orangeDivider()
+    st.write("# Documentation")
+    kz.divider("orange")
     st.write("## Owl Retirement Planner\n-------")
 with col3:
     st.image("http://raw.github.com/mdlacasse/Owl/main/docs/images/owl.png")
@@ -390,12 +390,6 @@ when considering Monte Carlo simulations, consider:
 #### Logs
 Messages coming from the underlying Owl calculation engine are displayed on this page.
 
-#### Settings
-This page contains global settings. At the current time, there is only a single
-option for choosing the style used for the graphs. Some color
-schemes are best suited for colorblind individuals. The *classic* offers good contrast, while
-*petroff10* presents other distinguishing colors.
-
 #### Documentation
 These very pages.
 

{owlplanner-2025.3.16 → owlplanner-2025.3.27}/ui/Optimization_Parameters.py

@@ -13,7 +13,7 @@ kz.initKey("smileDelay", 0)
 
 
 def initProfile():
-    owb.setProfile(profileChoices[0], False)
+    owb.setProfile(None)
 
 
 ret = kz.titleBar("Optimization Parameters")
@@ -88,29 +88,28 @@ else:
     col1, col2, col3 = st.columns(3, gap="medium", vertical_alignment="top")
     with col1:
         ret = kz.getRadio("Type of profile", profileChoices, "spendingProfile", callback=owb.setProfile)
+        if kz.getKey("spendingProfile") == "smile":
+            helpmsg = "Time in year before spending starts decreasing."
+            ret = kz.getIntNum(
+                "Smile delay (in years from now)", "smileDelay", max_value=30, help=helpmsg, callback=owb.setProfile
+            )
     with col2:
+        kz.initKey("spendingSlack", 0)
+        helpmsg = "Percentage allowed to deviate from spending profile."
+        ret = kz.getIntNum("Profile slack (%)", "spendingSlack", max_value=50, help=helpmsg)
+        if kz.getKey("spendingProfile") == "smile":
+            helpmsg = "Percentage to decrease for the slow-go years."
+            ret = kz.getIntNum("Smile dip (%)", "smileDip", max_value=100, help=helpmsg, callback=owb.setProfile)
+    with col3:
         if kz.getKey("status") == "married":
             helpmsg = "Percentage of spending required for the surviving spouse."
             ret = kz.getIntNum(
                 "Survivor's spending (%)", "survivor", max_value=100, help=helpmsg, callback=owb.setProfile
             )
         if kz.getKey("spendingProfile") == "smile":
-            helpmsg = "Time in year before spending starts decreasing."
-            ret = kz.getIntNum(
-                "Smile delay (in years from now)", "smileDelay", max_value=30, help=helpmsg, callback=owb.setProfile
-            )
-            with col3:
-                helpmsg = "Percentage to decrease for the slow-go years."
-                ret = kz.getIntNum("Smile dip (%)", "smileDip", max_value=100, help=helpmsg, callback=owb.setProfile)
-                helpmsg = "Percentage to increase (or decrease) over time period."
-                ret = kz.getIntNum(
-                    "Smile increase (%)",
-                    "smileIncrease",
-                    min_value=-100,
-                    max_value=100,
-                    help=helpmsg,
-                    callback=owb.setProfile,
-                )
+            helpmsg = "Percentage to increase (or decrease) over time period."
+            ret = kz.getIntNum("Smile increase (%)", "smileIncrease",
+                               min_value=-100, max_value=100, help=helpmsg, callback=owb.setProfile)
 
     st.divider()
     col1, col2 = st.columns(2, gap="small")

{owlplanner-2025.3.16 → owlplanner-2025.3.27}/ui/Output_Files.py

@@ -17,7 +17,9 @@ else:
         caseName = kz.getKey("name")
         df = kz.compareSummaries()
         if df is not None:
-            st.write("#### Synopsis")
+            st.write("#### Synopsis\n"
+                     "This table provides a summary of the current case and"
+                     " compares it with other similar cases that ran successfully.")
             styledDf = df[1:].style.map(kz.colorBySign)
             st.dataframe(styledDf, use_container_width=True)
             st.caption("Values with [legend] are nominal, otherwise in today's \\$.")
@@ -27,7 +29,9 @@ else:
             )
 
         st.divider()
-        st.write("#### Excel workbooks")
+        st.write("#### Excel workbooks\n"
+                 "These workbooks contain time tables describing the flow of money,"
+                 " the first one as input to the case, and the second as its output.")
         col1, col2 = st.columns(2, gap="large")
         with col1:
             download2 = st.download_button(
@@ -52,7 +56,9 @@ else:
         lines = kz.getKey("casetoml")
         if lines != "":
             st.divider()
-            st.write("#### Case parameter file")
+            st.write("#### Case parameter file\n"
+                     "This file contains the parameters characterizing the current case"
+                     " and can be used, along with the *Wages and Contributions* file, to reproduce it in the future.")
             st.code(lines, language="toml")
 
             st.download_button(

{owlplanner-2025.3.16 → owlplanner-2025.3.27}/ui/Quick_Start.py

@@ -8,7 +8,7 @@ with col3:
     st.caption("Retirement planner with great wisdom")
 with col1:
     st.write("# Owl Retirement Planner\nA retirement exploration tool based on linear programming")
-    kz.orangeDivider()
+    kz.divider("orange")
     st.write("### Quick Start")
     st.markdown(
         """

{owlplanner-2025.3.16 → owlplanner-2025.3.27}/ui/Rates_Selection.py

@@ -41,6 +41,7 @@ def initRates():
         updateFixedRates(fixedChoices[0], False)
     else:
         owb.setRates()
+    kz.flagModified()
 
 
 kz.initKey("rateType", rateChoices[0])

{owlplanner-2025.3.16 → owlplanner-2025.3.27}/ui/Settings.py

@@ -11,7 +11,7 @@ col1, col2, col3 = st.columns(3, gap="large")
 with col1:
     st.write("#### Graphs appearance style")
     key = "plot_style"
-    kz.initGlobalKey(key, plots.styles[0])
+    kz.initGlobalKey("_"+key, plots.styles[0])
     helpmsg = "Select color style for graphs."
     st.selectbox(
         "Select plot style",

{owlplanner-2025.3.16 → owlplanner-2025.3.27}/ui/Wages_And_Contributions.py

@@ -4,20 +4,12 @@ import sskeys as kz
 import owlbridge as owb
 
 
-# Refresh Wages and Contributions tables as time window likely to change.
-def resetTimeLists():
-    # if not kz.getKey("duplicate"):
-    tlists = owb.resetContributions()
-    for i, iname in enumerate(tlists):
-        kz.setKey("timeList" + str(i), tlists[iname])
-
-
 ret = kz.titleBar("Wages and Contributions")
 
 if ret is None or kz.caseHasNoPlan():
     st.info("Case(s) must be first created before running this page.")
 else:
-    kz.runOncePerCase(resetTimeLists)
+    kz.runOncePerCase(owb.resetTimeLists)
     kz.initKey("stTimeLists", None)
     n = 2 if kz.getKey("status") == "married" else 1
 
@@ -66,4 +58,4 @@ else:
         newdf.fillna(0, inplace=True)
         kz.storeKey("_timeList" + str(i), newdf)
 
-    st.button("Reset to zero", help="Reset all values to zero.", on_click=resetTimeLists)
+    st.button("Reset to zero", help="Reset all values to zero.", on_click=owb.resetTimeLists)

{owlplanner-2025.3.16 → owlplanner-2025.3.27}/ui/main.py

@@ -2,7 +2,7 @@ import streamlit as st
 
 import sskeys as kz
 
-# Pick one for narrow or wide graphs. That can be changed in upper-right settings menu.
+# Pick one for narrow or wide graphs. That can also be changed in upper-right settings menu.
 st.set_page_config(layout="wide", page_title="Owl Retirement Planner")
 # st.set_page_config(layout="centered", page_title="Owl Retirement Planner")
 
@@ -31,7 +31,8 @@ pages = {
     ],
     "Resources": [
         st.Page("Logs.py", icon=":material/error:"),
-        st.Page("Settings.py", icon=":material/settings:"),
+        # Graph style needs a rewrite of plot() to avoid cross-talk between sessions.
+        # st.Page("Settings.py", icon=":material/settings:"),
         st.Page("Quick_Start.py", icon=":material/rocket_launch:", default=True),
         st.Page("Documentation.py", icon=":material/help:"),
         st.Page("About_Owl.py", icon=":material/info:"),

{owlplanner-2025.3.16 → owlplanner-2025.3.27}/ui/owlbridge.py

@@ -42,6 +42,10 @@ def createPlan():
     val = kz.getKey("plots")
     if val is not None:
         plan.setDefaultPlots(val)
+    if kz.getKey("spendingProfile"):
+        setProfile(None)
+    resetTimeLists()
+
     st.toast(f"Created new case *'{name}'*. You can now move to the next page.")
 
 
@@ -353,6 +357,12 @@ def resetContributions(plan):
     return plan.zeroContributions()
 
 
+def resetTimeLists():
+    tlists = resetContributions()
+    for i, iname in enumerate(tlists):
+        kz.setKey("timeList" + str(i), tlists[iname])
+
+
 @_checkPlan
 def setAllocationRatios(plan):
     _setAllocationRatios(plan)
@@ -434,9 +444,11 @@ def plotSingleResults(plan):
 
 
 @_checkPlan
-def setProfile(plan, key, pull=True):
-    if pull:
+def setProfile(plan, key):
+    if key is not None:
         kz.setpull(key)
+    else:
+        kz.flagModified()
     profile = kz.getKey("spendingProfile")
     survivor = kz.getKey("survivor")
     dip = kz.getKey("smileDip")

{owlplanner-2025.3.16 → owlplanner-2025.3.27}/ui/plots.py

@@ -6,10 +6,12 @@ import sskeys as kz
 
 def changeStyle(key):
     val = kz.getGlobalKey("_" + key)
-    kz.storeGlobalKey(key, val)
+    kz.getGlobalKey(key)
     plt.style.use(val)
-    # This makes all graphs appear have the same height.
-    plt.rcParams.update({'figure.autolayout': True})
+
+
+# This makes all graphs appear have the same height.
+plt.rcParams.update({"figure.autolayout": True})
 
 
 styles = ["default"]

{owlplanner-2025.3.16 → owlplanner-2025.3.27}/ui/requirements.txt

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

{owlplanner-2025.3.16 → owlplanner-2025.3.27}/ui/sskeys.py

@@ -259,9 +259,13 @@ def storepull(key):
 
 def setKey(key, val):
     ss.cases[ss.currentCase][key] = val
+    flagModified()
+    return val
+
+
+def flagModified():
     ss.cases[ss.currentCase]["caseStatus"] = "modified"
     ss.cases[ss.currentCase]["summaryDf"] = None
-    return val
 
 
 def storeKey(key, val):
@@ -356,7 +360,8 @@ def getSolveParameters():
         objective = "maxBequest"
 
     options = {}
-    optList = ["netSpending", "maxRothConversion", "noRothConversions", "withMedicare", "bequest", "solver"]
+    optList = ["netSpending", "maxRothConversion", "noRothConversions",
+               "withMedicare", "bequest", "solver", "spendingSlack"]
     for opt in optList:
         val = getKey(opt)
         if val is not None:
@@ -505,8 +510,16 @@ def getToggle(text, nkey, callback=setpull, disabled=False, help=None):
     )
 
 
-def orangeDivider():
-    st.html("<style> hr {border-color: orange;}</style><hr>")
+def divider(color):
+    st.html("<style> hr {border-color: %s;}</style><hr>" % color)
+
+
+def getColors():
+    def_theme = "dark"
+    bc = "#0E1117" if def_theme == "dark" else "#FFFFFF"
+    fc = "#FAFAFA" if def_theme == "dark" else "#31333F"
+
+    return bc, fc
 
 
 def titleBar(txt, choices=None):
@@ -516,20 +529,41 @@ def titleBar(txt, choices=None):
     else:
         helpmsg = "Select an existing case, or create a new one from scratch or from a *case* parameter file."
 
-    col1, col2 = st.columns(2, gap="large")
-    with col1:
-        st.write("## " + txt)
-    with col2:
-        nkey = txt
-        ret = st.selectbox(
-            "Case selector",
-            choices,
-            help=helpmsg,
-            index=getIndex(currentCaseName(), choices),
-            key="_" + nkey,
-            on_change=switchToCase,
-            args=[nkey],
-        )
-
-    orangeDivider()
+    header = st.container()
+    # header.title("Here is a sticky header")
+    header.write("""<div class='fixed-header'/>""", unsafe_allow_html=True)
+
+    bc, fc = getColors()
+
+    # Custom CSS for the sticky header
+    st.markdown(
+        """<style>
+    div[data-testid="stVerticalBlock"] div:has(div.fixed-header) {
+        border-radius: 10px;
+        position: sticky;
+        background: linear-gradient(to right, #551b1b, #909090);
+        /* background-color: %s; */
+        color: %s;
+        top: 2.875rem;
+        z-index: 999;
+    }
+</style>""" % (bc, fc), unsafe_allow_html=True
+    )
+    with header:
+        col1, col2, col3, col4 = st.columns([0.005, 0.6, 0.4, 0.01], gap="small")
+        with col2:
+            st.write("## " + txt)
+        with col3:
+            nkey = txt
+            ret = st.selectbox(
+                "Case selector",
+                choices,
+                help=helpmsg,
+                index=getIndex(currentCaseName(), choices),
+                key="_" + nkey,
+                on_change=switchToCase,
+                args=[nkey],
+            )
+
+        divider("white")
     return ret