owlplanner 2025.5.5__tar.gz → 2025.5.12__tar.gz

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

@@ -30,4 +30,4 @@
   "forwardPorts": [
     8501
   ]
-}
+}

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: owlplanner
-Version: 2025.5.5
+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.5 → 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.5 → 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",

{owlplanner-2025.5.5 → owlplanner-2025.5.12}/notebooks/kim+sam.ipynb

@@ -15,7 +15,8 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "import owlplanner as owl"
+    "import sys\n",
+    "sys.path.insert(0, \"../src\")"
    ]
   },
   {
@@ -25,7 +26,9 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "p = owl.Plan(['Kim', 'Sam'], [1966, 1967], [86, 89], 'kim+sam-spending', verbose=True)"
+    "import owlplanner as owl\n",
+    "p = owl.Plan(['Kim', 'Sam'], [1966, 1967], [86, 89], 'kim+sam-spending', verbose=True)\n",
+    "# p.setPlotBackend(\"plotly\")"
    ]
   },
   {
@@ -81,7 +84,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "p.readContributions('../examples/template.xlsx')"
+    "p.readContributions('../examples/template.xlsx');"
    ]
   },
   {
@@ -126,12 +129,21 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "id": "525f22e2-d241-4fa8-bc95-82d758238326",
+   "id": "f2542fd7-f087-4597-b9c4-1c3b8fa2e452",
    "metadata": {},
    "outputs": [],
    "source": [
     "p.setDefaultPlots('today')\n",
-    "p.showNetSpending()\n",
+    "p.showNetSpending()"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "525f22e2-d241-4fa8-bc95-82d758238326",
+   "metadata": {},
+   "outputs": [],
+   "source": [
     "p.showGrossIncome()\n",
     "p.showTaxes()\n",
     "p.showSources()\n",