owlplanner 2025.5.1__tar.gz → 2025.5.2__tar.gz

{owlplanner-2025.5.1 → owlplanner-2025.5.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: owlplanner
-Version: 2025.5.1
+Version: 2025.5.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.5.1 → owlplanner-2025.5.2}/docker/Dockerfile

@@ -1,34 +1,34 @@
-# docker/Dockerfile
-
-FROM python:3.13-slim
-
-WORKDIR /app
-
-RUN apt-get update; \
-    apt-get upgrade; \
-    apt-get install -y --no-install-recommends \
-        curl \
-        git \
-    ; \
-    rm -rf /var/lib/apt/lists/*
-
-COPY fastentrypoint.sh /usr/bin/entrypoint.sh
-
-RUN chmod 555 /usr/bin/entrypoint.sh
-
-# Build in the container for faster starts.
-RUN python -m pip install --no-cache-dir --upgrade pip
-
-RUN pip install --no-cache-dir build
-
-RUN git clone --depth 1 https://github.com/mdlacasse/Owl.git owl
-
-RUN cd /app/owl && python -m build
-
-RUN cd /app/owl && pip install --no-cache-dir .
-
-EXPOSE 8501
-
-HEALTHCHECK CMD curl --fail http://localhost:8501/_stcore/health
-
-ENTRYPOINT ["/bin/bash", "/usr/bin/entrypoint.sh"]
+# docker/Dockerfile
+
+FROM python:3.13-slim
+
+WORKDIR /app
+
+RUN apt-get update; \
+    apt-get upgrade; \
+    apt-get install -y --no-install-recommends \
+        curl \
+        git \
+    ; \
+    rm -rf /var/lib/apt/lists/*
+
+COPY fastentrypoint.sh /usr/bin/entrypoint.sh
+
+RUN chmod 555 /usr/bin/entrypoint.sh
+
+# Build in the container for faster starts.
+RUN python -m pip install --no-cache-dir --upgrade pip
+
+RUN pip install --no-cache-dir build
+
+RUN git clone --depth 1 https://github.com/mdlacasse/Owl.git owl
+
+RUN cd /app/owl && python -m build
+
+RUN cd /app/owl && pip install --no-cache-dir .
+
+EXPOSE 8501
+
+HEALTHCHECK CMD curl --fail http://localhost:8501/_stcore/health
+
+ENTRYPOINT ["/bin/bash", "/usr/bin/entrypoint.sh"]

{owlplanner-2025.5.1 → owlplanner-2025.5.2}/pyproject.toml

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

{owlplanner-2025.5.1 → owlplanner-2025.5.2}/requirements.txt

@@ -4,6 +4,7 @@ seaborn
 pandas
 openpyxl
 odfpy
+pulp
 scipy
 streamlit
 toml

{owlplanner-2025.5.1 → owlplanner-2025.5.2}/src/owlplanner/plan.py

@@ -1081,6 +1081,9 @@ class Plan(object):
         spLo = 1 - self.lambdha
         spHi = 1 + self.lambdha
 
+        oppCostX = options.get("oppCostX", 0.)
+        xnet = 1 - oppCostX/100.
+
         tau_ijn = np.zeros((Ni, Nj, Nn))
         for i in range(Ni):
             for j in range(Nj):
@@ -1277,7 +1280,7 @@ class Plan(object):
                     row.addElem(_q2(Cd, i, n, Ni, Nn), -fac1 * u.krond(j, 0) * Tau1_ijn[i, 0, n])
                     row.addElem(
                         _q2(Cx, i, n, Ni, Nn),
-                        -fac1 * (u.krond(j, 2) - u.krond(j, 1)) * Tau1_ijn[i, j, n],
+                        -fac1 * (xnet*u.krond(j, 2) - u.krond(j, 1)) * Tau1_ijn[i, j, n],
                     )
 
                     if Ni == 2 and n_d < Nn and i == i_s and n == n_d - 1:
@@ -1288,7 +1291,7 @@ class Plan(object):
                         row.addElem(_q2(Cd, i_d, n, Ni, Nn), -fac2 * u.krond(j, 0) * Tau1_ijn[i_d, 0, n])
                         row.addElem(
                             _q2(Cx, i_d, n, Ni, Nn),
-                            -fac2 * (u.krond(j, 2) - u.krond(j, 1)) * Tau1_ijn[i_d, j, n],
+                            -fac2 * (xnet*u.krond(j, 2) - u.krond(j, 1)) * Tau1_ijn[i_d, j, n],
                         )
                     A.addRow(row, rhs, rhs)
 
@@ -1655,6 +1658,7 @@ class Plan(object):
             "startRothConversions",
             "units",
             "withMedicare",
+            "oppCostX",
         ]
         # We might modify options if required.
         myoptions = dict(options)

owlplanner-2025.5.2/src/owlplanner/version.py

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

{owlplanner-2025.5.1 → owlplanner-2025.5.2}/ui/About_Owl.py

@@ -12,23 +12,24 @@ st.write(f"This is Owl version {owb.version()} running on Streamlit {st.__versio
 
 st.write(
     """
-- Owl is released under GPL Licence through a publicly available
-repository on [GitHub](https://github.com/mdlacasse/owl).
-
+- Owl is an open-source retirement planner capable of optimization through linear programming.
+- Source code is available from a repository on [GitHub](https://github.com/mdlacasse/owl).
 - Mathematical formulation of the linear optimization problem can be
-found [here](https://raw.github.com/mdlacasse/Owl/main/docs/owl.pdf).
+found in this [document](https://raw.github.com/mdlacasse/Owl/main/docs/owl.pdf).
 
-Copyright © 2024 - Martin-D. Lacasse
+Copyright © 2025 - Martin-D. Lacasse
 
 #### :orange[Credits]
 - Historical rates are from [Aswath Damodaran](https://pages.stern.nyu.edu/~adamodar/).
-- Linear programming optimization solver is from [HiGHS](https://highs.dev).
+- Linear programming optimization solvers are from
+[HiGHS](https://highs.dev) and [PuLP](https://coin-or.github.io/pulp/).
 - Owl planner relies on the following [Python](https://python.org) packages:
     - [Matplotlib](https://matplotlib.org),
     [Numpy](https://numpy.org),
     [odfpy](https://https://pypi.org/project/odfpy),
     [openpyxl](https://openpyxl.readthedocs.io),
     [Pandas](https://pandas.pydata.org),
+    [PuLP](https://coin-or.github.io/pulp),
     [Scipy](https://scipy.org),
     [Seaborn](https://seaborn.pydata.org),
     [toml](https://toml.io),
@@ -48,6 +49,10 @@ or directly by [email](mailto://martin.d.lacasse@gmail.com).
 after a session is closed. You can choose to download selected parts of your
 own data to your computer before closing the session.
 
+#### :orange[License]
+- This software is released under the
+[Gnu General Public License v3](https://www.gnu.org/licenses/gpl-3.0.html#license-text).
+
 #### :orange[Disclaimer]
 - This program is provided for educational purposes and comes with no guarantee. Use at your own risk.
 """

{owlplanner-2025.5.1 → owlplanner-2025.5.2}/ui/Documentation.py

@@ -277,6 +277,15 @@ the `Roth conv` column on the
 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.
 
+In order to mitigate cases where Roth conversions can only provide marginal gains,
+an opportunity cost can be set for Roth conversions. This value is
+a percentage amount removed from the Roth conversion to compensate for the
+opportunity loss resulting from the payment of estimated income tax.
+This is a heuristical approach
+creating a virtual penalty on conversions resulting in a smaller amount
+being deposited in the tax-exempt account.
+Opportunity cost is configurable from 0 to 5%. Leave to 0% if unsure.
+
 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.
 If the age of individuals makes them eligible for Medicare within the next three years,

{owlplanner-2025.5.1 → owlplanner-2025.5.2}/ui/Optimization_Parameters.py

@@ -52,6 +52,10 @@ else:
         kz.initKey("maxRothConversion", 50)
         ret = kz.getNum("Maximum annual Roth conversion (\\$k)", "maxRothConversion", disabled=fromFile, help=helpmsg)
         ret = kz.getToggle("Convert as in wages and contributions tables", "readRothX")
+        kz.initKey("oppCostX", 0.)
+        helpmsg = "Estimated opportunity cost for paying estimated tax on Roth conversions."
+        ret = kz.getNum("Opportunity cost for conversion (%)", "oppCostX", step=0.01, format="%.2f",
+                        min_value=0., max_value=5., help=helpmsg)
 
     with col2:
         helpmsg = "Do not perform Roth conversions before that year."
@@ -88,7 +92,8 @@ else:
     if owb.hasMOSEK():
         choices += ["MOSEK"]
     kz.initKey("solver", choices[0])
-    ret = kz.getRadio("Linear programming solver", choices, "solver")
+    helpmsg = "Select different solvers for comparison purposes. Use HiGHS for best performance."
+    ret = kz.getRadio("Linear programming solver", choices, "solver", help=helpmsg)
 
     st.divider()
     st.write("##### Spending Profile")

{owlplanner-2025.5.1 → owlplanner-2025.5.2}/ui/requirements.txt

@@ -8,4 +8,4 @@ pulp
 scipy
 streamlit
 toml
-owlplanner >= 2025.05.01
+owlplanner >= 2025.05.02

{owlplanner-2025.5.1 → owlplanner-2025.5.2}/ui/sskeys.py

@@ -364,7 +364,7 @@ def getSolveParameters():
 
     options = {}
     optList = ["netSpending", "maxRothConversion", "noRothConversions", "startRothConversions",
-               "withMedicare", "bequest", "solver", "spendingSlack"]
+               "withMedicare", "bequest", "solver", "spendingSlack", "oppCostX"]
     for opt in optList:
         val = getKey(opt)
         if val is not None:

owlplanner-2025.5.1/reponse.txt

@@ -1,20 +0,0 @@
-
-Hi Mike,
-
-Thank you so much for the income tax preparation. I have a few questions after reviewing the return:
-
-- Roth conversion was made as an in-plan conversion from a 401k to a Roth-401k. Do we still need form 8606?
-- Out of curiosity, Roth conversion was for $240,000.00 with 0.79 deamed coming from a designated Roth contribution. Why was the $1 been added as a taxable item in statement 4? This is a minor point (and therefore can stay as is). Just curiosity as I said.
-- How do I pay your fees?
-
-Questions for the future:
-- You mentioned that the 2023 filing has to be corrected. Is it to my benefit or against it?
-- I am planning to stop my consulting job at the end of May. Would it still be worth creating a Corporation for 5 months?
-- I will probably move to FL later this year (I was in Atlanta for my daughter - she will likely move to CA shortly).  I am planning to perform another large Roth conversion this year (preventing large RMDs). I will need your advice as to when to proceed.
-
-
-I submitted signed form 8879 through your portal.
-
-Thanks again,
-
-Martin

owlplanner-2025.5.1/src/owlplanner/version.py

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

owlplanner-2025.5.1/ttt.py

@@ -1,13 +0,0 @@
-import streamlit as st
-from streamlit_extras.let_it_rain import rain
-
-def example():
-    rain(
-        # emoji="🦉",
-        emoji="🦩",
-        font_size=48,
-        falling_speed=5,
-        animation_length=1,
-    )
-
-example()

owlplanner-2025.5.1/ttt2.py

@@ -1,24 +0,0 @@
-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.5.1/ttt3.py

@@ -1,6 +0,0 @@
-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}")