owlplanner 2025.2.21__tar.gz → 2025.2.23__tar.gz

{owlplanner-2025.2.21 → owlplanner-2025.2.23}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: owlplanner
-Version: 2025.2.21
+Version: 2025.2.23
 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.21 → owlplanner-2025.2.23}/examples/case_jack+jill.toml

@@ -1,4 +1,5 @@
 "Plan Name" = "jack+jill"
+Description = "This example case is for Jack and Jill, a married couple."
 
 ["Basic Info"]
 Status = "married"

{owlplanner-2025.2.21 → owlplanner-2025.2.23}/examples/case_joe.toml

@@ -1,4 +1,5 @@
 "Plan Name" = "joe"
+Description = "This example case is for Joe, a single individual."
 
 ["Basic Info"]
 Status = "single"

{owlplanner-2025.2.21 → owlplanner-2025.2.23}/examples/case_john+sally.toml

@@ -1,4 +1,5 @@
 "Plan Name" = "john+sally"
+Description = "This example reproduces the case of John and Sally, discussed by Eric Sajdak."
 
 ["Basic Info"]
 Status = "married"

{owlplanner-2025.2.21 → owlplanner-2025.2.23}/examples/case_jon+jane.toml

@@ -1,4 +1,5 @@
 "Plan Name" = "Jon+Jane"
+Description = "The case of Jon and Jane was the base case discussed by i-orp."
 
 ["Basic Info"]
 Status = "married"

{owlplanner-2025.2.21 → owlplanner-2025.2.23}/examples/case_kim+sam-bequest.toml

@@ -1,4 +1,5 @@
 "Plan Name" = "kim+sam-bequest"
+Description = "Kim and Sam is an example case for optimizing bequest and Roth conversions."
 
 ["Basic Info"]
 Status = "married"

{owlplanner-2025.2.21 → owlplanner-2025.2.23}/examples/case_kim+sam-spending.toml

@@ -1,4 +1,5 @@
 "Plan Name" = "kim+sam-spending"
+Description = "Kim and Sam is an example case for optimizing spending and Roth conversions."
 
 ["Basic Info"]
 Status = "married"

{owlplanner-2025.2.21 → owlplanner-2025.2.23}/pyproject.toml

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

{owlplanner-2025.2.21 → owlplanner-2025.2.23}/src/owlplanner/config.py

@@ -19,7 +19,7 @@ from owlplanner import logging
 from owlplanner.rates import FROM, TO
 
 
-def saveConfig(plan, file, mylog):
+def saveConfig(myplan, file, mylog):
     """
     Save case parameters and return a dictionary containing all parameters.
     """
@@ -27,86 +27,87 @@ def saveConfig(plan, file, mylog):
     accountTypes = ["taxable", "tax-deferred", "tax-free"]
 
     diconf = {}
-    diconf["Plan Name"] = plan._name
+    diconf["Plan Name"] = myplan._name
+    diconf["Description"] = myplan._description
 
     # Basic Info.
     diconf["Basic Info"] = {
-        "Status": ["unknown", "single", "married"][plan.N_i],
-        "Names": plan.inames,
-        "Birth year": plan.yobs.tolist(),
-        "Life expectancy": plan.expectancy.tolist(),
-        "Start date": plan.startDate,
+        "Status": ["unknown", "single", "married"][myplan.N_i],
+        "Names": myplan.inames,
+        "Birth year": myplan.yobs.tolist(),
+        "Life expectancy": myplan.expectancy.tolist(),
+        "Start date": myplan.startDate,
     }
 
     # Assets.
     diconf["Assets"] = {}
-    for j in range(plan.N_j):
-        amounts = plan.beta_ij[:, j] / 1000
+    for j in range(myplan.N_j):
+        amounts = myplan.beta_ij[:, j] / 1000
         diconf["Assets"][f"{accountTypes[j]} savings balances"] = amounts.tolist()
-    if plan.N_i == 2:
-        diconf["Assets"]["Beneficiary fractions"] = plan.phi_j.tolist()
-        diconf["Assets"]["Spousal surplus deposit fraction"] = plan.eta
+    if myplan.N_i == 2:
+        diconf["Assets"]["Beneficiary fractions"] = myplan.phi_j.tolist()
+        diconf["Assets"]["Spousal surplus deposit fraction"] = myplan.eta
 
     # Wages and Contributions.
-    diconf["Wages and Contributions"] = {"Contributions file name": plan.timeListsFileName}
+    diconf["Wages and Contributions"] = {"Contributions file name": myplan.timeListsFileName}
 
     # Fixed Income.
     diconf["Fixed Income"] = {
-        "Pension amounts": (plan.pensionAmounts / 1000).tolist(),
-        "Pension ages": plan.pensionAges.tolist(),
-        "Pension indexed": plan.pensionIndexed,
-        "Social security amounts": (plan.ssecAmounts / 1000).tolist(),
-        "Social security ages": plan.ssecAges.tolist(),
+        "Pension amounts": (myplan.pensionAmounts / 1000).tolist(),
+        "Pension ages": myplan.pensionAges.tolist(),
+        "Pension indexed": myplan.pensionIndexed,
+        "Social security amounts": (myplan.ssecAmounts / 1000).tolist(),
+        "Social security ages": myplan.ssecAges.tolist(),
     }
 
     # Rates Selection.
     diconf["Rates Selection"] = {
-        "Heirs rate on tax-deferred estate": float(100 * plan.nu),
-        "Long-term capital gain tax rate": float(100 * plan.psi),
-        "Dividend tax rate": float(100 * plan.mu),
-        "TCJA expiration year": plan.yTCJA,
-        "Method": plan.rateMethod,
+        "Heirs rate on tax-deferred estate": float(100 * myplan.nu),
+        "Long-term capital gain tax rate": float(100 * myplan.psi),
+        "Dividend tax rate": float(100 * myplan.mu),
+        "TCJA expiration year": myplan.yTCJA,
+        "Method": myplan.rateMethod,
     }
-    if plan.rateMethod in ["user", "stochastic"]:
-        diconf["Rates Selection"]["Values"] = (100 * plan.rateValues).tolist()
-    if plan.rateMethod in ["stochastic"]:
-        diconf["Rates Selection"]["Standard deviations"] = (100 * plan.rateStdev).tolist()
-        diconf["Rates Selection"]["Correlations"] = plan.rateCorr.tolist()
-    if plan.rateMethod in ["historical average", "historical", "histochastic"]:
-        diconf["Rates Selection"]["From"] = int(plan.rateFrm)
-        diconf["Rates Selection"]["To"] = int(plan.rateTo)
+    if myplan.rateMethod in ["user", "stochastic"]:
+        diconf["Rates Selection"]["Values"] = (100 * myplan.rateValues).tolist()
+    if myplan.rateMethod in ["stochastic"]:
+        diconf["Rates Selection"]["Standard deviations"] = (100 * myplan.rateStdev).tolist()
+        diconf["Rates Selection"]["Correlations"] = myplan.rateCorr.tolist()
+    if myplan.rateMethod in ["historical average", "historical", "histochastic"]:
+        diconf["Rates Selection"]["From"] = int(myplan.rateFrm)
+        diconf["Rates Selection"]["To"] = int(myplan.rateTo)
     else:
         diconf["Rates Selection"]["From"] = int(FROM)
         diconf["Rates Selection"]["To"] = int(TO)
 
     # Asset Allocation.
     diconf["Asset Allocation"] = {
-        "Interpolation method": plan.interpMethod,
-        "Interpolation center": float(plan.interpCenter),
-        "Interpolation width": float(plan.interpWidth),
-        "Type": plan.ARCoord,
+        "Interpolation method": myplan.interpMethod,
+        "Interpolation center": float(myplan.interpCenter),
+        "Interpolation width": float(myplan.interpWidth),
+        "Type": myplan.ARCoord,
     }
-    if plan.ARCoord == "account":
+    if myplan.ARCoord == "account":
         for accType in accountTypes:
-            diconf["Asset Allocation"][accType] = plan.boundsAR[accType]
+            diconf["Asset Allocation"][accType] = myplan.boundsAR[accType]
     else:
-        diconf["Asset Allocation"]["generic"] = plan.boundsAR["generic"]
+        diconf["Asset Allocation"]["generic"] = myplan.boundsAR["generic"]
 
     # Optimization Parameters.
     diconf["Optimization Parameters"] = {
-        "Spending profile": plan.spendingProfile,
-        "Surviving spouse spending percent": int(100 * plan.chi),
+        "Spending profile": myplan.spendingProfile,
+        "Surviving spouse spending percent": int(100 * myplan.chi),
     }
-    if plan.spendingProfile == "smile":
-        diconf["Optimization Parameters"]["Smile dip"] = int(plan.smileDip)
-        diconf["Optimization Parameters"]["Smile increase"] = int(plan.smileIncrease)
-        diconf["Optimization Parameters"]["Smile delay"] = int(plan.smileDelay)
+    if myplan.spendingProfile == "smile":
+        diconf["Optimization Parameters"]["Smile dip"] = int(myplan.smileDip)
+        diconf["Optimization Parameters"]["Smile increase"] = int(myplan.smileIncrease)
+        diconf["Optimization Parameters"]["Smile delay"] = int(myplan.smileDelay)
 
-    diconf["Optimization Parameters"]["Objective"] = plan.objective
-    diconf["Solver Options"] = plan.solverOptions
+    diconf["Optimization Parameters"]["Objective"] = myplan.objective
+    diconf["Solver Options"] = myplan.solverOptions
 
     # Results.
-    diconf["Results"] = {"Default plots": plan.defaultPlots}
+    diconf["Results"] = {"Default plots": myplan.defaultPlots}
 
     if isinstance(file, str):
         filename = file
@@ -185,6 +186,7 @@ def readConfig(file, *, verbose=True, logstreams=None, readContributions=True):
     s = ["", "s"][icount - 1]
     mylog.vprint(f"Plan for {icount} individual{s}: {inames}.")
     p = plan.Plan(inames, yobs, expectancy, name, startDate=startDate, verbose=True, logstreams=logstreams)
+    p._description = diconf.get("Description", "")
 
     # Assets.
     balances = {}

{owlplanner-2025.2.21 → owlplanner-2025.2.23}/src/owlplanner/plan.py

@@ -239,6 +239,7 @@ class Plan(object):
         self.interpCenter = 15
         self.interpWidth = 5
 
+        self._description = ''
         self.defaultPlots = "nominal"
         self.defaultSolver = "HiGHS"
 
@@ -406,6 +407,12 @@ class Plan(object):
         self.mylog.vprint(f"Renaming plan {self._name} -> {newname}.")
         self._name = newname
 
+    def setDescription(self, description):
+        """
+        Set a text description of the plan.
+        """
+        self._description = description
+
     def setSpousalDepositFraction(self, eta):
         """
         Set spousal deposit and withdrawal fraction. Default 0.5.
@@ -2069,6 +2076,8 @@ class Plan(object):
         now = self.year_n[0]
         dic = {}
         # Results
+        dic["Plan name"] = self._name
+        dic["Brief description"] = self._description
         dic[f"Net yearly spending basis in {now}$"] = u.d(self.g_n[0] / self.xi_n[0])
         dic[f"Net yearly spending for year {now}"] = u.d(self.g_n[0] / self.yearFracLeft)
         dic[f"Net spending remaining in year {now}"] = u.d(self.g_n[0])

owlplanner-2025.2.23/src/owlplanner/version.py

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

{owlplanner-2025.2.21 → owlplanner-2025.2.23}/ui/Create_Case.py

@@ -17,7 +17,7 @@ if ret == kz.newCase:
         key="_newcase",
         on_change=kz.createNewCase,
         args=["newcase"],
-        placeholder="Enter a name...",
+        placeholder="Enter a case name...",
     )
 elif ret == kz.loadCaseFile:
     # "<a href="Documentation" target="_self">Documentation</a>", unsafe_allow_html=True)
@@ -40,7 +40,6 @@ else:
             on_change=kz.renameCase,
             args=["caseNewName"],
             key="_caseNewName",
-            placeholder="Enter a name",
             help=helpmsg,
         )
 
@@ -61,6 +60,11 @@ else:
             horizontal=True,
         )
 
+    kz.initKey("description", "")
+    helpmsg = "Provide a short distinguishing description for the case."
+    description = kz.getLongText("Brief description", "description", help=helpmsg,
+                                 placeholder="Enter a brief description...")
+
     col1, col2 = st.columns(2, gap="large", vertical_alignment="top")
     with col1:
         kz.initKey("iname0", "")

{owlplanner-2025.2.21 → owlplanner-2025.2.23}/ui/owlbridge.py

@@ -20,6 +20,7 @@ def hasMOSEK():
 def createPlan():
     name = kz.currentCaseName()
     inames = [kz.getKey("iname0")]
+    description = kz.getKey("description")
     yobs = [kz.getKey("yob0")]
     life = [kz.getKey("life0")]
     startDate = kz.getKey("startDate")
@@ -37,6 +38,7 @@ def createPlan():
         st.error(f"Failed creation of plan '{name}': {e}")
         return
 
+    plan.setDescription(description)
     val = kz.getKey("plots")
     if val is not None:
         plan.setDefaultPlots(val)
@@ -98,6 +100,7 @@ def prepareRun(plan):
             st.error(f"Failed setting beneficiary fractions: {e}")
             return
 
+    plan.setDescription(kz.getKey("description"))
     plan.setHeirsTaxRate(kz.getKey("heirsTx"))
     plan.setLongTermCapitalTaxRate(kz.getKey("gainTx"))
     plan.setDividendRate(kz.getKey("divRate"))
@@ -422,8 +425,11 @@ def plotSingleResults(plan):
         st.write("##### Assets Distribution")
         morecols = st.columns(3, gap="small")
         for fig in figs:
-            if fig is not None:
+            if fig:
                 morecols[c].pyplot(fig)
+            else:
+                morecols[c].write("#\n<div style='text-align: center'> This plot is empty </div>",
+                                  unsafe_allow_html=True)
             c = (c + 1) % 3
 
 
@@ -558,6 +564,7 @@ def genDic(plan):
     dic = {}
     dic["plan"] = plan
     dic["name"] = plan._name
+    dic["description"] = plan._description
     dic["summary"] = ""
     dic["casetoml"] = ""
     dic["caseStatus"] = "new"

{owlplanner-2025.2.21 → owlplanner-2025.2.23}/ui/requirements.txt

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

{owlplanner-2025.2.21 → owlplanner-2025.2.23}/ui/sskeys.py

@@ -438,7 +438,7 @@ def getNum(
     )
 
 
-def getText(text, nkey, disabled=False, callback=setpull, placeholder=None):
+def getText(text, nkey, disabled=False, callback=setpull, placeholder=None, help=None):
     return st.text_input(
         text,
         value=getKey(nkey),
@@ -447,6 +447,20 @@ def getText(text, nkey, disabled=False, callback=setpull, placeholder=None):
         args=[nkey],
         key="_" + nkey,
         placeholder=placeholder,
+        help=help,
+    )
+
+
+def getLongText(text, nkey, disabled=False, callback=setpull, placeholder=None, help=None):
+    return st.text_area(
+        text,
+        value=getKey(nkey),
+        disabled=disabled,
+        on_change=callback,
+        args=[nkey],
+        key="_" + nkey,
+        placeholder=placeholder,
+        help=help,
     )
 
 

owlplanner-2025.2.21/src/owlplanner/version.py

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