owlplanner 2025.11.3__tar.gz → 2025.11.9__tar.gz

{owlplanner-2025.11.3 → owlplanner-2025.11.9}/INSTALL.md

@@ -1,4 +1,4 @@
-# Owl
+# Owl - Optimal Wealth Lab
 
 ## A retirement exploration tool based on linear programming
 

{owlplanner-2025.11.3 → owlplanner-2025.11.9}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: owlplanner
-Version: 2025.11.3
-Summary: Owl: Retirement planner with great wisdom
+Version: 2025.11.9
+Summary: Owl - Optimal Wealth Lab: Retirement planner with great wisdom
 Project-URL: HomePage, https://github.com/mdlacasse/owl
 Project-URL: Repository, https://github.com/mdlacasse/owl
 Project-URL: Issues, https://github.com/mdlacasse/owl/issues
@@ -684,19 +684,20 @@ License:                     GNU GENERAL PUBLIC LICENSE
         Public License instead of this License.  But first, please read
         <https://www.gnu.org/licenses/why-not-lgpl.html>.
 License-File: LICENSE
-Classifier: Development Status :: 4 - Beta
+Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: End Users/Desktop
 Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
 Classifier: Topic :: Office/Business :: Financial :: Investment
-Requires-Python: >=3.8
+Requires-Python: >=3.10
+Requires-Dist: highspy
 Requires-Dist: matplotlib
 Requires-Dist: numpy
 Requires-Dist: odfpy
 Requires-Dist: openpyxl
 Requires-Dist: pandas
-Requires-Dist: plotly
+Requires-Dist: plotly>=6.3
 Requires-Dist: pulp
 Requires-Dist: scipy
 Requires-Dist: seaborn
@@ -705,7 +706,7 @@ Requires-Dist: toml
 Description-Content-Type: text/markdown
 
 
-# Owl   
+# Owl - Optimal Wealth Lab
 
 ## A retirement exploration tool based on linear programming
 
@@ -750,13 +751,17 @@ your strategy under different market assumptions, helping to better understand y
 
 -------------------------------------------------------------------------------------
 ## Purpose and vision
-The goal of Owl is to create a free and open-source ecosystem that has cutting-edge optimization capabilities,
+One goal of Owl is to provide a free and open-source ecosystem that has cutting-edge optimization capabilities,
 allowing for the next generation of Python-literate retirees to experiment with their own financial future
-while providing a codebase where they can learn and contribute. There are and were
+while providing a codebase where they can learn and contribute. At the same time, an intuitive and easy-to-use
+user interface based on Streamlit allows a broad set of users to benefit from the application as it only requires basic financial knowledge.
+
+There are and were
 good retirement optimizers in the recent past, but the vast majority of them are either proprietary platforms
 collecting your data, or academic papers that share the results without really sharing the details of
 the underlying mathematical models.
-The algorithms in Owl rely on the open-source HiGHS linear programming solver. The complete formulation and
+The algorithms in Owl rely on the open-source HiGHS linear programming solver and but they have also been ported to
+other platforms such as Mosek and COIN-OR. The complete formulation and
 detailed description of the underlying
 mathematical model can be found [here](https://github.com/mdlacasse/Owl/blob/main/docs/owl.pdf).
 

{owlplanner-2025.11.3 → owlplanner-2025.11.9}/README.md

@@ -1,5 +1,5 @@
 
-# Owl   
+# Owl - Optimal Wealth Lab
 
 ## A retirement exploration tool based on linear programming
 
@@ -44,13 +44,17 @@ your strategy under different market assumptions, helping to better understand y
 
 -------------------------------------------------------------------------------------
 ## Purpose and vision
-The goal of Owl is to create a free and open-source ecosystem that has cutting-edge optimization capabilities,
+One goal of Owl is to provide a free and open-source ecosystem that has cutting-edge optimization capabilities,
 allowing for the next generation of Python-literate retirees to experiment with their own financial future
-while providing a codebase where they can learn and contribute. There are and were
+while providing a codebase where they can learn and contribute. At the same time, an intuitive and easy-to-use
+user interface based on Streamlit allows a broad set of users to benefit from the application as it only requires basic financial knowledge.
+
+There are and were
 good retirement optimizers in the recent past, but the vast majority of them are either proprietary platforms
 collecting your data, or academic papers that share the results without really sharing the details of
 the underlying mathematical models.
-The algorithms in Owl rely on the open-source HiGHS linear programming solver. The complete formulation and
+The algorithms in Owl rely on the open-source HiGHS linear programming solver and but they have also been ported to
+other platforms such as Mosek and COIN-OR. The complete formulation and
 detailed description of the underlying
 mathematical model can be found [here](https://github.com/mdlacasse/Owl/blob/main/docs/owl.pdf).
 

{owlplanner-2025.11.3 → owlplanner-2025.11.9}/RELEASE_NOTES.md

@@ -1,5 +1,15 @@
-### Version 2025.07.01
+### Version 2025.11.09
+- Moved development status to production/stable in pyproject
+- Made version propagate everywhere needed
+- Added node limit on milp to avoid Streamlit server shutdown on memory consumption
+
+### Version 2025.11.05
+- Mentioning Owl as Optimal Wealth Lab
+- Port to Streamlit 1.50 which broke many widgets
+- Rework backprojection of assets to beginning of the year
+- Rework Docker to smaller Alpine image and fix docs
 
+### Version 2025.07.01
 Added:
 - Settings option for menu position thanks to Streamlit 1.46 top and sidebar capabilities. Default is top.
 - Net Investment Income Tax calculations in self-consistent loop.

{owlplanner-2025.11.3 → owlplanner-2025.11.9}/USER_GUIDE.md

@@ -1,4 +1,4 @@
-# Owl
+# Owl - Optimal Wealth Lab
 
 ## A retirement exploration tool based on linear programming
 

{owlplanner-2025.11.3 → owlplanner-2025.11.9}/docker/README.md

@@ -1,4 +1,4 @@
-# Owl
+# Owl - Optimal Wealth Lab
 
 ## A retirement exploration tool based on linear programming
 

{owlplanner-2025.11.3 → owlplanner-2025.11.9}/pyproject.toml

@@ -2,20 +2,23 @@
 requires = ["hatchling"]
 build-backend = "hatchling.build"
 
+[tool.hatch.version]
+path = "src/owlplanner/version.py"
+
 [project]
 name = "owlplanner"
-version = "2025.11.03"
+dynamic = ["version"]
 authors = [
   { name="Martin-D. Lacasse", email="martin.d.lacasse@gmail.com" },
 ]
 maintainers = [
   { name="Martin-D. Lacasse", email="martin.d.lacasse@gmail.com" },
 ]
-description = "Owl: Retirement planner with great wisdom"
+description = "Owl - Optimal Wealth Lab: Retirement planner with great wisdom"
 readme = "README.md"
-requires-python = ">=3.8"
+requires-python = ">=3.10"
 classifiers = [
-    "Development Status :: 4 - Beta",
+    "Development Status :: 5 - Production/Stable",
     "Programming Language :: Python :: 3",
     "Intended Audience :: End Users/Desktop",
     "Topic :: Office/Business :: Financial :: Investment",
@@ -24,12 +27,13 @@ classifiers = [
     "Programming Language :: Python :: 3",
 ]
 dependencies = [
+    "highspy",
     "matplotlib",
     "numpy",
     "odfpy",
     "openpyxl",
     "pandas",
-    "plotly",
+    "plotly>=6.3",
     "pulp",
     "seaborn",
     "scipy",

{owlplanner-2025.11.3 → owlplanner-2025.11.9}/src/owlplanner/plan.py

@@ -1669,7 +1669,7 @@ class Plan(object):
         self.prevMAGI = np.zeros(2)
         if "previousMAGIs" in myoptions:
             magi = myoptions["previousMAGIs"]
-            if 3 < len(magi) < 2:
+            if len(magi) != 2:
                 raise ValueError("previousMAGIs must have 2 values.")
 
             self.prevMAGI = self.optionsUnits * np.array(magi)
@@ -1786,7 +1786,7 @@ class Plan(object):
             "disp": False,
             "mip_rel_gap": 1e-7,
             "presolve": True,
-            # "node_limit": 10000  # Limit search nodes for faster solutions
+            "node_limit": 1000000  # Limit search nodes for faster solutions
         }
 
         self._buildConstraints(objective, options)

owlplanner-2025.11.9/src/owlplanner/version.py

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

{owlplanner-2025.11.3 → owlplanner-2025.11.9}/ui/About_Owl.py

@@ -4,7 +4,7 @@ import sskeys as kz
 import owlbridge as owb
 
 
-st.write("# :material/info: About Owl 🦉")
+st.write("# :material/info: About Owl - Optimal Wealth Lab🦉")
 kz.divider("orange")
 
 st.write(f"This is Owl version {owb.version()} running on Streamlit {st.__version__}.")

{owlplanner-2025.11.3 → owlplanner-2025.11.9}/ui/Documentation.py

@@ -14,11 +14,16 @@ with col3:
 col1, col2 = st.columns([0.80, 0.20], gap="large")
 with col1:
     st.markdown("""
+### Owl - Optimal Wealth Lab
 #### A retirement financial exploration tool based on linear programming
 
 The goal of Owl is to provide a free and open-source ecosystem that has cutting-edge
 optimization capabilities, allowing for the new generation of computer-literate retirees
 to experiment with their own financial future while providing a codebase where they can learn and contribute.
+At the same time, Streamlit provides an intuitive and easy-to-use
+interface which allows a broad set of users to benefit from the application
+as it only requires basic financial knowledge.
+
 Strictly speaking, Owl is not a planning tool, but more an environment for exploring *what if* scenarios.
 It provides different realizations of a financial strategy through the rigorous
 mathematical optimization of relevant decision variables. Using a linear programming approach,

{owlplanner-2025.11.3 → owlplanner-2025.11.9}/ui/Monte_Carlo.py

@@ -17,7 +17,7 @@ else:
         st.write("Generate a histogram of results obtained from running mutliple scenarios with stochastic rates.")
         col1, col2, col3, col4 = st.columns(4, gap="large", vertical_alignment="bottom")
         with col1:
-            kz.initKey("MC_cases", 100)
+            kz.initCaseKey("MC_cases", 100)
             kz.getIntNum("Number of random instances", "MC_cases", step=10, max_value=10000)
         with col4:
             st.button("Run Simulation", on_click=owb.runMC, disabled=kz.caseIsNotMCReady())

{owlplanner-2025.11.3 → owlplanner-2025.11.9}/ui/Quick_Start.py

@@ -7,7 +7,7 @@ with col3:
     st.image("http://github.com/mdlacasse/Owl/blob/main/docs/images/owl.png?raw=true")
     st.caption("Retirement planner with great wisdom")
 with col1:
-    st.write("# :orange[Owl Retirement Planner]\nA retirement financial exploration tool based on linear programming")
+    st.write("# :orange[Owl - Optimal Wealth Lab]\nA retirement financial exploration tool based on linear programming")
     kz.divider("orange")
     st.write("### :material/campaign: News")
     st.markdown("""

{owlplanner-2025.11.3 → owlplanner-2025.11.9}/ui/Settings.py

@@ -4,6 +4,12 @@ import sskeys as kz
 import owlbridge as owb
 
 
+def setKey(key):
+    val = kz.getGlobalKey("_"+key)
+    if val is not None:
+        kz.storeGlobalKey(key, val)
+
+
 st.write("# :material/settings: Settings")
 kz.divider("orange")
 
@@ -17,7 +23,7 @@ with col1:
     helpmsg = "Select the plotting library to use."
     index = choices.index(kz.getGlobalKey(gkey))
     ret = st.radio("Plotting backend", options=choices, index=index, args=[gkey],
-                   key=gkey, on_change=owb.setGlobalPlotBackend, help=helpmsg, horizontal=True)
+                   key="_"+gkey, on_change=owb.setGlobalPlotBackend, help=helpmsg, horizontal=True)
 
 with col2:
     choices = ("sidebar", "top")
@@ -26,8 +32,8 @@ with col2:
     st.write("#### :orange[Menu]")
     helpmsg = "Select menu appearance."
     index = choices.index(kz.getGlobalKey(mkey))
-    ret = st.radio("Menu location", options=choices, index=index,
-                   key=mkey, help=helpmsg, horizontal=True)
+    ret = st.radio("Menu location", options=choices, index=index, args=[mkey],
+                   key="_"+mkey, on_change=setKey, help=helpmsg, horizontal=True)
 
 with col3:
     choices = ("sticky", "static")
@@ -36,8 +42,8 @@ with col3:
     st.write("#### :orange[Header]")
     helpmsg = "Select header behavior."
     index = choices.index(kz.getGlobalKey(pkey))
-    ret = st.radio("Header behavior", options=choices, index=index,
-                   key=pkey, help=helpmsg, horizontal=True)
+    ret = st.radio("Header behavior", options=choices, index=index, args=[pkey],
+                   key="_"+pkey, on_change=setKey, help=helpmsg, horizontal=True)
 
 st.divider()
 st.write("""

{owlplanner-2025.11.3 → owlplanner-2025.11.9}/ui/owlbridge.py

@@ -511,7 +511,8 @@ def setDefaultPlots(plan, key):
 
 
 def setGlobalPlotBackend(key):
-    val = kz.getGlobalKey(key)
+    val = kz.getGlobalKey("_"+key)
+    kz.storeGlobalKey(key, val)
     # Apply to all existing cases.
     for casename in kz.onlyCaseNames():
         plan = kz.getKeyInCase("plan", casename)

owlplanner-2025.11.3/src/owlplanner/version.py

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