update How to

yellowbean · Mar 29, 2024 · 6f95035 · 6f95035
1 parent 9b0d85f
commit 6f95035
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 18 deletions.
diff --git a/docs/source/analytics.rst b/docs/source/analytics.rst
@@ -55,10 +55,13 @@ There are two type of assumptions:
         "Mortgage/Installment/Loan" -> "Prepayment" 
         "Mortgage/Installment/Loan" -> "Default"
         "Mortgage/Installment/Loan" -> "Recovery"
+        "Receivable" -> "Recovery" [label="Not implemented", "color"="red"]
+        "Receivable" -> "Default"
         "Current" -> "Lease"
         "Lease" -> "Rental Increase"
         "Lease" -> "Rental Renew"
         "Current" -> "FixedAsset"
+        "Current" -> "Receivable"
         "FixedAsset" -> "Production Rate"
         "FixedAsset" -> "Utilization Rate"
         "Asset Performance" -> "Delinquent" [label="Not implemented","color"="red"]
@@ -1162,22 +1165,6 @@ To access same component from different sceanrio :
 
   
 
-IRR 
-------------------
-
-powered by `pyxirr`, user have option to calculate the IRR of a bond.
-
-* 1st parameter should pass the dataframe of bond flow 
-* 2nd `init` represent `initial investment` a tuple with first as date of invesment and second as monetary amount of investment
-
-
-.. versionchanged:: 0.23.4
-
-.. code-block:: python
-
-   from absbox.local.analytics import irr
-   irr(r['bonds']['A1'],init=('2021-06-15',-70))
-
 
 Plotting
 -------------------------

diff --git a/docs/source/howto.rst b/docs/source/howto.rst
@@ -1,7 +1,7 @@
 How To
 ========
 
-a list of articles to show the power of ``absbox`` in Python world
+A list of articles reveals the power of ``absbox`` in Python world
 
 How to load loan level data(Freddie Mac)
 -------------------------------------------
@@ -1061,4 +1061,20 @@ Why using a deal library ?
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 * seperating deal storages and deal calculation engine, which is good for security and performance.
-* seperating running assumption and deal calculation, which is good for reusability and maintainability.
+* seperating running assumption and deal calculation, which is good for reusability and maintainability.
+
+
+How to pass deal files around ?
+------------------------------------
+
+A deal object 
+^^^^^^^^^^^^^^^^^
+
+A deal object either initialized with `SPV` or `Generic` class, is actually a python `dataclass` which implements a ``.json()`` .
+
+The ``json()`` function will convert the class to a json representation string .
+
+A string 
+^^^^^^^^^^^^^^^
+
+Now with that string, user can just write it into a No-SQL document database . or sent via Email , or Fax it .