owlplanner 2025.2.20__py3-none-any.whl → 2025.2.22__py3-none-any.whl

owlplanner/config.py

@@ -28,6 +28,7 @@ def saveConfig(plan, file, mylog):
 
     diconf = {}
     diconf["Plan Name"] = plan._name
+    diconf["Description"] = plan._description
 
     # Basic Info.
     diconf["Basic Info"] = {
@@ -180,11 +181,12 @@ def readConfig(file, *, verbose=True, logstreams=None, readContributions=True):
     # status = diconf['Basic Info']['Status']
     yobs = diconf["Basic Info"]["Birth year"]
     expectancy = diconf["Basic Info"]["Life expectancy"]
-    startDate = diconf["Basic Info"]["Start date"]
+    startDate = diconf["Basic Info"].get("Start date", "today")
     icount = len(yobs)
     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)
+    plan._description = diconf.get("Description", "")
 
     # Assets.
     balances = {}
@@ -295,6 +297,11 @@ def readConfig(file, *, verbose=True, logstreams=None, readContributions=True):
     # Solver Options.
     p.solverOptions = diconf["Solver Options"]
 
+    # Check consistency of noRothConversions.
+    name = p.solverOptions.get("noRothConversions", "None")
+    if name != "None" and name not in p.inames:
+        raise ValueError(f"Unknown name {name} for noRothConversions.")
+
     # Results.
     p.setDefaultPlots(diconf["Results"]["Default plots"])
 

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])
@@ -2895,7 +2904,7 @@ def _stackPlot(x, inames, title, irange, series, snames, location, yformat="\\$k
 
     if len(nonzeroSeries) == 0:
         # print('Nothing to plot for', title)
-        return None
+        return None, None
 
     fig, ax = plt.subplots(figsize=(6, 4))
     plt.grid(visible="both")

owlplanner/version.py

@@ -1 +1 @@
-__version__ = "2025.02.20"
+__version__ = "2025.02.22"

{owlplanner-2025.2.20.dist-info → owlplanner-2025.2.22.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: owlplanner
-Version: 2025.2.20
+Version: 2025.2.22
 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.20.dist-info → owlplanner-2025.2.22.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=Yzi_Xivd_EFfuHklIoQ-LNqKCxF2ruc8p-Il_HVgEaw,11817
+owlplanner/config.py,sha256=yoi9dTpA-BVCPnbcDwPWO8dkTDFeMft4KRvuqZepzxA,12164
 owlplanner/logging.py,sha256=tYMw04O-XYSzjTj36fmKJGLcE1VkK6k6oJNeqtKXzuc,2530
-owlplanner/plan.py,sha256=xsKdC-FliHlPip5jk3DpuEZ8kFJxtvp_N6w9rSLOdg8,113571
+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=ArasFO4_5XwyPkpEb1P7ZPwY-Ala6bofNVuqVXpJG10,28
+owlplanner/version.py,sha256=9rZICePFVRaLH3DbBPmhbkwGMbL4PJlxOgWYgOrbcGw,28
 owlplanner/data/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 owlplanner/data/rates.csv,sha256=6fxg56BVVORrj9wJlUGFdGXKvOX5r7CSca8uhUbbuIU,3734
-owlplanner-2025.2.20.dist-info/METADATA,sha256=kw7qYrpIl0wjAki-1Wm0VdDjem4aaYWJFQeIkJg-b7Y,53506
-owlplanner-2025.2.20.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-owlplanner-2025.2.20.dist-info/licenses/LICENSE,sha256=IwGE9guuL-ryRPEKi6wFPI_zOhg7zDZbTYuHbSt_SAk,35823
-owlplanner-2025.2.20.dist-info/RECORD,,
+owlplanner-2025.2.22.dist-info/METADATA,sha256=nl-Se08p2SfUG8NbbeHQslxuaRA-VWKBvkAlI2vpid0,53506
+owlplanner-2025.2.22.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+owlplanner-2025.2.22.dist-info/licenses/LICENSE,sha256=IwGE9guuL-ryRPEKi6wFPI_zOhg7zDZbTYuHbSt_SAk,35823
+owlplanner-2025.2.22.dist-info/RECORD,,