Skip to content

Commit

Permalink
enhance debug/waterfall action doc
Browse files Browse the repository at this point in the history
  • Loading branch information
yellowbean committed May 7, 2024
1 parent 14a6b73 commit b847d98
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 1 deletion.
3 changes: 2 additions & 1 deletion docs/source/modeling.rst
Original file line number Diff line number Diff line change
Expand Up @@ -214,7 +214,8 @@ Bond
* ``("originalBondBalance","A","B")`` -> bond balance at issuance of "A" and "B"
* ``("bondFactor",)`` -> bond factor
* ``("bondDueInt","A","B")`` -> bond due interest for bond A and bond B
* ``("lastBondIntPaid","A")`` -> bond last paid interest
* ``("lastBondIntPaid","A")`` -> sum amount of last paid interest for bonds
* ``("lastBondPrinPaid","A")`` -> sum amount of last paid principal for bonds
* ``("behindTargetBalance","A")`` -> difference of target balance with current balance for the bond A
* ``("bondTxnAmt", None,"A")`` -> Total transaction amount of bond 'A'
* ``("bondTxnAmt", "<PayInt:A>","A")`` -> Total transaction amount of interest payment bond 'A'
Expand Down
28 changes: 28 additions & 0 deletions docs/source/nbsample/debug_sample.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,34 @@
"localAPI = API(EnginePath.DEV, lang='english',check=False)"
]
},
{
"cell_type": "markdown",
"id": "9560c303",
"metadata": {},
"source": [
"### Cashflow Debug Steps\n",
"\n",
"If user thinks something is off in the cashflow , here is couple steps to inspect \n",
"\n",
"1. Is Pool Cashflow Correct ?\n",
" \n",
" Please inspect \n",
" \n",
" `r['pool']['flow']`\n",
"\n",
"2. Is Waterfall Distribution Correct ?\n",
"\n",
" Pls inspect accounts\n",
"\n",
" `r['accounts']['<AccountName>']`\n",
"\n",
"3. Is fee paid correct ?\n",
"\n",
" Pls inspect \n",
"\n",
" `r['fees']['<FeeName>']`\n"
]
},
{
"cell_type": "markdown",
"id": "dad1adb2",
Expand Down

0 comments on commit b847d98

Please sign in to comment.