owlplanner 2025.5.30__py3-none-any.whl → 2025.6.3__py3-none-any.whl

owlplanner/abcapi.py

@@ -16,9 +16,9 @@ solvers for comparison.
 This approach has been successful with the MOSEK and the HiGHS solvers.
 A for matrix, B for bounds, C for constraints. Thus the name ABCAPI.
 
-Copyright (C) 2024 -- Martin-D. Lacasse
+Copyright © 2024 - Martin-D. Lacasse
 
-Disclaimer: This program comes with no guarantee. Use at your own risk.
+Disclaimers: This code is for educatonal purposes only and does not constitute financial advice.
 
 """
 

owlplanner/config.py

@@ -4,9 +4,10 @@ Owl/conftoml
 
 This file contains utility functions to save case parameters.
 
-Copyright (C) 2024 -- Martin-D. Lacasse
+Copyright © 2024 - Martin-D. Lacasse
+
+Disclaimers: This code is for educatonal purposes only and does not constitute financial advice.
 
-Disclaimer: This program comes with no guarantee. Use at your own risk.
 """
 
 import toml as toml

owlplanner/mylogging.py

@@ -4,9 +4,9 @@ Owl/logging
 
 This file contains routines for handling error messages.
 
-Copyright (C) 2024 -- Martin-D. Lacasse
+Copyright © 2024 - Martin-D. Lacasse
 
-Disclaimer: This program comes with no guarantee. Use at your own risk.
+Disclaimers: This code is for educatonal purposes only and does not constitute financial advice.
 
 """
 

owlplanner/plan.py

@@ -8,9 +8,10 @@ A retirement planner using linear programming optimization.
 See companion PDF document for an explanation of the underlying
 mathematical model and a description of all variables and parameters.
 
-Copyright (C) 2024 -- Martin-D. Lacasse
+Copyright © 2024 - Martin-D. Lacasse
+
+Disclaimers: This code is for educatonal purposes only and does not constitute financial advice.
 
-Disclaimer: This program comes with no guarantee. Use at your own risk.
 """
 
 ###########################################################################
@@ -307,7 +308,7 @@ class Plan(object):
         self.kappa_ijn = np.zeros((self.N_i, self.N_j, self.N_n))
 
         # Previous 3 years for Medicare.
-        self.prevMAGI = np.zeros((3))
+        self.prevMAGI = np.zeros((2))
 
         # Init previous balance to none.
         self.beta_ij = None
@@ -498,7 +499,7 @@ class Plan(object):
     def setBeneficiaryFractions(self, phi):
         """
         Set fractions of savings accounts that is left to surviving spouse.
-        Default is [1, 1, 1] for taxable, tax-deferred, adn tax-exempt accounts.
+        Default is [1, 1, 1] for taxable, tax-deferred, and tax-free accounts.
         """
         if len(phi) != self.N_j:
             raise ValueError(f"Fractions must have {self.N_j} entries.")
@@ -901,7 +902,7 @@ class Plan(object):
         try:
             filename, self.timeLists = timelists.read(filename, self.inames, self.horizons, self.mylog)
         except Exception as e:
-            raise Exception(f"Unsuccessful read of contributions: {e}") from e
+            raise Exception(f"Unsuccessful read of Wages and Contributions: {e}") from e
 
         self.timeListsFileName = filename
         self.setContributions()
@@ -909,6 +910,9 @@ class Plan(object):
         return True
 
     def setContributions(self, timeLists=None):
+        """
+        If no argument is given, use the values that have been stored in self.timeLists.
+        """
         if timeLists is not None:
             timelists.check(timeLists, self.inames, self.horizons)
             self.timeLists = timeLists
@@ -1074,8 +1078,6 @@ class Plan(object):
         Utility function that builds constraint matrix and vectors.
         Refactored for clarity and maintainability.
         """
-        self._setup_constraint_shortcuts(options)
-
         self.A = abc.ConstraintMatrix(self.nvars)
         self.B = abc.Bounds(self.nvars, self.nbins)
 
@@ -1098,12 +1100,6 @@ class Plan(object):
 
         return None
 
-    def _setup_constraint_shortcuts(self, options):
-        # Set up all the local variables as attributes for use in helpers.
-        oppCostX = options.get("oppCostX", 0.)
-        self.xnet = 1 - oppCostX / 100.
-        self.optionsUnits = u.getUnits(options.get("units", "k"))
-
     def _add_rmd_inequalities(self):
         for i in range(self.N_i):
             if self.beta_ij[i, 1] > 0:
@@ -1579,14 +1575,18 @@ class Plan(object):
         if objective == "maxSpending" and "bequest" not in myoptions:
             self.mylog.vprint("Using bequest of $1.")
 
-        self.prevMAGI = np.zeros(3)
+        self.optionsUnits = u.getUnits(myoptions.get("units", "k"))
+
+        oppCostX = options.get("oppCostX", 0.)
+        self.xnet = 1 - oppCostX / 100.
+
+        self.prevMAGI = np.zeros(2)
         if "previousMAGIs" in myoptions:
             magi = myoptions["previousMAGIs"]
-            if len(magi) != 3:
-                raise ValueError("previousMAGIs must have 3 values.")
+            if 3 < len(magi) < 2:
+                raise ValueError("previousMAGIs must have 2 values.")
 
-            units = u.getUnits(options.get("units", "k"))
-            self.prevMAGI = units * np.array(magi)
+            self.prevMAGI = self.optionsUnits * np.array(magi)
 
         lambdha = myoptions.get("spendingSlack", 0)
         if lambdha < 0 or lambdha > 50:
@@ -2058,7 +2058,7 @@ class Plan(object):
         dic = {}
         # Results
         dic["Plan name"] = self._name
-        dic["Net yearly spending basis"] = u.d(self.g_n[0] / self.xi_n[0])
+        dic["Net yearly spending basis" + 26*" ."] = u.d(self.g_n[0] / self.xi_n[0])
         dic[f"Net spending for year {now}"] = u.d(self.g_n[0])
         dic[f"Net spending remaining in year {now}"] = u.d(self.g_n[0] * self.yearFracLeft)
 

owlplanner/plotting/__init__.py

@@ -1,5 +1,10 @@
 """
 Plotting backends for Owl.
+
+Copyright © 2025 - Martin-D. Lacasse
+
+Disclaimers: This code is for educatonal purposes only and does not constitute financial advice.
+
 """
 
 from .factory import PlotFactory

owlplanner/plotting/base.py

@@ -1,5 +1,10 @@
 """
 Base classes for plot backends.
+
+Copyright © 2025 - Martin-D. Lacasse
+
+Disclaimers: This code is for educatonal purposes only and does not constitute financial advice.
+
 """
 
 from abc import ABC, abstractmethod

owlplanner/plotting/factory.py

@@ -1,5 +1,10 @@
 """
 Factory for creating plot backends.
+
+Copyright © 2025 - Martin-D. Lacasse
+
+Disclaimers: This code is for educatonal purposes only and does not constitute financial advice.
+
 """
 
 from .base import PlotBackend

owlplanner/plotting/matplotlib_backend.py

@@ -1,5 +1,10 @@
 """
 Matplotlib implementation of plot backend.
+
+Copyright © 2025 - Martin-D. Lacasse
+
+Disclaimers: This code is for educatonal purposes only and does not constitute financial advice.
+
 """
 
 import numpy as np
@@ -372,17 +377,19 @@ class MatplotlibBackend(PlotBackend):
             raise ValueError(f"Unknown coordination {ARCoord}.")
         figures = []
         assetDic = {"stocks": 0, "C bonds": 1, "T notes": 2, "common": 3}
+        blank = ["", ""]
         for i in range(count):
             y2stack = {}
             for acType in acList:
                 stackNames = []
                 for key in assetDic:
-                    aname = key + " / " + acType
+                    # aname = key + " / " + acType
+                    aname = key
                     stackNames.append(aname)
                     y2stack[aname] = np.zeros((count, len(year_n)))
                     y2stack[aname][i][:] = alpha_ijkn[i, acList.index(acType), assetDic[key], : len(year_n)]
-                t = title + f" - {acType}"
-                fig, ax = self._stack_plot(year_n, inames, t, [i], y2stack, stackNames, "upper left", "percent")
+                t = title + f" - {acType} {inames[i]}"
+                fig, ax = self._stack_plot(year_n, blank, t, [i], y2stack, stackNames, "upper left", "percent")
                 figures.append(fig)
 
         return figures

owlplanner/plotting/plotly_backend.py

@@ -1,5 +1,10 @@
 """
 Plotly implementation of plot backend.
+
+Copyright © 2025 - Martin-D. Lacasse
+
+Disclaimers: This code is for educatonal purposes only and does not constitute financial advice.
+
 """
 
 import numpy as np
@@ -815,7 +820,8 @@ class PlotlyBackend(PlotBackend):
                 stack_data = []
                 stack_names = []
                 for key in assetDic:
-                    aname = f"{key} / {acType}"
+                    # aname = f"{key} / {acType}"
+                    aname = key
                     stack_names.append(aname)
 
                     # Get allocation data
@@ -834,7 +840,7 @@ class PlotlyBackend(PlotBackend):
                     ))
 
                 # Update layout
-                plot_title = f"{title} - {acType}"
+                plot_title = f"{title} - {acType} {inames[i]}"
                 fig.update_layout(
                     title=plot_title,
                     # xaxis_title="year",

owlplanner/progress.py

@@ -1,6 +1,10 @@
 """
 A simple object to display progress.
 
+Copyright © 2024 - Martin-D. Lacasse
+
+Disclaimers: This code is for educatonal purposes only and does not constitute financial advice.
+
 """
 
 from owlplanner import utils as u

owlplanner/rates.py

@@ -21,11 +21,10 @@ Rate lists will need to be updated with values for current year.
 When doing so, the TO bound defined below will need to be adjusted
 to the last current data year.
 
-Copyright (C) 2024 -- Martin-D. Lacasse
+Copyright © 2024 - Martin-D. Lacasse
 
-Last updated: Jan 2025
+Disclaimers: This code is for educatonal purposes only and does not constitute financial advice.
 
-Disclaimer: This program comes with no guarantee. Use at your own risk.
 """
 
 ###################################################################

owlplanner/tax2025.py

@@ -10,9 +10,10 @@ of all variables and parameters.
 
 Module to handle all tax calculations.
 
-Copyright (C) 2024 -- Martin-D. Lacasse
+Copyright © 2024 - Martin-D. Lacasse
+
+Disclaimers: This code is for educatonal purposes only and does not constitute financial advice.
 
-Disclaimer: This program comes with no guarantee. Use at your own risk.
 """
 
 import numpy as np
@@ -93,9 +94,9 @@ def mediCosts(yobs, horizons, magi, prevmagi, gamma_n, Nn):
         status = 0 if Ni == 1 else 1 if n < horizons[0] and n < horizons[1] else 0
         for i in range(Ni):
             if thisyear + n - yobs[i] >= 65 and n < horizons[i]:
-                # Start with the (indexed) basic Medicare part B premium.
+                # Start with the (inflation-adjusted) basic Medicare part B premium.
                 costs[n] += gamma_n[n] * irmaaFees[0]
-                if n < 3:
+                if n < 2:
                     mymagi = prevmagi[n]
                 else:
                     mymagi = magi[n - 2]

owlplanner/timelists.py

@@ -10,9 +10,10 @@ of all variables and parameters.
 
 Utility functions to read and check timelists.
 
-Copyright (C) 2024 -- Martin-D. Lacasse
+Copyright © 2024 - Martin-D. Lacasse
+
+Disclaimers: This code is for educatonal purposes only and does not constitute financial advice.
 
-Disclaimer: This program comes with no guarantee. Use at your own risk.
 """
 
 from datetime import date
@@ -47,7 +48,7 @@ def read(finput, inames, horizons, mylog):
     mylog.vprint("Reading wages, contributions, conversions, and big-ticket items over time...")
 
     if isinstance(finput, dict):
-        timeLists = finput
+        dfDict = finput
         finput = "dictionary of DataFrames"
         streamName = "dictionary of DataFrames"
     else:
@@ -58,7 +59,7 @@ def read(finput, inames, horizons, mylog):
             raise Exception(f"Could not read file {finput}: {e}.") from e
         streamName = f"file '{finput}'"
 
-        timeLists = condition(dfDict, inames, horizons, mylog)
+    timeLists = condition(dfDict, inames, horizons, mylog)
 
     mylog.vprint(f"Successfully read time horizons from {streamName}.")
 

owlplanner/utils.py

@@ -4,9 +4,9 @@ Owl/utils
 
 This file contains functions for handling data.
 
-Copyright (C) 2024 -- Martin-D. Lacasse
+Copyright © 2024 - Martin-D. Lacasse
 
-Disclaimer: This program comes with no guarantee. Use at your own risk.
+Disclaimers: This code is for educatonal purposes only and does not constitute financial advice.
 
 """
 

owlplanner/version.py

@@ -1 +1 @@
-__version__ = "2025.05.30"
+__version__ = "2025.06.03"

{owlplanner-2025.5.30.dist-info → owlplanner-2025.6.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: owlplanner
-Version: 2025.5.30
+Version: 2025.6.3
 Summary: Owl: Retirement planner with great wisdom
 Project-URL: HomePage, https://github.com/mdlacasse/owl
 Project-URL: Repository, https://github.com/mdlacasse/owl
@@ -748,13 +748,6 @@ This is exactly where this tool fits it. Given your savings capabilities and spe
 it can generate different future realizations of
 your strategy under different market assumptions, helping to better understand your financial situation.
 
-Disclaimers: I am not a financial planner. You make your own decisions.
-This program comes with no guarantee. Use at your own risk.
-
-More disclaimers: While some output of the code has been verified with other approaches,
-this code is still under development and I cannot guarantee the accuracy of the results.
-Use at your own risk.
-
 -------------------------------------------------------------------------------------
 ## Purpose and vision
 The goal of Owl is to create a free and open-source ecosystem that has cutting-edge optimization capabilities,
@@ -839,7 +832,7 @@ an Excel spreadsheet that contains future wages, contributions
 to savings accounts, and planned *big-ticket items* such as the purchase of a lake house,
 the sale of a boat, large gifts, or inheritance.
 
-Three types of savings accounts are considered: taxable, tax-deferred, and tax-exempt,
+Three types of savings accounts are considered: taxable, tax-deferred, and tax-free,
 which are all tracked separately for married individuals. Asset transition to the surviving spouse
 is done according to beneficiary fractions for each type of savings account.
 Tax status covers married filing jointly and single, depending on the number of individuals reported.
@@ -898,8 +891,10 @@ assets to support, even with no estate being left.
 
 Copyright © 2024 - Martin-D. Lacasse
 
-Disclaimers: I am not a financial planner. You make your own decisions.
-This program comes with no guarantee. Use at your own risk.
+Disclaimers: This code is for educatonal purposes only and does not constitute financial advice.
+
+Code output has been verified with analytical solutions and other approaches.
+Nevertheless, accuracy of results are not guaranteed.
 
 --------------------------------------------------------
 

owlplanner-2025.6.3.dist-info/RECORD

@@ -0,0 +1,22 @@
+owlplanner/__init__.py,sha256=hJ2i4m2JpHPAKyQLjYOXpJzeEsgcTcKD-Vhm0AIjjWg,592
+owlplanner/abcapi.py,sha256=8VCXS7nH_QZYxCUU3lwO0_UPR9Q5fuYQ6DHDLvHVLPg,6878
+owlplanner/config.py,sha256=onGIMqW2WwB9_CUZauDL6LtHGvc8O1cPUKKcK7Oh70M,12617
+owlplanner/mylogging.py,sha256=RKUr-y-1XvKZzLMcfdtm4IM30LuRpJwb2qUeXmAWqME,2557
+owlplanner/plan.py,sha256=FgQB0kEV5BXsQdFzcVZwukpqJUy1qR2OYP8wS_owtfo,107055
+owlplanner/progress.py,sha256=2DOjOLo6Mo7m21wY-9iZhoUksAyi4VCbb6UL2RegNCw,529
+owlplanner/rates.py,sha256=7jXcuHbkJ3AVIeBYZdwme18rdYslIzCuT-c0cLzvKUU,14819
+owlplanner/tax2025.py,sha256=HVYJq8po28jL5Z_il39ZY7qvf2riUEfxio15Zp7TGj8,7890
+owlplanner/timelists.py,sha256=HjoUJQU_ZbfdUy79DefQo5EAXpkfcuG_dOIO9qCljyM,3971
+owlplanner/utils.py,sha256=6Ky8ZKfNE9x--3znsZ8VZaT2PptDinszRxWsOCPanu8,2512
+owlplanner/version.py,sha256=s0nlL6F_JwS9jBAKvGDeVQurTia-o1wmPv43QaJETt4,28
+owlplanner/data/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+owlplanner/data/rates.csv,sha256=6fxg56BVVORrj9wJlUGFdGXKvOX5r7CSca8uhUbbuIU,3734
+owlplanner/plotting/__init__.py,sha256=uhxqtUi0OI-QWNOO2LkXgQViW_9yM3rYb-204Wit974,250
+owlplanner/plotting/base.py,sha256=UimGKpMTV-dVm3BX5Apr_Ltorc7dlDLCRPRQ3RF_v7c,2578
+owlplanner/plotting/factory.py,sha256=EDopIAPQr9zHRgemObko18FlCeRNhNCoLNNFAOq-X6s,1030
+owlplanner/plotting/matplotlib_backend.py,sha256=AOEkapD94U5hGNoS0EdbRoe8mgdMHH4oOvkXADZS914,17957
+owlplanner/plotting/plotly_backend.py,sha256=AO33GxBHGYG5osir_H1iRRtGxdhs4AjfLV2d_xm35nY,33138
+owlplanner-2025.6.3.dist-info/METADATA,sha256=WhszwtjjNOjd2rfx3QHl6_E52ypcg1DpdJ6JJz3G1vY,53785
+owlplanner-2025.6.3.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+owlplanner-2025.6.3.dist-info/licenses/LICENSE,sha256=IwGE9guuL-ryRPEKi6wFPI_zOhg7zDZbTYuHbSt_SAk,35823
+owlplanner-2025.6.3.dist-info/RECORD,,

owlplanner-2025.5.30.dist-info/RECORD

@@ -1,22 +0,0 @@
-owlplanner/__init__.py,sha256=hJ2i4m2JpHPAKyQLjYOXpJzeEsgcTcKD-Vhm0AIjjWg,592
-owlplanner/abcapi.py,sha256=m0vtoEzz9HJV7fOK_d7OnK7ha2Qbf7wLLPCJ9YZzR1k,6851
-owlplanner/config.py,sha256=v6T6A_90rVyl4sfX8KLpI8wkzt9HCjUiGDsPS-4VTec,12588
-owlplanner/mylogging.py,sha256=tYMw04O-XYSzjTj36fmKJGLcE1VkK6k6oJNeqtKXzuc,2530
-owlplanner/plan.py,sha256=BnojjOQzzFdcT4dL8EALzc_vzXO2qQJJXjY98nRZIyA,107114
-owlplanner/progress.py,sha256=8jlCvvtgDI89zXVNMBg1-lnEyhpPvKQS2X5oAIpoOVQ,384
-owlplanner/rates.py,sha256=MiaibxJY82JGpAhGyF2BJTm5-rmVAUuG8KLApVQhjvU,14816
-owlplanner/tax2025.py,sha256=wmlZpYeeGNrbyn5g7wOFqhWbggppodtHqc-ex5XRooI,7850
-owlplanner/timelists.py,sha256=wNYnJqxJ6QqE6jHh5lfFqYngfw5wUFrI15LSsM5ae8s,3949
-owlplanner/utils.py,sha256=WpJgn79YZfH8UCkcmhd-AZlxlGuz1i1-UDBRXImsY6I,2485
-owlplanner/version.py,sha256=h-tHOHZjN9oy3hW0oN8p91JT5cGNx7ALbl5_KcaZl3g,28
-owlplanner/data/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-owlplanner/data/rates.csv,sha256=6fxg56BVVORrj9wJlUGFdGXKvOX5r7CSca8uhUbbuIU,3734
-owlplanner/plotting/__init__.py,sha256=VnF6ui78YrTrg1dA6hBIdI02ahzEaHVR3ZEdDe_i880,103
-owlplanner/plotting/base.py,sha256=LP1TByl1tO4m087O6VpbZ_TTMnErHJGLTxXZXC9cuKQ,2431
-owlplanner/plotting/factory.py,sha256=i1k8m_ISnJw06f_JWlMvOQ7Q0PgV_BoLm05uLwFPvOQ,883
-owlplanner/plotting/matplotlib_backend.py,sha256=iJm3IBeMA5VUYG_zZxKPIzt4Izv2QWtWvlP656zwJVk,17738
-owlplanner/plotting/plotly_backend.py,sha256=5nqEUJXwLPW1vL9hQijxIUK57sWHvya6ZqIIYof-OjE,32944
-owlplanner-2025.5.30.dist-info/METADATA,sha256=lail2zj8dulkBtJ71340wAUjE3u6LZNNaEjgN4FAo0A,54024
-owlplanner-2025.5.30.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-owlplanner-2025.5.30.dist-info/licenses/LICENSE,sha256=IwGE9guuL-ryRPEKi6wFPI_zOhg7zDZbTYuHbSt_SAk,35823
-owlplanner-2025.5.30.dist-info/RECORD,,