Goal | The 5 functions to know | The 10 variables that matter most | Quick Start | Typical Workflow | 1. Define the deal | 2. Run the deal | 3. Read the key metrics | 4. Extract the tables | Three Common Input Styles | Entry yield known | NOI already known | Rent roll style input | Common Mistakes | When to move to the advanced API

Purpose | Why the core still stops at the before-tax level | What the core already gives us | What the current tax_rate does and does not do | Why this helps with multi-jurisdiction portability | The current SPV-level tax helper | A working generic SPV tax run | How to read the French fiscal-impact vignette | Summary

Purpose of this vignette | Setting the scene: the analyst’s brief | Loading and tailoring preset_default.yml | Loading the preset configuration | Run the DCF engine | Pricing and capital structure at t = 0 | Purchase price and acquisition costs | Initial LTV and capital structure | All-equity view: project fundamentals | Cash-flow table | Project IRR and NPV | Leveraged view: comparing debt structures | Summary table: all-equity vs bullet vs amortising | Debt schedules | Credit ratios: DSCR and forward LTV paths | Equity cash-flows and equity multiple | Leveraged equity cash-flows | Equity IRR, NPV and multiple | Exploring alternative financing structures | Normalising the configuration and rebuilding the unlevered DCF | Scenario grid and extraction helper | Running the financing variants | Formatting the comparison table | Drafting a short investment memo | Extracting key numbers | Example narrative

Purpose | Build a case and extract comparison details | Qualitative invariants: bullet vs amort | Interest cover (ICR): confirming the expected ordering | Internal consistency checks on credit ratios | Equity NPV read-across

Purpose | Start from a French operating case | Translate the French-like SPV into tax inputs | Read the yearly tax table | Compare pre-tax and after-tax equity cash flows | What this vignette captures and what it does not | Summary

Purpose | 1. Build a lease roll | 2. Turn the lease roll into a deal | 3. Run the analysis | 4. Read the operating table

Purpose | 1. Build a case | 2. Exit occurs once at the final year (all-equity) | 3. IRR identity (all-equity): IRR is the root of NPV = 0 | 5. Discount factor monotonicity | 6. Sanity checks | 7. Display a compact summary

Aim of this vignette | A style-by-style manifest | Risk–return cloud: project vs equity IRR | Leverage–coverage map (initial LTV vs min-DSCR) | Covenant flags and breach counts | Robustness to the discounting rule | Time profile of equity cash flows | Value composition: operations vs exit | Exit-yield and rental-growth sensitivities | Exit-yield shock | Rental-growth shock | Break-even exit yield for a target equity IRR | Distressed exit comparison under covenant breach | Export for audit and replication

Purpose | Building the case and extracting the cash-flow table | Analytical structure of the income chain | Logical consistency checks | Sign and distribution of NOI | Illustration of the income chain | Interpretation

Purpose | Why the package works at the property-before-tax level | Why terminal value is surfaced explicitly | Why effective rent is treated as an annuitized value | Why underwriting is implemented as binding constraints | Market value, investment value, and what is not yet in the package | Summary

Purpose | Load and validate a baseline configuration | Two runs under identical conditions | Numerical drift checks | Interpretation

Purpose | Baseline configuration and grid design | Running the model on the grid | Optional visualisation: iso-NPV map | Simple checks on the grid | Interpretation

Create a simple asset-level deal | Run the analysis | Inspect the asset snapshot and operating table | Extract the tables you need | Alternative income inputs

Purpose | 1. Load and validate a correct YAML configuration | Deliberate type violation and controlled failure | Interpretation

Aim | Full glossary | Debt metrics | Using the glossary programmatically