owlplanner 2025.11.5__tar.gz → 2025.12.3__tar.gz

{owlplanner-2025.11.5 → owlplanner-2025.12.3}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: owlplanner
-Version: 2025.11.5
-Summary: Owl: Retirement planner with great wisdom
+Version: 2025.12.3
+Summary: Owl - Optimal Wealth Lab: Retirement planner with great wisdom
 Project-URL: HomePage, https://github.com/mdlacasse/owl
 Project-URL: Repository, https://github.com/mdlacasse/owl
 Project-URL: Issues, https://github.com/mdlacasse/owl/issues
@@ -684,19 +684,20 @@ License:                     GNU GENERAL PUBLIC LICENSE
         Public License instead of this License.  But first, please read
         <https://www.gnu.org/licenses/why-not-lgpl.html>.
 License-File: LICENSE
-Classifier: Development Status :: 4 - Beta
+Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: End Users/Desktop
 Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
 Classifier: Topic :: Office/Business :: Financial :: Investment
-Requires-Python: >=3.8
+Requires-Python: >=3.10
+Requires-Dist: highspy
 Requires-Dist: matplotlib
 Requires-Dist: numpy
 Requires-Dist: odfpy
 Requires-Dist: openpyxl
 Requires-Dist: pandas
-Requires-Dist: plotly
+Requires-Dist: plotly>=6.3
 Requires-Dist: pulp
 Requires-Dist: scipy
 Requires-Dist: seaborn
@@ -721,16 +722,16 @@ 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:
+There are three ways to run Owl:
 
-- Run Owl directly on the Streamlit Community Server at
+- **Streamlit Hub:** Run Owl remotely as hosted 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.
+- **Docker Container:** Run Owl locally on your computer using a Docker image.
+Follow these [instructions](docker/README.md) for using this option.
 
-- Run locally on your computer using Python code and libraries.
-Follow these [instructions](INSTALL.md) to install Owl from the source code and run it on your computer.
+- **Self-hosting:** Run Owl locally on your computer using Python code and libraries.
+Follow these [instructions](INSTALL.md) to install from the source code and self-host on your own computer.
 
 -------------------------------------------------------------------------------------
 ## Overview
@@ -750,13 +751,17 @@ your strategy under different market assumptions, helping to better understand y
 
 -------------------------------------------------------------------------------------
 ## Purpose and vision
-The goal of Owl is to create a free and open-source ecosystem that has cutting-edge optimization capabilities,
+One goal of Owl is to provide a free and open-source ecosystem that has cutting-edge optimization capabilities,
 allowing for the next generation of Python-literate retirees to experiment with their own financial future
-while providing a codebase where they can learn and contribute. There are and were
+while providing a codebase where they can learn and contribute. At the same time, an intuitive and easy-to-use
+user interface based on Streamlit allows a broad set of users to benefit from the application as it only requires basic financial knowledge.
+
+There are and were
 good retirement optimizers in the recent past, but the vast majority of them are either proprietary platforms
 collecting your data, or academic papers that share the results without really sharing the details of
 the underlying mathematical models.
-The algorithms in Owl rely on the open-source HiGHS linear programming solver. The complete formulation and
+The algorithms in Owl rely on the open-source HiGHS linear programming solver but they have also been ported and tested on
+other platforms such as Mosek and COIN-OR. The complete formulation and
 detailed description of the underlying
 mathematical model can be found [here](https://github.com/mdlacasse/Owl/blob/main/docs/owl.pdf).
 
@@ -844,13 +849,16 @@ They can also be optimized explicitly as an option, but this choice can lead to
 due to the use of the many additional binary variables required by the formulation.
 Future Medicare and IRMAA values are simple projections of current values with the assumed inflation rates.
 
+Owl has a basic social security calculator that determines the actual benefits based on the individual's
+primary insurance amount (PIA), full retirement age (FRA), and claiming age. Both
+spousal's benefits and survivor's benefits are calculated for non-complex cases.
+
 ### Limitations
 Owl is work in progress. At the current time:
 - Only the US federal income tax is considered (and minimized through the optimization algorithm).
 Head of household filing status has not been added but can easily be.
 - Required minimum distributions are calculated, but tables for spouses more than 10 years apart are not included.
 These cases are detected and will generate an error message.
-- Social security rule for surviving spouse assumes that benefits were taken at full retirement age.
 - Current version has no optimization of asset allocations between individuals and/or types of savings accounts.
 If there is interest, that could be added in the future.
 - In the current implementation, social securiy is always taxed at 85%, assuming that your taxable income will be larger than 34 k$ (single) or 44 k$ (married filing jointly).

{owlplanner-2025.11.5 → owlplanner-2025.12.3}/README.md

@@ -15,16 +15,16 @@ 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:
+There are three ways to run Owl:
 
-- Run Owl directly on the Streamlit Community Server at
+- **Streamlit Hub:** Run Owl remotely as hosted 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.
+- **Docker Container:** Run Owl locally on your computer using a Docker image.
+Follow these [instructions](docker/README.md) for using this option.
 
-- Run locally on your computer using Python code and libraries.
-Follow these [instructions](INSTALL.md) to install Owl from the source code and run it on your computer.
+- **Self-hosting:** Run Owl locally on your computer using Python code and libraries.
+Follow these [instructions](INSTALL.md) to install from the source code and self-host on your own computer.
 
 -------------------------------------------------------------------------------------
 ## Overview
@@ -44,13 +44,17 @@ your strategy under different market assumptions, helping to better understand y
 
 -------------------------------------------------------------------------------------
 ## Purpose and vision
-The goal of Owl is to create a free and open-source ecosystem that has cutting-edge optimization capabilities,
+One goal of Owl is to provide a free and open-source ecosystem that has cutting-edge optimization capabilities,
 allowing for the next generation of Python-literate retirees to experiment with their own financial future
-while providing a codebase where they can learn and contribute. There are and were
+while providing a codebase where they can learn and contribute. At the same time, an intuitive and easy-to-use
+user interface based on Streamlit allows a broad set of users to benefit from the application as it only requires basic financial knowledge.
+
+There are and were
 good retirement optimizers in the recent past, but the vast majority of them are either proprietary platforms
 collecting your data, or academic papers that share the results without really sharing the details of
 the underlying mathematical models.
-The algorithms in Owl rely on the open-source HiGHS linear programming solver. The complete formulation and
+The algorithms in Owl rely on the open-source HiGHS linear programming solver but they have also been ported and tested on
+other platforms such as Mosek and COIN-OR. The complete formulation and
 detailed description of the underlying
 mathematical model can be found [here](https://github.com/mdlacasse/Owl/blob/main/docs/owl.pdf).
 
@@ -138,13 +142,16 @@ They can also be optimized explicitly as an option, but this choice can lead to
 due to the use of the many additional binary variables required by the formulation.
 Future Medicare and IRMAA values are simple projections of current values with the assumed inflation rates.
 
+Owl has a basic social security calculator that determines the actual benefits based on the individual's
+primary insurance amount (PIA), full retirement age (FRA), and claiming age. Both
+spousal's benefits and survivor's benefits are calculated for non-complex cases.
+
 ### Limitations
 Owl is work in progress. At the current time:
 - Only the US federal income tax is considered (and minimized through the optimization algorithm).
 Head of household filing status has not been added but can easily be.
 - Required minimum distributions are calculated, but tables for spouses more than 10 years apart are not included.
 These cases are detected and will generate an error message.
-- Social security rule for surviving spouse assumes that benefits were taken at full retirement age.
 - Current version has no optimization of asset allocations between individuals and/or types of savings accounts.
 If there is interest, that could be added in the future.
 - In the current implementation, social securiy is always taxed at 85%, assuming that your taxable income will be larger than 34 k$ (single) or 44 k$ (married filing jointly).

{owlplanner-2025.11.5 → owlplanner-2025.12.3}/RELEASE_NOTES.md

@@ -1,3 +1,20 @@
+### Version 2025.12.03
+- Coded social security to use monthly PIA instead of annual amount
+    - Added exact routines for FRA and increase/decrease factors due to claiming age
+    - Added exact spousal benefits
+- Adjusted documentation for social security
+- Added birth month for more precise calculation on first year of social security
+- Added month to age for claiming social security 
+
+### Version 2025.11.29
+- Fixed social security for survivor
+- Enhanced documentation for SS amounts
+
+### Version 2025.11.09
+- Moved development status to production/stable in pyproject
+- Made version propagate everywhere needed
+- Added node limit on milp to avoid Streamlit server shutdown on memory consumption
+
 ### Version 2025.11.05
 - Mentioning Owl as Optimal Wealth Lab
 - Port to Streamlit 1.50 which broke many widgets
@@ -5,7 +22,6 @@
 - Rework Docker to smaller Alpine image and fix docs
 
 ### Version 2025.07.01
-
 Added:
 - Settings option for menu position thanks to Streamlit 1.46 top and sidebar capabilities. Default is top.
 - Net Investment Income Tax calculations in self-consistent loop.

{owlplanner-2025.11.5 → owlplanner-2025.12.3}/docker/README.md

@@ -9,7 +9,7 @@
 This document describes how to run Owl using a Docker container.
 
 ------------------------------------------------------------------------------------
-### Run Owl without the source code
+### Running Owl without the source code
 Using this approach only requires downloading the Docker image from
 the [Docker Hub](http://hub.docker.com) and having the [Docker](http://docker.com)
 application installed on your computer.

owlplanner-2025.12.3/docker/build.cmd

@@ -0,0 +1,7 @@
+::
+:: A simple script to build both Docker images
+::
+docker build --no-cache -f Dockerfile.bare -t owlplanner/owldocker.bare:latest .
+docker push owlplanner/owldocker.bare
+docker build --no-cache -f Dockerfile.static -t owlplanner/owldocker.static:latest .
+docker push owlplanner/owldocker.static

{owlplanner-2025.11.5 → owlplanner-2025.12.3}/examples/case_drawdowncalc-comparison-1.toml

@@ -5,6 +5,7 @@ Description = "This is a case involving a single individual. Case is used for co
 Status = "single"
 Names = [ "Charles",]
 "Birth year" = [ 1966,]
+"Birth month" = [ 1,]
 "Life expectancy" = [ 89,]
 "Start date" = "2025-01-01"
 
@@ -20,7 +21,7 @@ Names = [ "Charles",]
 "Pension amounts" = [ 0.0,]
 "Pension ages" = [ 65,]
 "Pension indexed" = [ true,]
-"Social security amounts" = [ 36.0,]
+"Social security PIA amounts" = [ 3000,]
 "Social security ages" = [ 70,]
 
 ["Rates Selection"]

{owlplanner-2025.11.5 → owlplanner-2025.12.3}/examples/case_jack+jill.toml

@@ -5,6 +5,7 @@ Description = "This example aims to demonstrate some of Owl's capabilities. Jack
 Status = "married"
 Names = [ "Jack", "Jill",]
 "Birth year" = [ 1962, 1965,]
+"Birth month" = [ 1, 1,]
 "Life expectancy" = [ 89, 92,]
 "Start date" = "01-01"
 
@@ -22,7 +23,7 @@ Names = [ "Jack", "Jill",]
 "Pension amounts" = [ 0.0, 10.5,]
 "Pension ages" = [ 65, 65,]
 "Pension indexed" = [ false, false,]
-"Social security amounts" = [ 28.4, 19.7,]
+"Social security PIA amounts" = [ 2360, 1642,]
 "Social security ages" = [ 70, 62,]
 
 ["Rates Selection"]

{owlplanner-2025.11.5 → owlplanner-2025.12.3}/examples/case_joe.toml

@@ -5,6 +5,7 @@ Description = "This is an example of a case involving a single individual. Joe i
 Status = "single"
 Names = [ "Joe",]
 "Birth year" = [ 1966,]
+"Birth month" = [ 1,]
 "Life expectancy" = [ 89,]
 "Start date" = "01-01"
 
@@ -20,7 +21,7 @@ Names = [ "Joe",]
 "Pension amounts" = [ 18.0,]
 "Pension ages" = [ 65,]
 "Pension indexed" = [ true,]
-"Social security amounts" = [ 28.4,]
+"Social security PIA amounts" = [ 2360,]
 "Social security ages" = [ 67,]
 
 ["Rates Selection"]

{owlplanner-2025.11.5 → owlplanner-2025.12.3}/examples/case_john+sally.toml

@@ -5,6 +5,7 @@ Description = "This example reproduces the case of John and Sally, discussed by
 Status = "married"
 Names = [ "John", "Sally",]
 "Birth year" = [ 1962, 1962,]
+"Birth month" = [ 1, 1,]
 "Life expectancy" = [ 92, 92,]
 "Start date" = "01-01"
 
@@ -22,7 +23,7 @@ Names = [ "John", "Sally",]
 "Pension amounts" = [ 0.0, 0.0,]
 "Pension ages" = [ 65, 65,]
 "Pension indexed" = [ false, false,]
-"Social security amounts" = [ 36.0, 21.6,]
+"Social security PIA amounts" = [ 3000, 1800,]
 "Social security ages" = [ 67, 67,]
 
 ["Rates Selection"]

{owlplanner-2025.11.5 → owlplanner-2025.12.3}/examples/case_jon+jane.toml

@@ -5,6 +5,7 @@ Description = "This case reproduces a similar case discussed a while back on i-o
 Status = "married"
 Names = [ "Jon", "Jane",]
 "Birth year" = [ 1965, 1968,]
+"Birth month" = [ 1, 1,]
 "Life expectancy" = [ 92, 92,]
 "Start date" = "01-01"
 
@@ -22,7 +23,7 @@ Names = [ "Jon", "Jane",]
 "Pension amounts" = [ 0.0, 0.0,]
 "Pension ages" = [ 65, 65,]
 "Pension indexed" = [ false, false,]
-"Social security amounts" = [ 21.0, 21.0,]
+"Social security PIA amounts" = [ 1750, 1750,]
 "Social security ages" = [ 65, 65,]
 
 ["Rates Selection"]

{owlplanner-2025.11.5 → owlplanner-2025.12.3}/examples/case_kim+sam-bequest.toml

@@ -5,6 +5,7 @@ Description = "This is the case of Kim and Sam used as an example case for optim
 Status = "married"
 Names = [ "Kim", "Sam",]
 "Birth year" = [ 1966, 1967,]
+"Birth month" = [ 1, 1,]
 "Life expectancy" = [ 86, 89,]
 "Start date" = "01-01"
 
@@ -22,7 +23,7 @@ Names = [ "Kim", "Sam",]
 "Pension amounts" = [ 0.0, 0.0,]
 "Pension ages" = [ 65, 65,]
 "Pension indexed" = [ false, false,]
-"Social security amounts" = [ 45.0, 25.0,]
+"Social security PIA amounts" = [ 3750, 2083,]
 "Social security ages" = [ 70, 68,]
 
 ["Rates Selection"]

{owlplanner-2025.11.5 → owlplanner-2025.12.3}/examples/case_kim+sam-spending.toml

@@ -5,6 +5,7 @@ Description = "This is the case of Kim and Sam used as an example case for optim
 Status = "married"
 Names = [ "Kim", "Sam",]
 "Birth year" = [ 1966, 1967,]
+"Birth month" = [ 1, 1,]
 "Life expectancy" = [ 86, 89,]
 "Start date" = "01-01"
 
@@ -22,7 +23,7 @@ Names = [ "Kim", "Sam",]
 "Pension amounts" = [ 0.0, 0.0,]
 "Pension ages" = [ 65, 65,]
 "Pension indexed" = [ false, false,]
-"Social security amounts" = [ 45.0, 25.0,]
+"Social security PIA amounts" = [ 3750, 2083,]
 "Social security ages" = [ 70, 68,]
 
 ["Rates Selection"]

{owlplanner-2025.11.5 → owlplanner-2025.12.3}/notebooks/john+sally.ipynb

@@ -41,14 +41,14 @@
     "%%time\n",
     "import owlplanner as owl\n",
     "\n",
-    "plan = owl.Plan(['John', 'Sally'], [1962, 1962], [92, 92], 'john+sally')\n",
+    "plan = owl.Plan(['John', 'Sally'], [1962, 1962], [1, 1], [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",
     "# plan.setInterpolationMethod('s-curve')\n",
     "plan.setAllocationRatios('individual', generic=[[[60, 40, 0, 0], [60, 40, 0, 0]], [[60, 40, 0, 0], [60, 40, 0, 0]]])\n",
-    "plan.setSocialSecurity([36, 21.6], [67, 67])\n",
+    "plan.setSocialSecurity([3000, 1800], [67, 67])\n",
     "#plan.setSpendingProfile('smile')\n",
     "plan.setSpendingProfile('flat')\n",
     "plan.setRates('historical average', 1990, 2023)\n",

{owlplanner-2025.11.5 → owlplanner-2025.12.3}/notebooks/kim+sam.ipynb

@@ -27,7 +27,7 @@
    "outputs": [],
    "source": [
     "import owlplanner as owl\n",
-    "p = owl.Plan(['Kim', 'Sam'], [1966, 1967], [86, 89], 'kim+sam-spending', verbose=True)\n",
+    "p = owl.Plan(['Kim', 'Sam'], [1966, 1967], [1, 1], [86, 89], 'kim+sam-spending', verbose=True)\n",
     "# p.setPlotBackend(\"plotly\")"
    ]
   },
@@ -39,7 +39,7 @@
    "outputs": [],
    "source": [
     "# p.setPension([0, 0], [65, 65])\n",
-    "p.setSocialSecurity([45, 25], [70, 68])"
+    "p.setSocialSecurity([3750, 2083], [70, 68])"
    ]
   },
   {

{owlplanner-2025.11.5 → owlplanner-2025.12.3}/notebooks/template.ipynb

@@ -135,7 +135,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "plan = owl.Plan(['Kim', 'Sam'], [YYYY, YYYY], [AA, AA], 'Kim+Sam-spending', verbose=True)"
+    "plan = owl.Plan(['Kim', 'Sam'], [YYYY, YYYY], [MM, MM], [AA, AA], 'Kim+Sam-spending', verbose=True)"
    ]
   },
   {
@@ -340,13 +340,13 @@
    "metadata": {},
    "source": [
     "## What about anticipated fixed income?\n",
-    "Pension and social security are fixed income. Model here assumes that pension income is not inflation adjusted while social security benefits are (but Owl can easily be modified to account for inflation-adjusted pensions). Numbers to be provided are the predicted annual amount for each spouse and the age of the commencement of benefits.\n",
+    "Pension and social security are fixed income. Pension income can be adjusted for inflation as social security benefits are. Numbers to be provided are the predicted annual amount for each spouse and the age of the commencement of benefits.\n",
     "\n",
     "By default, no pension benefits are assumed. This can also be specified explicitly by entering zeros (0) as entries, as in\n",
     "\n",
-    "    plan.setPension([0, 0], [65, 65])\n",
+    "    plan.setPension([0, 0], [65, 65], [False, False])\n",
     "    \n",
-    "For social security, one must provide the predicted annual amount(s) and the starting age(s) at which benefits are anticipated to be received. There are plenty of social security benefit estimators on the web, including the info you can get directly from your own account at the Social Security Administration (ssa.gov). Another interesting calculator can be found at www.opensocialsecurity.com. This calculator allows you to compare different scenarios regarding your commencement age through a sensitivity plot.\n"
+    "For social security, one must provide the predicted monthly Primary Insurance Amount(s) and the starting age(s) at which benefits are anticipated to be received. There are plenty of social security benefit estimators on the web, including the info you can get directly from your own account at the Social Security Administration (ssa.gov). Another interesting calculator can be found at www.opensocialsecurity.com. This calculator allows you to compare different scenarios regarding your commencement age through a sensitivity plot.\n"
    ]
   },
   {

{owlplanner-2025.11.5 → owlplanner-2025.12.3}/notebooks/tutorial_1.ipynb

@@ -133,7 +133,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "plan = owl.Plan(['Jack', 'Jill'], [1962, 1965], [89, 92], 'jack+jill-spending-69')"
+    "plan = owl.Plan(['Jack', 'Jill'], [1962, 1965], [1, 1], [89, 92], 'jack+jill-spending-69')"
    ]
   },
   {
@@ -332,13 +332,13 @@
    "metadata": {},
    "source": [
     "## What about anticipated fixed income?\n",
-    "Pension and social security are fixed income. Model here assumes that pension income is not inflation adjusted while social security benefits are (but Owl can easily be modified to account for inflation-adjusted pensions). Numbers to be provided are the predicted annual amount for each spouse and the age of the commencement of benefits. Values are expressed in today's dollars (as do statements from the Social Security Administration).\n",
+    "Pension and social security are fixed income. Pension income can be inflation adjusted as social security benefits are. Numbers to be provided are the predicted annual amount for each spouse and the age of the commencement of benefits. Values are expressed in today's dollars (as do statements from the Social Security Administration).\n",
     "\n",
     "By default, no pension benefits are assumed. This can also be specified explicitly by entering zeros (0) as entries, as in\n",
     "\n",
     "    plan.setPension([0, 0], [65, 65])\n",
     "    \n",
-    "For social security, one must provide the predicted annual amount(s) and the starting age(s) at which benefits are anticipated to be received. There are plenty of social security benefit estimators on the web, including the info you can get directly from your own account at the Social Security Administration (ssa.gov). Another interesting calculator can be found at www.opensocialsecurity.com. This calculator allows you to compare different scenarios regarding your commencement age through a sensitivity plot.\n"
+    "For social security, one must provide the predicted monthly Primary Insurance Amount(s) and the starting age(s) at which benefits are anticipated to be received. There are plenty of social security benefit estimators on the web, including the info you can get directly from your own account at the Social Security Administration (ssa.gov). Another interesting calculator can be found at www.opensocialsecurity.com. This calculator allows you to compare different scenarios regarding your commencement age through a sensitivity plot.\n"
    ]
   },
   {
@@ -346,7 +346,7 @@
    "id": "43bd9a2a-e2bf-434f-88ac-b0a70dcdd1fd",
    "metadata": {},
    "source": [
-    "Here, Jill has an unindexed pension of \\\\$10 k per year. Both Jack and Jill believe they have good genes and decided to take their social security benefits at age 70. The amounts provided (28k\\\\$ and 25k\\\\$) are estimation of the amounts they would receive at age 70."
+    "Here, Jill has an unindexed pension of \\\\$10 k per year. Both Jack and Jill believe they have good genes and decided to take their social security benefits at age 70. The amounts provided (28k\\\\$ and 25k\\\\$) are estimation of the amounts they would receive at Full Retirement Age (FRA)."
    ]
   },
   {
@@ -357,7 +357,7 @@
    "outputs": [],
    "source": [
     "plan.setPension([0, 10], [65, 65])\n",
-    "plan.setSocialSecurity([28, 25], [70, 70])"
+    "plan.setSocialSecurity([2333, 2083], [70, 70])"
    ]
   },
   {

{owlplanner-2025.11.5 → owlplanner-2025.12.3}/notebooks/tutorial_2.ipynb

@@ -95,7 +95,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "plan = owl.Plan(['Jack', 'Jill'], [1962, 1965], [89, 92], 'jack+jill-spending-MC', verbose=True)"
+    "plan = owl.Plan(['Jack', 'Jill'], [1962, 1965], [1, 1], [89, 92], 'jack+jill-spending-MC', verbose=True)"
    ]
   },
   {
@@ -145,7 +145,7 @@
    "outputs": [],
    "source": [
     "plan.setPension([0, 10], [65, 65])\n",
-    "plan.setSocialSecurity([28, 25], [70, 70])"
+    "plan.setSocialSecurity([2333, 2083], [70, 70])"
    ]
   },
   {

{owlplanner-2025.11.5 → owlplanner-2025.12.3}/notebooks/tutorial_3.ipynb

@@ -95,7 +95,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "plan = owl.Plan(['Jack', 'Jill'], [1962, 1965], [89, 92], 'jack+jill-tutorial3', verbose=True)"
+    "plan = owl.Plan(['Jack', 'Jill'], [1962, 1965], [1, 1], [89, 92], 'jack+jill-tutorial3', verbose=True)"
    ]
   },
   {
@@ -145,7 +145,7 @@
    "outputs": [],
    "source": [
     "plan.setPension([0, 10], [65, 65])\n",
-    "plan.setSocialSecurity([28, 25], [70, 70])"
+    "plan.setSocialSecurity([2333, 2083], [70, 70])"
    ]
   },
   {

{owlplanner-2025.11.5 → owlplanner-2025.12.3}/pyproject.toml

@@ -2,20 +2,23 @@
 requires = ["hatchling"]
 build-backend = "hatchling.build"
 
+[tool.hatch.version]
+path = "src/owlplanner/version.py"
+
 [project]
 name = "owlplanner"
-version = "2025.11.05"
+dynamic = ["version"]
 authors = [
   { name="Martin-D. Lacasse", email="martin.d.lacasse@gmail.com" },
 ]
 maintainers = [
   { name="Martin-D. Lacasse", email="martin.d.lacasse@gmail.com" },
 ]
-description = "Owl: Retirement planner with great wisdom"
+description = "Owl - Optimal Wealth Lab: Retirement planner with great wisdom"
 readme = "README.md"
-requires-python = ">=3.8"
+requires-python = ">=3.10"
 classifiers = [
-    "Development Status :: 4 - Beta",
+    "Development Status :: 5 - Production/Stable",
     "Programming Language :: Python :: 3",
     "Intended Audience :: End Users/Desktop",
     "Topic :: Office/Business :: Financial :: Investment",
@@ -24,12 +27,13 @@ classifiers = [
     "Programming Language :: Python :: 3",
 ]
 dependencies = [
+    "highspy",
     "matplotlib",
     "numpy",
     "odfpy",
     "openpyxl",
     "pandas",
-    "plotly",
+    "plotly>=6.3",
     "pulp",
     "seaborn",
     "scipy",

{owlplanner-2025.11.5 → owlplanner-2025.12.3}/src/owlplanner/config.py

@@ -37,6 +37,7 @@ def saveConfig(myplan, file, mylog):
         "Status": ["unknown", "single", "married"][myplan.N_i],
         "Names": myplan.inames,
         "Birth year": myplan.yobs.tolist(),
+        "Birth month": myplan.mobs.tolist(),
         "Life expectancy": myplan.expectancy.tolist(),
         "Start date": myplan.startDate,
     }
@@ -55,10 +56,10 @@ def saveConfig(myplan, file, mylog):
 
     # Fixed Income.
     diconf["Fixed Income"] = {
-        "Pension amounts": (myplan.pensionAmounts / 1000).tolist(),
+        "Pension monthly amounts": (myplan.pensionAmounts).tolist(),
         "Pension ages": myplan.pensionAges.tolist(),
         "Pension indexed": myplan.pensionIsIndexed,
-        "Social security amounts": (myplan.ssecAmounts / 1000).tolist(),
+        "Social security PIA amounts": (myplan.ssecAmounts).tolist(),
         "Social security ages": myplan.ssecAges.tolist(),
     }
 
@@ -181,11 +182,13 @@ def readConfig(file, *, verbose=True, logstreams=None, readContributions=True):
     inames = diconf["Basic Info"]["Names"]
     # status = diconf['Basic Info']['Status']
     yobs = diconf["Basic Info"]["Birth year"]
-    expectancy = diconf["Basic Info"]["Life expectancy"]
     icount = len(yobs)
+    # Default to January if no month entry found.
+    mobs = diconf["Basic Info"].get("Birth month", [1]*icount)
+    expectancy = diconf["Basic Info"]["Life expectancy"]
     s = ["", "s"][icount - 1]
     mylog.vprint(f"Plan for {icount} individual{s}: {inames}.")
-    p = plan.Plan(inames, yobs, expectancy, name, verbose=True, logstreams=logstreams)
+    p = plan.Plan(inames, yobs, mobs, expectancy, name, verbose=True, logstreams=logstreams)
     p._description = diconf.get("Description", "")
 
     # Assets.
@@ -217,11 +220,11 @@ def readConfig(file, *, verbose=True, logstreams=None, readContributions=True):
             mylog.vprint(f"Ignoring to read contributions file {timeListsFileName}.")
 
     # Fixed Income.
-    ssecAmounts = np.array(diconf["Fixed Income"]["Social security amounts"], dtype=np.float32)
-    ssecAges = np.array(diconf["Fixed Income"]["Social security ages"], dtype=np.int32)
+    ssecAmounts = np.array(diconf["Fixed Income"].get("Social security PIA amounts", [0]*icount), dtype=np.int32)
+    ssecAges = np.array(diconf["Fixed Income"]["Social security ages"])
     p.setSocialSecurity(ssecAmounts, ssecAges)
-    pensionAmounts = np.array(diconf["Fixed Income"]["Pension amounts"], dtype=np.float32)
-    pensionAges = np.array(diconf["Fixed Income"]["Pension ages"], dtype=np.int32)
+    pensionAmounts = np.array(diconf["Fixed Income"].get("Pension monthly amounts", [0]*icount), dtype=np.float32)
+    pensionAges = np.array(diconf["Fixed Income"]["Pension ages"])
     pensionIsIndexed = diconf["Fixed Income"]["Pension indexed"]
     p.setPension(pensionAmounts, pensionAges, pensionIsIndexed)