owlplanner 2025.2.5__tar.gz → 2025.2.6__tar.gz

{owlplanner-2025.2.5 → owlplanner-2025.2.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: owlplanner
-Version: 2025.2.5
+Version: 2025.2.6
 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.5 → owlplanner-2025.2.6}/pyproject.toml

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

{owlplanner-2025.2.5 → owlplanner-2025.2.6}/src/owlplanner/plan.py

@@ -540,7 +540,7 @@ class Plan(object):
 
         if self.N_i == 2:
             # Approximate calculation for spousal benefit (only valid at FRA).
-            self.zeta_in[self.i_s, self.n_d:] = max(amounts[self.i_s], amounts[self.i_d] / 2)
+            self.zeta_in[self.i_s, self.n_d:] = max(amounts[self.i_s], amounts[self.i_d])
 
         self.ssecAmounts = np.array(amounts)
         self.ssecAges = np.array(ages, dtype=np.int32)

owlplanner-2025.2.6/src/owlplanner/version.py

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

{owlplanner-2025.2.5 → owlplanner-2025.2.6}/ui/About_Owl.py

@@ -12,7 +12,7 @@ st.snow()
 
 st.write('''
 - Owl is released under GPL Licence through a publicly available
-repository on [github](https://github.com/mdlacasse/owl).
+repository on [GitHub](https://github.com/mdlacasse/owl).
 
 - Mathematical formulation of the linear optimization problem can be
 found [here](https://raw.github.com/mdlacasse/Owl/main/docs/owl.pdf).

owlplanner-2025.2.5/ui/Basic_Info.py → owlplanner-2025.2.6/ui/Create_Case.py

@@ -7,7 +7,7 @@ import owlbridge as owb
 
 caseChoices = kz.allCaseNames()
 ret = kz.titleBar('setup', caseChoices)
-kz.caseHeader("Basic Info")
+kz.caseHeader("Create Case")
 
 if ret == kz.newCase:
     st.info('#### Starting a new case from scratch.\n\n'

{owlplanner-2025.2.5 → owlplanner-2025.2.6}/ui/Documentation.py

@@ -46,7 +46,7 @@ There are four sections in the user interface:
 ### :orange[Case Setup]
 This section contains the steps for creating and configuring case scenarios.
 
-#### Basic Info
+#### Create Case
 This page is where every new scenario begins.
 It controls the creation of scenarios as the `Select case` drop-down menu contains
 two additional items when this page is open:
@@ -72,7 +72,7 @@ An example is provided
 can be found in this [directory](https://github.com/mdlacasse/Owl/blob/main/examples/).
 Using a *case* file
 will populate all the fields required to run a scenario. A *case* file for the case being developed
-can be saved under the [Case Summary](#case-summary) page and made available to reload at a later time.
+can be saved under the [Output Files](#output-files) page and made available to reload at a later time.
 Case parameter files can have any name but when saving from the interface, their name will start with *case_*
 followed by the case name.
 
@@ -246,8 +246,10 @@ As one of the two choices (net spending or bequest) is selected as the value to
 the other becomes a constraint to obey.
 
 The maximum amount for Roth conversions and who can execute them is configurable.
-If a *Wages and Contributions* file has been uploaded and the `Convert from contributions file`
-button is toggled, Roth conversions will not be optimized, but will rather be performed according to
+Roth conversions are optimized for reducing taxes and maximizing the selected objective function,
+unless the `Convert from contributions file`
+button is toggled, in which case Roth conversions will not be optimized,
+but will rather be performed according to
 the `Roth conv` column on the
 [Wages and Contributions](#wages-and-contributions) page.
 
@@ -285,8 +287,6 @@ This simulation uses a single instance of a series of rates, either fixed or var
 as selected in the **Case Setup** section.
 The outcome is optimized according to the chosen parameters: either maximize the
 net spending, of maximize the bequest under the constraint of a net spending amount.
-If `Convert from contributions file` is not toggled on,
-Roth conversions are optimized for reducing taxes and maximizing the selected objective function.
 Various plots show the results, which can be displayed in today's \\$ or
 in nominal value.
 
@@ -298,26 +298,29 @@ these graphs, two additional buttons will appear.
 This page shows the various worksheets containing annual transactions
 and savings account balances in nominal \\$.
 Each table can be downloaded separately in csv format, or all tables can be downloaded
-together as an Excel workbook by clicking the button at the bottom
-of the page.
+together as an Excel workbook by clicking the associated button on the
+[Output Files](#output-files) page.
 Note that all values here (worksheets and workbook) are in \\$, not in thousands.
 The first line of the *Sources* worksheets are the most important
 as these lines are the only ones that are actionable.
 
-#### Case Summary
-This page shows a synopsis of the scenario which was computed.
-It displays informative sums of relevant income, bequest, and spending values.
+#### Output Files
+This page allow to save many files for future use.
+First it shows a synopsis of the computed scenario by
+displaying sums of income, bequest, and spending values over the duration of the plan.
 The contents of this page can be downloaded as a plain text file by
 clicking the button at the bottom of the section.
 
-Parameters used to generate the case are collected in *toml* format and displayed.
+Finally, parameters used to generate the case are collected in *toml* format and displayed.
 The `Download case file...` button allows to save the parameters used to generate the
 outcome of this case to a *case* file.
 
-Finally, another button called `Download wages and contributions file...` allows
+Another section called `Excel workbooks` allows
 to save the contents of the tables on the corresponding page to an Excel workbook.
-With both these files, the same case can be reproduced at a later time by uploading
-them through the widgets on the `Basic Info` and `Wages and Contributions` pages.
+
+With the case parameter and the wages and contributions files,
+the same case can be reproduced at a later time by uploading
+them through the widgets on the `Create Case` and `Wages and Contributions` pages.
 
 --------------------------------------------------------------------------------------
 ### :orange[Multiple Scenarios]

{owlplanner-2025.2.5 → owlplanner-2025.2.6}/ui/Graphs.py

@@ -26,7 +26,7 @@ else:
                   on_click=owb.runPlan, disabled=kz.caseIsNotRunReady())
 
     st.divider()
-    if kz.caseHasNotCompletedRun():
+    if kz.isCaseUnsolved():
         st.info("Case status is currently '%s'." % kz.getKey('caseStatus'))
     else:
         owb.plotSingleResults()

owlplanner-2025.2.5/ui/Case_Summary.py → owlplanner-2025.2.6/ui/Output_Files.py

@@ -4,7 +4,7 @@ import sskeys as kz
 import owlbridge as owb
 
 ret = kz.titleBar('summary')
-kz.caseHeader("Case Summary")
+kz.caseHeader("Output Files")
 
 if ret is None or kz.caseHasNoPlan():
     st.info('Case(s) must be first created before running this page.')
@@ -12,7 +12,7 @@ else:
     if kz.caseIsRunReady():
         owb.runPlan()
 
-    if kz.caseHasNotCompletedRun():
+    if kz.isCaseUnsolved():
         st.info("Case status is currently '%s'." % kz.getKey('caseStatus'))
     else:
         lines = kz.getKey('summary')
@@ -24,6 +24,27 @@ else:
                                file_name='Synopsis_'+kz.getKey('name')+'.txt',
                                mime='text/plain;charset=UTF-8')
 
+        st.divider()
+        st.write("#### Excel workbooks")
+        col1, col2 = st.columns(2, gap='large')
+        with col1:
+            download2 = st.download_button(
+                label="Download wages and contributions file",
+                help='Download wages and contributions as an Excel workbook.',
+                data=owb.saveContributions(),
+                file_name=kz.getKey('name')+'.xlsx',
+                disabled=kz.isCaseUnsolved(),
+                mime='application/vnd.ms-excel')
+
+        with col2:
+            download2 = st.download_button(
+                label="Download worksheets",
+                help='Download worksheets as an Excel workbook.',
+                data=owb.saveWorkbook(),
+                file_name='Workbook_'+kz.getKey('name')+'.xlsx',
+                mime='application/vnd.ms-excel',
+                disabled=kz.isCaseUnsolved())
+
         lines = kz.getKey('casetoml')
         if lines != '':
             st.divider()
@@ -34,13 +55,3 @@ else:
                                data=lines,
                                file_name='case_'+kz.getKey('name')+'.toml',
                                mime='application/toml')
-
-        st.divider()
-        st.write("#### Wages and contributions file")
-        download2 = st.download_button(
-            label="Download wages and contributions file",
-            help='Download Excel workbook.',
-            data=owb.saveContributions(),
-            file_name=kz.getKey('name')+'.xlsx',
-            disabled=kz.caseHasNotCompletedRun(),
-            mime='application/vnd.ms-excel')

{owlplanner-2025.2.5 → owlplanner-2025.2.6}/ui/Quick_Start.py

@@ -13,7 +13,8 @@ with col1:
     st.markdown('''
 Owl does not store any information related to a case:
 all is lost after a session is closed. For that reason,
-two files can be used to store the specifications of a case so that it can be recalled at a later time.
+two files can be used to store the specifications of a case so that it can be reproduced
+at a later time:
 - A *case* parameter file
 specifying account balances, asset allocation, social security and pension, rates,
 optimization parameters and related assumptions.
@@ -33,26 +34,25 @@ of Jack and Jill provided here as an example:
     - Wages and contributions file named
     [jack+jill.xlsx](https://raw.github.com/mdlacasse/Owl/main/examples/jack+jill.xlsx)
     in Excel format.
-1) Navigate to the **Basic Info** page and drag and drop the case parameter file
+1) Navigate to the **Create Case** page and drag and drop the case parameter file
 you just downloaded (*case_jack+jill.toml*).
 1) Navigate to the **Wages and Contributions** page and
 drag and drop the wages and contributions file you downloaded (*jack+jill.xlsx*).
-1) Move to the **Single Scenario** section to browse results.
+1) Move to the **Single Scenario** section to browse the simulation results.
 
 Congratulations! :balloon: You just ran your first case. You can now explore each page and
 experiment with different parameters.
 
 For creating your own cases, you can start
-from scratch by selecting `New Case...` in the selection box while on the **Basic Info** page,
+from scratch by selecting `New Case...` in the selection box while on the **Create Case** page,
 and fill in the information needed on each page of the `Case Setup` section.
 Once a case has been fully parameterized and successfully optimized,
-it can then be saved as a parameter file
-by using the `Download case file...` button on the `Case Results` page.
+its parameters can be saved by using the `Download case file...` button on the `Output Files` page.
 
 Alternatively, you can duplicate any existing case by using
 the `Duplicate case` button, and then edit its values to fit your situation.
 
-Multiple cases can coexist and can be called using the `Select case` box
+Multiple cases can coexist and can be called and compared using the `Select case` box
 at the bottom of the margin.
 
 More information can be found on the :material/help: **Documentation** page located in the **Resources** section.

owlplanner-2025.2.6/ui/Worksheets.py

@@ -0,0 +1,18 @@
+import streamlit as st
+
+import sskeys as kz
+import owlbridge as owb
+
+ret = kz.titleBar('worksheets')
+kz.caseHeader("Worksheets")
+
+if ret is None or kz.caseHasNoPlan():
+    st.info('Case(s) must be first created before running this page.')
+else:
+    if kz.caseIsRunReady():
+        owb.runPlan()
+
+    if kz.isCaseUnsolved():
+        st.info("Case status is currently '%s'." % kz.getKey('caseStatus'))
+    else:
+        owb.showWorkbook()

{owlplanner-2025.2.5 → owlplanner-2025.2.6}/ui/main.py

@@ -11,16 +11,16 @@ kz.init()
 st.logo('https://raw.github.com/mdlacasse/Owl/main/docs/images/owl.png', size='large')
 
 pages = {
-          'Case Setup': [st.Page('Basic_Info.py', icon=':material/person_add:'),
+          'Case Setup': [st.Page('Create_Case.py', icon=':material/person_add:'),
                          st.Page('Assets.py', icon=':material/savings:'),
                          st.Page('Wages_And_Contributions.py', icon=':material/work_history:'),
                          st.Page('Fixed_Income.py', icon=':material/currency_exchange:'),
                          st.Page('Rates_Selection.py', icon=':material/monitoring:'),
                          st.Page('Asset_Allocation.py', icon=':material/percent:'),
                          st.Page('Optimization_Parameters.py', icon=':material/tune:')],
-          'Single Scenario': [st.Page('Graphs.py', icon=':material/directions_run:'),
+          'Single Scenario': [st.Page('Graphs.py', icon=':material/stacked_line_chart:'),
                               st.Page('Worksheets.py', icon=':material/data_table:'),
-                              st.Page('Case_Summary.py', icon=':material/description:')],
+                              st.Page('Output_Files.py', icon=':material/description:')],
           'Multiple Scenarios': [st.Page('Historical_Range.py', icon=':material/history:'),
                                  st.Page('Monte_Carlo.py', icon=':material/finance:')],
           'Resources': [st.Page('Logs.py', icon=':material/error:'),

{owlplanner-2025.2.5 → owlplanner-2025.2.6}/ui/owlbridge.py

@@ -59,7 +59,6 @@ def _checkPlan(func):
     return wrapper
 
 
-# _checkPlan
 def prepareRun(plan):
     ni = 2 if kz.getKey('status') == 'married' else 1
 
@@ -103,10 +102,10 @@ def prepareRun(plan):
     plan.setLongTermCapitalTaxRate(kz.getKey('gainTx'))
     plan.setDividendRate(kz.getKey('divRate'))
 
-    setInterpolationMethod()
-    setAllocationRatios()
-    setRates()
-    setContributions()
+    _setInterpolationMethod(plan)
+    _setAllocationRatios(plan)
+    _setRates(plan)
+    _setContributions(plan, False)
 
 
 @_checkPlan
@@ -173,6 +172,10 @@ def runMC(plan):
 
 @_checkPlan
 def setRates(plan):
+    _setRates(plan)
+
+
+def _setRates(plan):
     yfrm = kz.getKey('yfrm')
     yto = kz.getKey('yto')
 
@@ -277,11 +280,19 @@ def showSources(plan):
 
 @_checkPlan
 def setInterpolationMethod(plan):
+    _setInterpolationMethod(plan)
+
+
+def _setInterpolationMethod(plan):
     plan.setInterpolationMethod(kz.getKey('interpMethod'), kz.getKey('interpCenter'), kz.getKey('interpWidth'))
 
 
 @_checkPlan
-def setContributions(plan):
+def setContributions(plan, reset=True):
+    _setContributions(plan, reset)
+
+
+def _setContributions(plan, reset):
     """
     Set from UI -> Plan.
     """
@@ -294,7 +305,10 @@ def setContributions(plan):
 
     try:
         plan.readContributions(dicDf)
-        kz.setKey('timeListsFileName', 'edited values')
+        if reset:
+            kz.setKey('timeListsFileName', 'edited values')
+        else:
+            kz.storeKey('timeListsFileName', 'edited values')
         plan.timeListsFileName = 'edited values'
     except Exception as e:
         st.error("Failed to parse contributions: %s" % (e))
@@ -332,6 +346,10 @@ def resetContributions(plan):
 
 @_checkPlan
 def setAllocationRatios(plan):
+    _setAllocationRatios(plan)
+
+
+def _setAllocationRatios(plan):
     if kz.getKey('allocType') == 'individual':
         try:
             generic = kz.getIndividualAllocationRatios()

{owlplanner-2025.2.5 → owlplanner-2025.2.6}/ui/requirements.txt

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

{owlplanner-2025.2.5 → owlplanner-2025.2.6}/ui/sskeys.py

@@ -123,14 +123,6 @@ def caseHasPlan():
     return getKey('plan') is not None
 
 
-def caseHasNotCompletedRun():
-    return not caseHasCompletedRun()
-
-
-def caseHasCompletedRun():
-    return getKey('caseStatus') == 'solved'
-
-
 def caseIsRunReady():
     return not caseIsNotRunReady() and getKey('caseStatus') in ['modified', 'new']
 

owlplanner-2025.2.5/src/owlplanner/version.py

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

owlplanner-2025.2.5/ui/Worksheets.py

@@ -1,27 +0,0 @@
-import streamlit as st
-
-import sskeys as kz
-import owlbridge as owb
-
-ret = kz.titleBar('worksheets')
-kz.caseHeader("Worksheets")
-
-if ret is None or kz.caseHasNoPlan():
-    st.info('Case(s) must be first created before running this page.')
-else:
-    if kz.caseIsRunReady():
-        owb.runPlan()
-
-    if kz.caseHasNotCompletedRun():
-        st.info("Case status is currently '%s'." % kz.getKey('caseStatus'))
-    else:
-        owb.showWorkbook()
-        st.divider()
-        if kz.caseHasPlan():
-            download2 = st.download_button(
-                label="Download data as an Excel workbook...",
-                data=owb.saveWorkbook(),
-                file_name='Workbook_'+kz.getKey('name')+'.xlsx',
-                mime='application/vnd.ms-excel',
-                disabled=kz.isCaseUnsolved()
-            )