owlplanner 2025.5.15__tar.gz → 2025.5.30__tar.gz

{owlplanner-2025.5.15 → owlplanner-2025.5.30}/.github/workflows/github-actions-runtests.yml

@@ -12,7 +12,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.9", "3.10", "3.12", "3.13"]
+        python-version: ["3.9", "3.10", "3.13"]
 
     steps:
     - uses: actions/checkout@v4

owlplanner-2025.5.30/.streamlit/config.toml

@@ -0,0 +1,2 @@
+[theme]
+base = "dark"

{owlplanner-2025.5.15 → owlplanner-2025.5.30}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: owlplanner
-Version: 2025.5.15
+Version: 2025.5.30
 Summary: Owl: Retirement planner with great wisdom
 Project-URL: HomePage, https://github.com/mdlacasse/owl
 Project-URL: Repository, https://github.com/mdlacasse/owl
@@ -714,7 +714,7 @@ Description-Content-Type: text/markdown
 -------------------------------------------------------------------------------------
 
 ### TL;DR
-Owl is a financial retirement planning tool that uses a linear programming
+Owl is a retirement financial planning tool that uses a linear programming
 optimization algorithm to provide guidance on retirement decisions
 such as contributions, withdrawals, Roth conversions, and more.
 Users can select varying return rates to perform historical back testing,

{owlplanner-2025.5.15 → owlplanner-2025.5.30}/README.md

@@ -8,7 +8,7 @@
 -------------------------------------------------------------------------------------
 
 ### TL;DR
-Owl is a financial retirement planning tool that uses a linear programming
+Owl is a retirement financial planning tool that uses a linear programming
 optimization algorithm to provide guidance on retirement decisions
 such as contributions, withdrawals, Roth conversions, and more.
 Users can select varying return rates to perform historical back testing,

{owlplanner-2025.5.15 → owlplanner-2025.5.30}/docs/owl.tex

@@ -435,7 +435,7 @@ All intermediate variables are in uppercase letters.
 	Notice that we are using return rates from the previous year.
 	The first terms on the right-hand side represent dividends generated by
         equities $(k=0)$ in the $(j=0)$ taxable savings account plus
-	half the yearly contributions. The second term account for withdrawals $w$
+	half the yearly contributions. The second term accounts for withdrawals $w$
         of equities assumed to have been purchased a year ago. 
 	It does not account for losses, but a market drop
 	would most likely result in stock purchase rather than sale.

{owlplanner-2025.5.15 → owlplanner-2025.5.30}/examples/case_jack+jill.toml

@@ -28,7 +28,7 @@ Names = [ "Jack", "Jill",]
 ["Rates Selection"]
 "Heirs rate on tax-deferred estate" = 30.0
 "Long-term capital gain tax rate" = 15.0
-"Dividend tax rate" = 2.0
+"Dividend rate" = 1.8
 "TCJA expiration year" = 2026
 Method = "historical"
 From = 1969

{owlplanner-2025.5.15 → owlplanner-2025.5.30}/examples/case_joe.toml

@@ -26,7 +26,7 @@ Names = [ "Joe",]
 ["Rates Selection"]
 "Heirs rate on tax-deferred estate" = 30.0
 "Long-term capital gain tax rate" = 15.0
-"Dividend tax rate" = 2.0
+"Dividend rate" = 1.8
 "TCJA expiration year" = 2026
 Method = "historical average"
 From = 1969

{owlplanner-2025.5.15 → owlplanner-2025.5.30}/examples/case_john+sally.toml

@@ -28,7 +28,7 @@ Names = [ "John", "Sally",]
 ["Rates Selection"]
 "Heirs rate on tax-deferred estate" = 30.0
 "Long-term capital gain tax rate" = 15.0
-"Dividend tax rate" = 2.0
+"Dividend rate" = 1.8
 "TCJA expiration year" = 2026
 Method = "historical average"
 From = 1990

{owlplanner-2025.5.15 → owlplanner-2025.5.30}/examples/case_jon+jane.toml

@@ -28,10 +28,10 @@ Names = [ "Jon", "Jane",]
 ["Rates Selection"]
 "Heirs rate on tax-deferred estate" = 30.0
 "Long-term capital gain tax rate" = 15.0
-"Dividend tax rate" = 2.0
+"Dividend rate" = 1.8
 "TCJA expiration year" = 2026
 Method = "user"
-Values = [ 10.0, 0.0, 0.0, 3.5000000000000004,]
+Values = [ 10.0, 6.0, 5.0, 3.5000000000000004,]
 From = 1928
 To = 2024
 

{owlplanner-2025.5.15 → owlplanner-2025.5.30}/examples/case_kim+sam-bequest.toml

@@ -28,7 +28,7 @@ Names = [ "Kim", "Sam",]
 ["Rates Selection"]
 "Heirs rate on tax-deferred estate" = 33.0
 "Long-term capital gain tax rate" = 15.0
-"Dividend tax rate" = 2.0
+"Dividend rate" = 1.8
 "TCJA expiration year" = 2026
 Method = "conservative"
 From = 1922

{owlplanner-2025.5.15 → owlplanner-2025.5.30}/examples/case_kim+sam-spending.toml

@@ -28,7 +28,7 @@ Names = [ "Kim", "Sam",]
 ["Rates Selection"]
 "Heirs rate on tax-deferred estate" = 33.0
 "Long-term capital gain tax rate" = 15.0
-"Dividend tax rate" = 2.0
+"Dividend rate" = 1.8
 "TCJA expiration year" = 2026
 Method = "conservative"
 From = 1922

{owlplanner-2025.5.15 → owlplanner-2025.5.30}/notebooks/template.ipynb

@@ -138,24 +138,6 @@
     "plan = owl.Plan(['Kim', 'Sam'], [YYYY, YYYY], [AA, AA], 'Kim+Sam-spending', verbose=True)"
    ]
   },
-  {
-   "cell_type": "markdown",
-   "id": "d1b5aabe",
-   "metadata": {},
-   "source": [
-    "By default, the starting date is today, and therefore the returns of the current year are reduced in proportion of how late we are in the year. An arbitrary date can be chosen as a starting point in the current year, using the optional parameter startDate. This will only affect the first year: the plan will still end at the end of the last year. For example, using startDate='01-01' would select January 1st, the beginning of the year. This is useful for reproducibility studies. Here is an example:"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "8a106c03",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "# plan = owl.Plan(['Kim', 'Sam'], [YYYY, YYYY], [AA, AA], 'Kim+Sam-spending', startDate='01-01')"
-   ]
-  },
   {
    "cell_type": "markdown",
    "id": "47f309e7-0654-4f75-87b5-921167db4a6a",
@@ -204,6 +186,29 @@
     "Benificiary fractions are entered as [1, 1, 1], i.e., one for each type of account. Default is to leave everything to the living spouse."
    ]
   },
+  {
+   "cell_type": "markdown",
+   "id": "090914eb-78f3-4e85-bdc9-e7fa03b75aaf",
+   "metadata": {},
+   "source": [
+    "By default, the account balances are assumed to be known as of today, and amounts will be back projected to Jan 1st using the assumed return rates. An arbitrary date can be chosen as a reference point in the current year, using the optional parameter startDate. For example, using startDate='01-01' would select January 1st, the beginning of the year. This is useful for reproducibility studies. Here is an example:"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "49109e26-bea3-49df-8377-3343111ebfac",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "plan.setAccountBalances(\n",
+    "    taxable=[XX, XX],\n",
+    "    taxDeferred=[XX, XX],\n",
+    "    taxFree=[XX, XX],\n",
+    "    startDate=\"01-01\"\n",
+    ")"
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": null,