owlplanner 2025.5.3__tar.gz → 2025.5.12__tar.gz

{owlplanner-2025.5.3 → owlplanner-2025.5.12}/.devcontainer/devcontainer.json

@@ -1,33 +1,33 @@
-{
-  "name": "Python 3",
-  // Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
-  "image": "mcr.microsoft.com/devcontainers/python:1-3.11-bullseye",
-  "customizations": {
-    "codespaces": {
-      "openFiles": [
-        "README.md",
-        "ui/main.py"
-      ]
-    },
-    "vscode": {
-      "settings": {},
-      "extensions": [
-        "ms-python.python",
-        "ms-python.vscode-pylance"
-      ]
-    }
-  },
-  "updateContentCommand": "[ -f packages.txt ] && sudo apt update && sudo apt upgrade -y && sudo xargs apt install -y <packages.txt; [ -f requirements.txt ] && pip3 install --user -r requirements.txt; pip3 install --user streamlit; echo '✅ Packages installed and Requirements met'",
-  "postAttachCommand": {
-    "server": "streamlit run ui/main.py --server.enableCORS false --server.enableXsrfProtection false"
-  },
-  "portsAttributes": {
-    "8501": {
-      "label": "Application",
-      "onAutoForward": "openPreview"
-    }
-  },
-  "forwardPorts": [
-    8501
-  ]
-}
+{
+  "name": "Python 3",
+  // Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
+  "image": "mcr.microsoft.com/devcontainers/python:1-3.11-bullseye",
+  "customizations": {
+    "codespaces": {
+      "openFiles": [
+        "README.md",
+        "ui/main.py"
+      ]
+    },
+    "vscode": {
+      "settings": {},
+      "extensions": [
+        "ms-python.python",
+        "ms-python.vscode-pylance"
+      ]
+    }
+  },
+  "updateContentCommand": "[ -f packages.txt ] && sudo apt update && sudo apt upgrade -y && sudo xargs apt install -y <packages.txt; [ -f requirements.txt ] && pip3 install --user -r requirements.txt; pip3 install --user streamlit; echo '✅ Packages installed and Requirements met'",
+  "postAttachCommand": {
+    "server": "streamlit run ui/main.py --server.enableCORS false --server.enableXsrfProtection false"
+  },
+  "portsAttributes": {
+    "8501": {
+      "label": "Application",
+      "onAutoForward": "openPreview"
+    }
+  },
+  "forwardPorts": [
+    8501
+  ]
+}

{owlplanner-2025.5.3 → owlplanner-2025.5.12}/.flake8

@@ -1,6 +1,5 @@
 [flake8]
 max-line-length = 120
-max-complexity = 70
 # These checks violate PEP8 so let's ignore them
 extend-ignore = E203
 # extend-exclude = */site-packages/*

{owlplanner-2025.5.3 → owlplanner-2025.5.12}/.gitignore

@@ -4,6 +4,7 @@ dist
 *~
 *.aux
 *.log
+.coverage
 otherFiles
 myfiles
 secrets

{owlplanner-2025.5.3 → owlplanner-2025.5.12}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: owlplanner
-Version: 2025.5.3
+Version: 2025.5.12
 Summary: Owl: Retirement planner with great wisdom
 Project-URL: HomePage, https://github.com/mdlacasse/owl
 Project-URL: Repository, https://github.com/mdlacasse/owl
@@ -695,6 +695,7 @@ Requires-Dist: matplotlib
 Requires-Dist: numpy
 Requires-Dist: openpyxl
 Requires-Dist: pandas
+Requires-Dist: plotly
 Requires-Dist: scipy
 Requires-Dist: seaborn
 Requires-Dist: streamlit
@@ -711,15 +712,17 @@ Description-Content-Type: text/markdown
 -------------------------------------------------------------------------------------
 
 ### TL;DR
-Owl is a retirement planning tool that uses a linear programming optimization algorithm
-to provide guidance on retirement decisions, including Roth conversions.
+Owl is a financial retirement 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,
 stochastic rates for performing Monte Carlo analyses,
 or fixed rates either derived from historical averages, or set by the user.
 
 There are a few ways to run Owl:
 
-- Run Owl directly on the Streamlit Community Server at [owlplanner.streamlit.app](https://owlplanner.streamlit.app).
+- Run Owl directly on the Streamlit Community Server at
+[owlplanner.streamlit.app](https://owlplanner.streamlit.app).
 
 - Run locally on your computer using a Docker image.
 Follow these [instructions](docker/README.md) for this option.
@@ -729,7 +732,7 @@ Follow these [instructions](INSTALL.md) to install Owl from the source code and
 
 -------------------------------------------------------------------------------------
 ## Overview
-This package is a retirement modeling framework for exploring the sensitivity of retirement financial decisions.
+This package is a modeling framework for exploring the sensitivity of retirement financial decisions.
 Strictly speaking, it 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. Two major objective goals can be set: either

{owlplanner-2025.5.3 → owlplanner-2025.5.12}/README.md

@@ -8,15 +8,17 @@
 -------------------------------------------------------------------------------------
 
 ### TL;DR
-Owl is a retirement planning tool that uses a linear programming optimization algorithm
-to provide guidance on retirement decisions, including Roth conversions.
+Owl is a financial retirement 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,
 stochastic rates for performing Monte Carlo analyses,
 or fixed rates either derived from historical averages, or set by the user.
 
 There are a few ways to run Owl:
 
-- Run Owl directly on the Streamlit Community Server at [owlplanner.streamlit.app](https://owlplanner.streamlit.app).
+- Run Owl directly on the Streamlit Community Server at
+[owlplanner.streamlit.app](https://owlplanner.streamlit.app).
 
 - Run locally on your computer using a Docker image.
 Follow these [instructions](docker/README.md) for this option.
@@ -26,7 +28,7 @@ Follow these [instructions](INSTALL.md) to install Owl from the source code and
 
 -------------------------------------------------------------------------------------
 ## Overview
-This package is a retirement modeling framework for exploring the sensitivity of retirement financial decisions.
+This package is a modeling framework for exploring the sensitivity of retirement financial decisions.
 Strictly speaking, it 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. Two major objective goals can be set: either

{owlplanner-2025.5.3 → owlplanner-2025.5.12}/examples/case_jon+jane.toml

@@ -1,57 +1,57 @@
-"Plan Name" = "Jon+Jane"
-Description = "This case reproduces a similar case discussed a while back on i-orp. It involves 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"
-Names = [ "Jon", "Jane",]
-"Birth year" = [ 1965, 1968,]
-"Life expectancy" = [ 92, 92,]
-"Start date" = "01-01"
-
-[Assets]
-"taxable savings balances" = [ 50.0, 0.0,]
-"tax-deferred savings balances" = [ 900.0, 500.0,]
-"tax-free savings balances" = [ 0.0, 0.0,]
-"Beneficiary fractions" = [ 1.0, 1.0, 1.0,]
-"Spousal surplus deposit fraction" = 0.0
-
-["Wages and Contributions"]
-"Contributions file name" = "edited values"
-
-["Fixed Income"]
-"Pension amounts" = [ 0.0, 0.0,]
-"Pension ages" = [ 65, 65,]
-"Pension indexed" = [ false, false,]
-"Social security amounts" = [ 21.0, 21.0,]
-"Social security ages" = [ 65, 65,]
-
-["Rates Selection"]
-"Heirs rate on tax-deferred estate" = 30.0
-"Long-term capital gain tax rate" = 15.0
-"Dividend tax rate" = 2.0
-"TCJA expiration year" = 2026
-Method = "user"
-Values = [ 10.0, 0.0, 0.0, 3.5000000000000004,]
-From = 1928
-To = 2024
-
-["Asset Allocation"]
-"Interpolation method" = "linear"
-"Interpolation center" = 15.0
-"Interpolation width" = 5.0
-Type = "individual"
-generic = [ [ [ 100, 0, 0, 0,], [ 100, 0, 0, 0,],], [ [ 100, 0, 0, 0,], [ 100, 0, 0, 0,],],]
-
-["Optimization Parameters"]
-"Spending profile" = "flat"
-"Surviving spouse spending percent" = 60
-Objective = "maxSpending"
-
-["Solver Options"]
-maxRothConversion = 0.0
-noRothConversions = "None"
-withMedicare = true
-bequest = 30.0
-
-[Results]
-"Default plots" = "today"
+"Plan Name" = "Jon+Jane"
+Description = "This case reproduces a similar case discussed a while back on i-orp. It involves 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"
+Names = [ "Jon", "Jane",]
+"Birth year" = [ 1965, 1968,]
+"Life expectancy" = [ 92, 92,]
+"Start date" = "01-01"
+
+[Assets]
+"taxable savings balances" = [ 50.0, 0.0,]
+"tax-deferred savings balances" = [ 900.0, 500.0,]
+"tax-free savings balances" = [ 0.0, 0.0,]
+"Beneficiary fractions" = [ 1.0, 1.0, 1.0,]
+"Spousal surplus deposit fraction" = 0.0
+
+["Wages and Contributions"]
+"Contributions file name" = "edited values"
+
+["Fixed Income"]
+"Pension amounts" = [ 0.0, 0.0,]
+"Pension ages" = [ 65, 65,]
+"Pension indexed" = [ false, false,]
+"Social security amounts" = [ 21.0, 21.0,]
+"Social security ages" = [ 65, 65,]
+
+["Rates Selection"]
+"Heirs rate on tax-deferred estate" = 30.0
+"Long-term capital gain tax rate" = 15.0
+"Dividend tax rate" = 2.0
+"TCJA expiration year" = 2026
+Method = "user"
+Values = [ 10.0, 0.0, 0.0, 3.5000000000000004,]
+From = 1928
+To = 2024
+
+["Asset Allocation"]
+"Interpolation method" = "linear"
+"Interpolation center" = 15.0
+"Interpolation width" = 5.0
+Type = "individual"
+generic = [ [ [ 100, 0, 0, 0,], [ 100, 0, 0, 0,],], [ [ 100, 0, 0, 0,], [ 100, 0, 0, 0,],],]
+
+["Optimization Parameters"]
+"Spending profile" = "flat"
+"Surviving spouse spending percent" = 60
+Objective = "maxSpending"
+
+["Solver Options"]
+maxRothConversion = 0.0
+noRothConversions = "None"
+withMedicare = true
+bequest = 30.0
+
+[Results]
+"Default plots" = "today"

{owlplanner-2025.5.3 → owlplanner-2025.5.12}/notebooks/john+sally.ipynb

@@ -14,6 +14,17 @@
     "## John and Sally (a case from Eric Sajdak)"
    ]
   },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "5cb2c2a1-6f77-41bf-a22d-42863c756eeb",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import sys\n",
+    "sys.path.insert(0, \"../src\")"
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": null,
@@ -29,7 +40,9 @@
    "source": [
     "%%time\n",
     "import owlplanner as owl\n",
+    "\n",
     "plan = owl.Plan(['John', 'Sally'], [1962, 1962], [92, 92], 'john+sally')\n",
+    "# plan.setPlotBackend(\"plotly\")\n",
     "plan.setAccountBalances(taxable=[200, 200], taxDeferred=[750, 750], taxFree=[50, 50])\n",
     "# Unrealistic empty contributions and wages\n",
     "plan.readContributions('../examples/john+sally.xlsx')\n",