owlplanner 2025.2.21__py3-none-any.whl → 2025.2.23__py3-none-any.whl

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/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/version.py

@@ -1 +1 @@
-__version__ = "2025.02.21"
+__version__ = "2025.02.23"

{owlplanner-2025.2.21.dist-info → owlplanner-2025.2.23.dist-info}/METADATA

@@ -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.dist-info → owlplanner-2025.2.23.dist-info}/RECORD

@@ -1,17 +1,17 @@
 owlplanner/__init__.py,sha256=QqrdT0Qks20osBTg7h0vJHAxpP9lL7DA99xb0nYbtw4,254
 owlplanner/abcapi.py,sha256=LbzW_KcNy0IeHp42MUHwGu_H67B2h_e1_vu-c2ACTkQ,6646
-owlplanner/config.py,sha256=KiG2rTDyoDWBv6U-u2x38bIAENWYIySucA4z_AMeEW4,12062
+owlplanner/config.py,sha256=bvqoOWrdPrWYQF9-PS_n00MoyZkAsmMOSczhTUFRGVU,12257
 owlplanner/logging.py,sha256=tYMw04O-XYSzjTj36fmKJGLcE1VkK6k6oJNeqtKXzuc,2530
-owlplanner/plan.py,sha256=IY-qKf4PBSKnAeNIBrG0p2d_oX0pnlaLxLkMOd6Hpn0,113577
+owlplanner/plan.py,sha256=RTkIT5tJ_Ar0hCBx0G1ScjaGLuxdsRDqwWC1eosp5po,113860
 owlplanner/progress.py,sha256=8jlCvvtgDI89zXVNMBg1-lnEyhpPvKQS2X5oAIpoOVQ,384
 owlplanner/rates.py,sha256=TN407qU4n-bac1oymkQ_n2QKEPwFQxy6JZVGwgIkLQU,15585
 owlplanner/tax2025.py,sha256=B-A5eU3wxdcAaxRCbT3qI-JEKoD_ZeNbg_86XhNdQEI,7745
 owlplanner/timelists.py,sha256=tYieZU67FT6TCcQQis36JaXGI7dT6NqD7RvdEjgJL4M,4026
 owlplanner/utils.py,sha256=HM70W60qB41zfnbl2LltNwAuLYHyy5XYbwnbNcaa6FE,2351
-owlplanner/version.py,sha256=dJhhQS3Y64EQNnwRkaQ4DnoJMIhwSgoOkvnwtMFIiiw,28
+owlplanner/version.py,sha256=85qxkfG2OiCeMaWpV6ROXWN2-KYejMXo-QU_lI_mUOM,28
 owlplanner/data/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 owlplanner/data/rates.csv,sha256=6fxg56BVVORrj9wJlUGFdGXKvOX5r7CSca8uhUbbuIU,3734
-owlplanner-2025.2.21.dist-info/METADATA,sha256=a22nMKZWInL2tv29V4BPPbJJFe0LHW96N7JYKNWWDXI,53506
-owlplanner-2025.2.21.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-owlplanner-2025.2.21.dist-info/licenses/LICENSE,sha256=IwGE9guuL-ryRPEKi6wFPI_zOhg7zDZbTYuHbSt_SAk,35823
-owlplanner-2025.2.21.dist-info/RECORD,,
+owlplanner-2025.2.23.dist-info/METADATA,sha256=SfUn8ugA-N7NDg2XhNt0oBQOSbCi2GqARxGIqkYAMc8,53506
+owlplanner-2025.2.23.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+owlplanner-2025.2.23.dist-info/licenses/LICENSE,sha256=IwGE9guuL-ryRPEKi6wFPI_zOhg7zDZbTYuHbSt_SAk,35823
+owlplanner-2025.2.23.dist-info/RECORD,,