DOC: Update doc for the next release

lifelib-dev · Aug 19, 2023 · 562d7cc · 562d7cc
1 parent 8364048
commit 562d7cc
Show file tree

Hide file tree

Showing 16 changed files with 112 additions and 35 deletions.
diff --git a/makedocs/source/banners.rst b/makedocs/source/banners.rst
@@ -79,11 +79,11 @@
 
 .. End binder banner
 
-.. Begin modelx banner
+.. Begin modelx badge
 
-.. |modelx banner| raw:: html
+.. |modelx badge| raw:: html
 
    <a href="https://docs.modelx.io" target="_blank">
    <img alt="modelx" src="https://img.shields.io/badge/modelx-0080FF" /></a>
 
-.. End modelx banner
+.. End modelx badge
diff --git a/makedocs/source/libraries/assets/index.rst b/makedocs/source/libraries/assets/index.rst
@@ -4,7 +4,7 @@
 The **assets** Library
 ==========================
 
-|modelx banner|
+|modelx badge|
 
 Overview
 ---------

diff --git a/makedocs/source/libraries/basiclife/index.rst b/makedocs/source/libraries/basiclife/index.rst
@@ -4,7 +4,7 @@
 The **basiclife** Library
 ==========================
 
-|modelx banner|
+|modelx badge|
 
 Overview
 ---------

diff --git a/makedocs/source/libraries/economic/index.rst b/makedocs/source/libraries/economic/index.rst
@@ -4,7 +4,7 @@
 The **economic** Library
 ==========================
 
-|modelx banner|
+|modelx badge|
 
 Overview
 ---------

diff --git a/makedocs/source/libraries/index.rst b/makedocs/source/libraries/index.rst
@@ -3,16 +3,21 @@
 Libraries
 =========
 
+The following is a list of the lifelib libraries.
+|modelx badge| indicates that the models in the library are built with it.
+These models can be transformed to self-contained Python packages
+independent of modelx using modelx's export feature.
+
 .. table::
 
    =============================== =============== ===============================================================
    Library                                         Contents
    =============================== =============== ===============================================================
-   :doc:`basiclife/index`          |modelx banner| Basic life insurance cashflow models and examples
-   :doc:`savings/index`            |modelx banner| Cashflow models of saving products with cash values
-   :doc:`assets/index`             |modelx banner| Basic models of bond portfolios
+   :doc:`basiclife/index`          |modelx badge|  Basic life insurance cashflow models and examples
+   :doc:`savings/index`            |modelx badge|  Cashflow models of saving products with cash values
+   :doc:`assets/index`             |modelx badge|  Basic models of bond portfolios
    :doc:`ifrs17a/index`                            IFRS17 calculation model and examples
-   :doc:`economic/index`           |modelx banner| Basic Hull-White model
+   :doc:`economic/index`           |modelx badge|  Basic Hull-White model
    :doc:`economic_curves/index`                    Algorithms for modeling economic scenarios
    :doc:`cluster/index`                            Notebooks for model point selection by cluster analysis
    =============================== =============== ===============================================================
@@ -39,8 +44,7 @@ Past Libraries
 The libraries listed below were introduced before the release of lifelib v0.1.1
 and were originally referred to as "projects."
 All of these libraries, with the exception of *simithwilson*,
-were developed using an older cashflow model.
-Additionally, all the projects relies on modelx.
+were developed using an older cashflow model. All the projects use modelx.
 
 .. toctree::
    :maxdepth: 1

diff --git a/makedocs/source/libraries/savings/index.rst b/makedocs/source/libraries/savings/index.rst
@@ -4,7 +4,7 @@
 The **savings** Library
 ==========================
 
-|modelx banner|
+|modelx badge|
 
 Overview
 ---------

diff --git a/makedocs/source/projects/fastlife.rst b/makedocs/source/projects/fastlife.rst
@@ -6,10 +6,10 @@ Project **fastlife**
 ======================
 
 .. include:: /banners.rst
-   :start-after: Begin modelx banner
-   :end-before: End modelx banner
+   :start-after: Begin modelx badge
+   :end-before: End modelx badge
 
-|modelx banner|
+|modelx badge|
 
 This project includes the **fastlife** model. The firstlife model
 calculates the present values of the net insurance cashflows.

diff --git a/makedocs/source/projects/ifrs17sim.rst b/makedocs/source/projects/ifrs17sim.rst
@@ -6,10 +6,10 @@ Project **ifrs17sim**
 =====================
 
 .. include:: /banners.rst
-   :start-after: Begin modelx banner
-   :end-before: End modelx banner
+   :start-after: Begin modelx badge
+   :end-before: End modelx badge
 
-|modelx banner|
+|modelx badge|
 
 **ifrs17sim** is a project for simulating IFRS17
 financial statements on sample insurance contracts.

diff --git a/makedocs/source/projects/nestedlife.rst b/makedocs/source/projects/nestedlife.rst
@@ -6,10 +6,10 @@ Project **nestedlife**
 ======================
 
 .. include:: /banners.rst
-   :start-after: Begin modelx banner
-   :end-before: End modelx banner
+   :start-after: Begin modelx badge
+   :end-before: End modelx badge
 
-|modelx banner|
+|modelx badge|
 
 The **nestedlife** project has the same annual projection
 model of basic traditional life policies

diff --git a/makedocs/source/projects/simplelife.rst b/makedocs/source/projects/simplelife.rst
@@ -6,10 +6,10 @@ Project **simplelife**
 ======================
 
 .. include:: /banners.rst
-   :start-after: Begin modelx banner
-   :end-before: End modelx banner
+   :start-after: Begin modelx badge
+   :end-before: End modelx badge
 
-|modelx banner|
+|modelx badge|
 
 This project includes the **simplelife** model,
 which is an annual projection model of basic traditional life policies.

diff --git a/makedocs/source/projects/smithwilson.rst b/makedocs/source/projects/smithwilson.rst
@@ -6,10 +6,10 @@ Project **smithwilson**
 =======================
 
 .. include:: /banners.rst
-   :start-after: Begin modelx banner
-   :end-before: End modelx banner
+   :start-after: Begin modelx badge
+   :end-before: End modelx badge
 
-|modelx banner|
+|modelx badge|
 
 The **smithwilson** project includes the **smithwilson** model,
 which extrapolates observed risk-free interest rates using the Smith-Wilson method.

diff --git a/makedocs/source/projects/solvency2.rst b/makedocs/source/projects/solvency2.rst
@@ -6,10 +6,10 @@ Project **solvency2**
 =====================
 
 .. include:: /banners.rst
-   :start-after: Begin modelx banner
-   :end-before: End modelx banner
+   :start-after: Begin modelx badge
+   :end-before: End modelx badge
 
-|modelx banner|
+|modelx badge|
 
 **solvency2** is a project for building a model to
 calculate life risks of selected policies at various points in their policy periods

diff --git a/makedocs/source/releases/relnotes_v0.9.2.rst b/makedocs/source/releases/relnotes_v0.9.2.rst
@@ -0,0 +1,64 @@
+.. currentmodule:: lifelib.libraries
+
+.. _relnotes_v0.9.2:
+
+==================================
+lifelib v0.9.2 (19 August 2023)
+==================================
+
+In this release, modelx models in the following libraries have been updated
+so that they can now be exported as standalone Python packages
+by the new export feature introduced in modelx version 0.22.0.
+
+- basiclife
+- savings
+- assets
+- economic
+- smithwilson (project)
+
+All the modelx models from the libraries listed above, including their example models,
+can now be transformed to Python packages.
+These transformed models are independent of modelx,
+and they run significantly faster and consume less memory than their original counterparts.
+For further insights into the export feature, refer to the following articles.
+
+.. seealso::
+
+    * `New Feature: Export Models as Self-contained Python Packages <https://modelx.io/blog/2023/07/29/export-feature-intro>`_
+    * `Enhanced Speed for Exported lifelib Models <https://modelx.io/blog/2023/08/19/enhanced-speed-for-exported-lifelib-models>`_
+
+
+To update lifelib, run the following command::
+
+    >>> pip install lifelib --upgrade
+
+If you're using Anaconda, use the ``conda`` command instead::
+
+    >>> conda update lifelib
+
+
+Fixes and Updates
+===================
+
+* Auto-coercion (implicit conversion) of parameterless Cells objects to their
+  values is deprecated in modelx 0.23.0.
+  All modelx models across all the lifelib libraries are updated to eliminate the
+  implicit conversion (See `commit 5b7357f <https://github.com/lifelib-dev/lifelib/commit/5b7357f82aa0bcc075c9c59f8780180c6b1d2de4>`_).
+
+* CashValue_ME_EX4 and its example notebook are updated to make
+  some formulas more effective and concise,
+  in response to a contributor's suggestion (`GH57 <https://github.com/lifelib-dev/lifelib/pull/57>`_).
+
+* Models are updated to eliminate deprecated usage of Pandas.
+
+* Fix an error in ifrs17a.
+
+Changes
+===================
+
+* Starting with this release, lifelib no longer supports Python 3.6,
+  given that this version reached its end of life over a year ago.
+  While lifelib may still function with Python 3.6,
+  lifelib won't be tested against this version anymore.
+
+
diff --git a/makedocs/source/updates.rst b/makedocs/source/updates.rst
@@ -14,6 +14,10 @@ Updates
     Follow <a href="https://www.linkedin.com/company/lifelib" target="_blank">lifelib on LinkedIn</a>
     for more frequent updates.</p>
 
+* *19 August 2023:*
+  lifelib v0.9.2 is released. Now recent modelx models in lifelib are available as self-contained Python packages.
+  See :ref:`Release Notes<relnotes_v0.9.2>` for details.
+
 * *8 July 2023:*
   lifelib v0.9.1 is released.
   a new notebook, :doc:`/libraries/ifrs17a/template_example2` is added in :mod:`~ifrs17a`.
@@ -27,6 +31,7 @@ Updates
   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.
 
+.. Latest Updates End
 
 * *19 Nov 2022:*
   lifelib v0.8.0 is released. New library :mod:`~economic_curves` is available.
@@ -41,8 +46,6 @@ Updates
 * *28 Aug 2022:*
   lifelib v0.6.0 is released. See :ref:`Release Notes<relnotes_v0.6.0>` for details.
 
-.. Latest Updates End
-
 * *20 Aug 2022:*
   New video series, *Getting Started with lifelib* available on the :doc:`videos` page.
 

diff --git a/makedocs/source/whatsnew.rst b/makedocs/source/whatsnew.rst
@@ -31,8 +31,9 @@ Documentation for released versions of lifelib is available under
 :doc:`archive` page.
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
 
+   releases/relnotes_v0.9.2
    releases/relnotes_v0.9.1
    releases/relnotes_v0.9.0
    releases/relnotes_v0.8.1
@@ -47,4 +48,8 @@ Documentation for released versions of lifelib is available under
    releases/relnotes_v0.3.0
    releases/relnotes_v0.2.0
    releases/relnotes_v0.1.1
+
+.. toctree::
+   :maxdepth: 2
+
    releases/older_releases
diff --git a/setup.py b/setup.py
@@ -156,10 +156,11 @@ def get_package_data(top_dirs: list):
         # Specify the Python versions you support here. In particular, ensure
         # that you indicate whether you support Python 2, Python 3 or both.
         'Programming Language :: Python :: 3',
-        'Programming Language :: Python :: 3.6',
         'Programming Language :: Python :: 3.7',
         'Programming Language :: Python :: 3.8',
         'Programming Language :: Python :: 3.9',
+        'Programming Language :: Python :: 3.10',
+        'Programming Language :: Python :: 3.11'
     ],
 
     # What does your project relate to?