ENH: Add template_example2 in ifrs17a

lifelib-dev · Jul 8, 2023 · ce89db3 · ce89db3
1 parent 8f9cdfb
commit ce89db3
Show file tree

Hide file tree

Showing 8 changed files with 1,712 additions and 6 deletions.
diff --git a/lifelib/libraries/ifrs17a/pnl_mapping.xlsx b/lifelib/libraries/ifrs17a/pnl_mapping.xlsx
diff --git a/lifelib/libraries/ifrs17a/template_example2.ipynb b/lifelib/libraries/ifrs17a/template_example2.ipynb
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.9.0/index.html" target="_blank">lifelib v0.9.0</a></li>
     <li><a href="https://pastdocs.lifelib.io/docs-v0.8.1/index.html" target="_blank">lifelib v0.8.1</a></li>
     <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>

diff --git a/makedocs/source/libraries/ifrs17a/index.md b/makedocs/source/libraries/ifrs17a/index.md
@@ -74,13 +74,15 @@ To create *myifrs17* in the current directory, type:
 This library includes the following Jupyter Notebooks:
 
 * {doc}`template_example` 
+* {doc}`template_example2` 
 * {doc}`present_value_example_ep2`
 * {doc}`present_value_example_ep3`
 * {doc}`logic_inspection_example`
 
-Each of the first three notebooks runs a corresponding Python script,
-such `template.py`, `present_value_ep2.py` and  `present_value_ep3.py`,
-and reproduces tables presented in Systemorph's videos.
+The first two notebooks run `template.py`, 
+and the next two notebooks run `present_value_ep2.py` and  
+`present_value_ep3.py` respectively,
+and reproduce tables presented in Systemorph's videos.
 The last notebook demonstrates how to inspect the calculation logic. 
 
 To run any of the Jupyter notebooks, the current directory
@@ -101,7 +103,7 @@ and try inserting '' in the list.
 
 As mentioned above, this library includes the following Python scripts:
 
-* template_example.py 
+* template.py 
 * present_value_ep2.py
 * present_value_ep3.py
 
@@ -248,11 +250,10 @@ For more detailed explanations, refer to the original documentation linked above
 | present_value_ep2.py                                              | Python script for present value episode 2 example                       |
 | present_value_ep3.py                                              | Python script for present value episode 3 exmaple                       |
 | {doc}`template_example.ipynb<template_example>`                   | Jupyter notebook to reproduce tables of template example                |
+| {doc}`template_example2.ipynb<template_example2>`                 | Jupyter notebook to reproduce the Financial Performance report          |
 | {doc}`present_value_example_ep2.ipynb<present_value_example_ep2>` | Jupyter notebook to reproduce tables of present value example episode 2 |
 | {doc}`present_value_example_ep3.ipynb<present_value_example_ep3>` | Jupyter notebook to reproduce tables of present value example episode 3 |
 | {doc}`logic_inspection_example.ipynb<logic_inspection_example>`   | Jupyter notebook showing how to inspect the calculation logic           |
-| pnl_mapping.xlsx                                                  | Excel file showing how to map IfrsVariables to P&L items                |
-
 
 
 ## String Keys
@@ -419,6 +420,7 @@ generated by the scripts. Below are the classes and their string keys.
 hidden:
 --- 
 template_example
+template_example2
 present_value_example_ep2
 present_value_example_ep3
 logic_inspection_example

diff --git a/makedocs/source/libraries/ifrs17a/template_example2.nblink b/makedocs/source/libraries/ifrs17a/template_example2.nblink
@@ -0,0 +1,3 @@
+{
+    "path": "../../../../lifelib/libraries/ifrs17a/template_example2.ipynb"
+}
diff --git a/makedocs/source/notebooks.rst b/makedocs/source/notebooks.rst
@@ -33,6 +33,7 @@ Notebooks
 ---------------------------
 
 * :doc:`libraries/ifrs17a/template_example`
+* :doc:`libraries/ifrs17a/template_example2`
 * :doc:`libraries/ifrs17a/present_value_example_ep2`
 * :doc:`libraries/ifrs17a/present_value_example_ep3`
 * :doc:`libraries/ifrs17a/logic_inspection_example`

diff --git a/makedocs/source/releases/relnotes_v0.9.1.rst b/makedocs/source/releases/relnotes_v0.9.1.rst
@@ -0,0 +1,37 @@
+.. currentmodule:: lifelib.libraries
+
+.. _relnotes_v0.9.1:
+
+==================================
+lifelib v0.9.1 (8 July 2023)
+==================================
+
+This release adds a new notebook, :doc:`/libraries/ifrs17a/template_example2` in
+the :mod:`~ifrs17a` library, and fixes some bugs.
+
+To update lifelib, run the following command::
+
+    >>> pip install lifelib --upgrade
+
+If you're using Anaconda, use the ``conda`` command instead::
+
+    >>> conda update lifelib
+
+
+Updates in :mod:`~ifrs17a`
+===========================
+
+* A new notebook, :doc:`/libraries/ifrs17a/template_example2` is added.
+* A new column, *PnlType* is added to the *AocType* table in *Dimension.xlsx*
+* ``IfrsDatabase.Query`` now optionally takes a boolean parameter `as_df` to indicate
+  whether to return the query result as a DataFrame.
+* Fixed multiplier in *ImportScopeCalculation.py*.
+
+.. seealso::
+
+    * `Systemorph's video on IFRS17 Profit and loss statement  <https://www.youtube.com/watch?v=Ud2jX3J1eNU>`_
+
+
+
+
+
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>
 
+* *8 July 2023:*
+  lifelib v0.9.1 is released.
+  a new notebook, :doc:`/libraries/ifrs17a/template_example2` is added in :mod:`~ifrs17a`.
+  See :ref:`Release Notes<relnotes_v0.9.1>` for details.
+
 * *13 May 2023:*
   lifelib v0.9.0 is released. :mod:`~ifrs17a`, a new library for IFRS 17 is added.
   See :ref:`Release Notes<relnotes_v0.9.0>` for details.