DOC: Update docs for release v0.8.1

lifelib-dev · May 3, 2023 · 224e302 · 224e302
1 parent 71ae60c
commit 224e302
Show file tree

Hide file tree

Showing 7 changed files with 44 additions and 2 deletions.
diff --git a/lifelib/libraries/savings/savings_example4.ipynb b/lifelib/libraries/savings/savings_example4.ipynb
@@ -653,7 +653,7 @@
    "id": "3a435fef",
    "metadata": {},
    "source": [
-    "The output tells that `surr_charge_rate(t)` is consuming time the most, which is more than 30% of the total run time. Its fomula looks like below.\n",
+    "The output tells that `surr_charge_rate(t)` is consuming time the most, which is more than 40% of the total run time. Its fomula looks like below.\n",
     "\n",
     "`surr_charge_rate(t)` represents the surrener charge rates to be applied at time `t`. The surrender charge rates are defined by rate ID (such as `type_1`) and duration, and stored in `surr_charge_table` as a DataFrame. "
    ]

diff --git a/makedocs/source/archive.rst b/makedocs/source/archive.rst
@@ -11,6 +11,7 @@ Past Documents
 .. raw:: html
 
     <ul class="simple">
+    <li><a href="https://pastdocs.lifelib.io/docs-v0.8.0/index.html" target="_blank">lifelib v0.8.0</a></li>
     <li><a href="https://pastdocs.lifelib.io/docs-v0.7.0/index.html" target="_blank">lifelib v0.7.0</a></li>
     <li><a href="https://pastdocs.lifelib.io/docs-v0.6.0/index.html" target="_blank">lifelib v0.6.0</a></li>
     <li><a href="https://pastdocs.lifelib.io/docs-v0.5.0/index.html" target="_blank">lifelib v0.5.0</a></li>

diff --git a/makedocs/source/libraries/savings/index.rst b/makedocs/source/libraries/savings/index.rst
@@ -102,7 +102,7 @@ Examples
    savings_example1
    savings_example2
    savings_example3
-
+   savings_example4
 
 
 Library Contents
@@ -119,9 +119,11 @@ Library Contents
    cash_value_sample.xlsx                    An Excel file that reproduces the results of a selected model point. The file also shows the derivation of the sample mortality rates.
    CashValue_ME_EX1                          The example model for *savings_example1.ipynb*
    CashValue_ME_EX2                          The example model for *savings_example2.ipynb*
+   CashValue_ME_EX4                          The example model for *savings_example4.ipynb*
    savings_example1.ipynb                    Jupyter notebook :doc:`savings_example1`
    savings_example2.ipynb                    Jupyter notebook :doc:`savings_example2`
    savings_example3.ipynb                    Jupyter notebook :doc:`savings_example3`
+   savings_example4.ipynb                    Jupyter notebook :doc:`savings_example4`
    generate_100K_model_points.ipynb          Jupyter notebook used for generating the large model point data for :doc:`/libraries/savings/savings_example3`.
    plot_ex1_av_paths.py                      Python script for :doc:`/generated_examples/savings/plot_ex1_av_paths`
    plot_ex1_rand.py                          Python script for :doc:`/generated_examples/savings/plot_ex1_rand`

diff --git a/makedocs/source/libraries/savings/savings_example4.nblink b/makedocs/source/libraries/savings/savings_example4.nblink
@@ -0,0 +1,3 @@
+{
+    "path": "../../../../lifelib/libraries/savings/savings_example4.ipynb"
+}
diff --git a/makedocs/source/releases/relnotes_v0.8.1.rst b/makedocs/source/releases/relnotes_v0.8.1.rst
@@ -0,0 +1,30 @@
+.. currentmodule:: lifelib.libraries
+
+.. _relnotes_v0.8.1:
+
+==================================
+lifelib v0.8.1 (3 May 2023)
+==================================
+
+This release adds a new example in :mod:`~savings`.
+
+To update lifelib, run the following command::
+
+    >>> pip install lifelib --upgrade
+
+If you're using Anaconda, use the ``conda`` command instead::
+
+    >>> conda update lifelib
+
+
+New Example
+===============
+
+This release adds a new example,  :doc:`/libraries/savings/savings_example4` in :mod:`~savings`.
+The example shows how to profile and optimize a model using ``CashValue_ME_EX1`` as an example.
+The optimization approach involves replacing pandas DataFrames and Series with numpy arrays.
+The optimized model used in the example is included in :mod:`~savings` as ``CashValue_ME_EX4``.
+The example is based on recommendation given by `alexeybaran <https://github.com/fumitoh/modelx/discussions/79>`_
+
+
+
diff --git a/makedocs/source/updates.rst b/makedocs/source/updates.rst
@@ -14,6 +14,11 @@ Updates
     Follow <a href="https://www.linkedin.com/company/lifelib" target="_blank">lifelib on LinkedIn</a>
     for more frequent updates.</p>
 
+* *3 May 2023:*
+  lifelib v0.8.1 is released. A new example, :doc:`/libraries/savings/savings_example4` is available in :mod:`~savings`.
+  See :ref:`Release Notes<relnotes_v0.8.1>` for details.
+
+
 * *19 Nov 2022:*
   lifelib v0.8.0 is released. New library :mod:`~economic_curves` is available.
   See :ref:`Release Notes<relnotes_v0.8.0>` for details.

diff --git a/makedocs/source/whatsnew.rst b/makedocs/source/whatsnew.rst
@@ -33,6 +33,7 @@ Documentation for released versions of lifelib is available under
 .. toctree::
    :maxdepth: 2
 
+   releases/relnotes_v0.8.1
    releases/relnotes_v0.8.0
    releases/relnotes_v0.7.0
    releases/relnotes_v0.6.0