owlplanner 2025.2.23__tar.gz → 2025.2.25__tar.gz

{owlplanner-2025.2.23 → owlplanner-2025.2.25}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: owlplanner
-Version: 2025.2.23
+Version: 2025.2.25
 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.23 → owlplanner-2025.2.25}/examples/case_jack+jill.toml

@@ -1,5 +1,5 @@
 "Plan Name" = "jack+jill"
-Description = "This example case is for Jack and Jill, a married couple."
+Description = "This example case aims to demonstrate some of Owl's capabilities. Jack and Jill are a married couple a few years from retirement. A wages and contributions file called 'jack+jill.xlsx' is associated with this case."
 
 ["Basic Info"]
 Status = "married"

{owlplanner-2025.2.23 → owlplanner-2025.2.25}/examples/case_joe.toml

@@ -1,5 +1,5 @@
 "Plan Name" = "joe"
-Description = "This example case is for Joe, a single individual."
+Description = "This is an example of a case involving a single individual. Joe is single and will retire in a few years. His wages and contributions are contained in the 'joe.xlsx' spreadsheet."
 
 ["Basic Info"]
 Status = "single"

{owlplanner-2025.2.23 → owlplanner-2025.2.25}/examples/case_john+sally.toml

@@ -1,5 +1,5 @@
 "Plan Name" = "john+sally"
-Description = "This example reproduces the case of John and Sally, discussed by Eric Sajdak."
+Description = "This example reproduces the case of John and Sally, discussed by Eric Sajdak. This case can be used to compare the heuristic strategy of surfing a tax bracket for performing Roth conversions to a solution optimized by linear programming. The former is a good approach when one assumes fixed rates. When rates are varying, and the market drops, an optimized solution shows that it is sometime advantageous to convert above the target tax bracket. File 'john+sally.xlsx' contains wages and contributions associated with this case. Run this case with different rates to see the effect on Roth conversions."
 
 ["Basic Info"]
 Status = "married"

{owlplanner-2025.2.23 → owlplanner-2025.2.25}/examples/case_jon+jane.toml

@@ -1,5 +1,5 @@
 "Plan Name" = "Jon+Jane"
-Description = "The case of Jon and Jane was the base case discussed by i-orp."
+Description = "This case is similar to a case discussed by i-orp. It involve Jon and Jane close to retirement, and assumes a base case of optimistic returns of 10% with an inflation of 3.5%. A wages and contributions file called 'jon+jane.xlsx' is associated with this case."
 
 ["Basic Info"]
 Status = "married"

{owlplanner-2025.2.23 → owlplanner-2025.2.25}/examples/case_kim+sam-bequest.toml

@@ -1,5 +1,5 @@
 "Plan Name" = "kim+sam-bequest"
-Description = "Kim and Sam is an example case for optimizing bequest and Roth conversions."
+Description = "This is the case of Kim and Sam used as an example case for optimizing bequest and Roth conversions. No wages and contributions file is associated with this case."
 
 ["Basic Info"]
 Status = "married"

{owlplanner-2025.2.23 → owlplanner-2025.2.25}/examples/case_kim+sam-spending.toml

@@ -1,5 +1,5 @@
 "Plan Name" = "kim+sam-spending"
-Description = "Kim and Sam is an example case for optimizing spending and Roth conversions."
+Description = "This is the case of Kim and Sam used as an example case for optimizing spending and Roth conversions. No wages and contributions is associated with this case."
 
 ["Basic Info"]
 Status = "married"

{owlplanner-2025.2.23 → owlplanner-2025.2.25}/pyproject.toml

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

{owlplanner-2025.2.23 → owlplanner-2025.2.25}/src/owlplanner/plan.py

@@ -34,6 +34,10 @@ from owlplanner import logging
 from owlplanner import progress
 
 
+# This makes all graphs appear have the same height.
+plt.rcParams.update({'figure.autolayout': True})
+
+
 def _genGamma_n(tau):
     """
     Utility function to generate a cumulative inflation multiplier
@@ -2077,7 +2081,6 @@ class Plan(object):
         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])

owlplanner-2025.2.25/src/owlplanner/version.py

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

{owlplanner-2025.2.23 → owlplanner-2025.2.25}/ui/Documentation.py

@@ -135,14 +135,21 @@ The wages and contributions data contains 9 columns titled as follows:
 | ... | | | | | | | | |
 |20XX | | | | | | | | |
 
-Here, 20XX represents the last row which could be the last year based on the life expectancy values provided.
+Here, 20XX represents the last row which could be the last year based on the life
+expectancy values provided.
 While loading an Excel workbook, missing years or empty cells will be filled with zero values,
 while years outside the time span of the plan will be ignored.
 For the columns, *anticipated wages* is the annual amount
-(gross minus tax-deferred contributions) that you anticipate to receive from employment or other sources
-(not including dividends from your taxable investment accounts). Note that column names are case sensitive
-and all entries must be in lower case. The easiest way to start this process is to use the template
+(gross minus tax-deferred contributions) that you anticipate to receive from employment
+or other sources (e.g. rentals).
+This column does not include dividends from your taxable investment accounts,
+as they will be calculated based on your return rate assumptions.
+
+Note that column names are case sensitive and all entries must be in lower case.
+The easiest way to complete the process of filling this file is either to start from the template
 file provided [here](https://raw.github.com/mdlacasse/Owl/main/examples/template.xlsx).
+Values can also be filled in the user interface, but this approach does not have
+Excel capabilities for cross-column calculations.
 
 For the purpose of planning, there is no clear definition of retirement age. There will be a year,
 however, from which you will stop having anticipated income, or diminished income due to decreasing your

{owlplanner-2025.2.23 → owlplanner-2025.2.25}/ui/requirements.txt

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

owlplanner-2025.2.23/src/owlplanner/version.py

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