Man pages for cre.dcf
Discounted Cash Flow Tools for Commercial Real Estate
| add_credit_ratios | Add credit ratios for debt service, interest cover, debt... |
| analyze_deal | Analyze a simplified CRE deal |
| as_rate | Rate conversion (decimal vs bps) |
| asset_snapshot | Summarize a simplified asset in one row |
| as_yaml | Serialize a validated configuration list to YAML |
| build_lease_table | Stylised rent table (lease cash-flow) |
| cf_compute_levered | Equity cash flows and metrics in the presence of debt |
| cfg_explain | Explain effective parameters after normalization |
| cfg_missing | Report missing or inconsistent fields in a config list |
| cfg_normalize | Normalize YAML into Discounted Cash Flow (DCF) and debt... |
| cfg_validate | Validate YAML configuration structure |
| cf_make_full_table | Assemble the full cash-flow table (discounted cash flow and... |
| compare_financing_scenarios | Compare three financing structures on a common Discounted... |
| compute_equity_invest | Compute equity invested at t0 (acquisition costs already... |
| compute_leveraged_metrics | Levered summary (equity cash flows and equity metrics) |
| compute_noi_y1 | Quick computation of year-1 NOI |
| compute_unleveraged_metrics | Unlevered summary (project metrics) |
| cre_glossary | Glossary of CRE finance and modelling terms |
| dcf_add_noi_columns | Explicitly standardise GEI and NOI columns in a Discounted... |
| dcf_calculate | Unlevered discounted cash flow model for a commercial real... |
| dcf_read_config | Read a configuration YAML |
| dcf_spec_template | Minimal specification template for a Discounted Cash Flow... |
| dcf_write_yaml_template | Write a commented YAML template for users to edit |
| deal_cashflows | Extract standard cash-flow tables from a deal result |
| deal_spec | Define a simplified CRE deal specification |
| deal_to_config | Convert a simplified deal into an engine configuration |
| debt_built_schedule | Debt schedule for bullet and amortising loans |
| debt_terms | Define simple debt terms for a CRE deal |
| depreciation_spec | Build a depreciation specification for a generic SPV tax... |
| derive_exit_yield | Derive an exit yield from an entry yield and a spread (bps) |
| discount_factor | Discount factor |
| equity_multiple_safe | Safely compute the equity multiple for an equity cash-flow... |
| flag_covenants | Covenant flags after computing credit ratios |
| forward_value_from_noi | Forward value from next-period NOI |
| get_cfg | Safe access to nested YAML values |
| guard_rate | Guardrail on an input rate (message if scale likely... |
| init_debt_fees | Initial debt fees (arrangement fee) |
| interest_rule | Build an interest-deductibility rule for the generic SPV tax... |
| irr_partition | IRR decomposition between operations and resale |
| irr_safe | Robust internal rate of return (adaptive bracketing) |
| lease_effective_rent | Lease effective rent from a stream of lease cash flows |
| lease_event | Define a lease event for the simplified lease-roll API |
| lease_roll | Group lease units into a simplified lease roll |
| lease_roll_snapshot | Summarize a lease roll in analyst-friendly tabular form |
| leases_tbl_structuration | Aggregate lease events into annual vectors aligned on... |
| lease_unit | Define one lease unit for the simplified lease-roll API |
| load_style_preset | Load a preset style YAML file |
| loss_rule | Build a loss-carryforward rule for the generic SPV tax engine |
| npv_rate | Net present value at constant rate |
| or-or | Or-or helper |
| price_from_cap | Acquisition price from an entry capitalization rate |
| project_terminal_noi | Project the NOI capitalized in the terminal value one year... |
| renewal_event | Define a renewal or reletting event |
| rnd | Monetary rounding to 2 decimals |
| run_case | Run a full DCF case from a list or a YAML file |
| run_from_config | Canonical pipeline from a YAML file |
| select_terminal_noi | Robust selection of terminal NOI for resale valuation |
| simulate_shock | Apply scenario shocks to a set of Discounted Cash Flow (DCF)... |
| style_bullet_ratios | Extract bullet credit-ratio path for a style preset |
| styles_breach_counts | Count covenant breaches by style under the bullet-debt... |
| styles_break_even_exit_yield | Break-even exit yield for a target leveraged equity IRR, by... |
| styles_distressed_exit | Distressed exit summary across CRE investment styles |
| styles_equity_cashflows | Extract leveraged equity cash flows by style |
| styles_exit_sensitivity | Exit-yield sensitivity of leveraged equity IRR by style |
| styles_growth_sensitivity | Rental-growth (indexation) sensitivity of leveraged equity... |
| styles_manifest | Compute the style-by-style manifest for preset scenarios |
| styles_pv_split | Present-value split between income and resale by style |
| styles_revalue_yield_plus_growth | Re-evaluate styles under a yield-plus-growth discounting rule |
| summarize_case | Summarise a financing scenario from ratios and metrics |
| sweep_sensitivities | Sensitivity grid (rate / exit yield) and monotonicity of... |
| tax_basis_spv | Extract a tax basis from a pre-tax case |
| tax_run_spv | Run a generic SPV-level tax engine |
| tax_spec_spv | Build a generic SPV tax specification |
| test_refi | Test the feasibility of a refinancing at year T |
| underwrite_loan | Constrained underwriting for a commercial mortgage |
| vacancy_event | Define an explicit vacancy event |
