# jaypatel1511/lihtc-calc architecture

> Architecture diagram of the GitHub repository jaypatel1511/lihtc-calc, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-05). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/jaypatel1511/lihtc-calc
- Repository: https://github.com/jaypatel1511/lihtc-calc

## Overview

lihtc-calc is a pure-Python LIHTC transaction calculator. The principal workflow accepts a deal through the public package API, computes eligible/boosted/qualified basis and credits, and returns a structured credit result; investor cash-flow/IRR modeling and compliance tracking/recapture are distinct branches. The schema defines the deal, constants, and result objects. Edges reflect imports/re-exports visible in excerpts or capabilities explicitly documented in the README; no storage or external services are shown.

Main entry points: [`lihtccalc/__init__.py`](https://github.com/jaypatel1511/lihtc-calc/blob/main/lihtccalc/__init__.py) (Public API), [`lihtccalc/data/schema.py`](https://github.com/jaypatel1511/lihtc-calc/blob/main/lihtccalc/data/schema.py) (Deal and results), [`lihtccalc/models/credits.py`](https://github.com/jaypatel1511/lihtc-calc/blob/main/lihtccalc/models/credits.py) (Credit calculations), [`lihtccalc/compliance/recapture.py`](https://github.com/jaypatel1511/lihtc-calc/blob/main/lihtccalc/compliance/recapture.py) (Recapture analysis)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_deal["Deal and basis"]
  node_schema["Deal and results<br/>[schema.py]"]
  node_basis["Basis calculations<br/>[basis.py]"]
end

subgraph group_credits["Credit modeling"]
  node_credit_calc["Credit calculations<br/>[credits.py]"]
end

subgraph group_investment["Investor economics"]
  node_investor["Investor returns<br/>[investor.py]"]
end

subgraph group_compliance["Compliance and recapture"]
  node_tracker["Compliance tracking<br/>[tracker.py]"]
  node_recapture["Recapture analysis<br/>[recapture.py]"]
end

node_user(("Calculator user"))
node_api["Public API<br/>[__init__.py]"]

node_user -->|"uses"| node_api
node_api -->|"exports"| node_schema
node_api -->|"exports"| node_basis
node_api -->|"exports"| node_credit_calc
node_api -->|"exports"| node_investor
node_api -->|"exports"| node_tracker
node_api -->|"exports"| node_recapture
node_basis -->|"reads deal"| node_schema
node_credit_calc -->|"uses basis"| node_basis
node_credit_calc -->|"builds result"| node_schema
node_tracker -->|"reads deal"| node_schema
node_recapture -->|"builds event"| node_schema
node_recapture -->|"gets annual credit"| node_credit_calc

click node_api "https://github.com/jaypatel1511/lihtc-calc/blob/main/lihtccalc/__init__.py"
click node_schema "https://github.com/jaypatel1511/lihtc-calc/blob/main/lihtccalc/data/schema.py"
click node_basis "https://github.com/jaypatel1511/lihtc-calc/blob/main/lihtccalc/models/basis.py"
click node_credit_calc "https://github.com/jaypatel1511/lihtc-calc/blob/main/lihtccalc/models/credits.py"
click node_investor "https://github.com/jaypatel1511/lihtc-calc/blob/main/lihtccalc/models/investor.py"
click node_tracker "https://github.com/jaypatel1511/lihtc-calc/blob/main/lihtccalc/compliance/tracker.py"
click node_recapture "https://github.com/jaypatel1511/lihtc-calc/blob/main/lihtccalc/compliance/recapture.py"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_schema,node_basis,node_user toneBlue
class node_credit_calc toneAmber
class node_investor,node_api toneMint
class node_tracker,node_recapture toneRose
```

## Components

### Deal and basis

- [Deal and results](https://github.com/jaypatel1511/lihtc-calc/blob/main/lihtccalc/data/schema.py): `lihtccalc/data/schema.py`
- [Basis calculations](https://github.com/jaypatel1511/lihtc-calc/blob/main/lihtccalc/models/basis.py): `lihtccalc/models/basis.py`

### Credit modeling

- [Credit calculations](https://github.com/jaypatel1511/lihtc-calc/blob/main/lihtccalc/models/credits.py): `lihtccalc/models/credits.py`

### Investor economics

- [Investor returns](https://github.com/jaypatel1511/lihtc-calc/blob/main/lihtccalc/models/investor.py): `lihtccalc/models/investor.py`

### Compliance and recapture

- [Compliance tracking](https://github.com/jaypatel1511/lihtc-calc/blob/main/lihtccalc/compliance/tracker.py): `lihtccalc/compliance/tracker.py`
- [Recapture analysis](https://github.com/jaypatel1511/lihtc-calc/blob/main/lihtccalc/compliance/recapture.py): `lihtccalc/compliance/recapture.py`

### Other components

- **Calculator user**
- [Public API](https://github.com/jaypatel1511/lihtc-calc/blob/main/lihtccalc/__init__.py): `lihtccalc/__init__.py`

## Connections

- Calculator user → Public API: uses (evidence: `README.md`)
- Public API → Deal and results: exports (evidence: `lihtccalc/__init__.py`)
- Public API → Basis calculations: exports (evidence: `lihtccalc/__init__.py`)
- Public API → Credit calculations: exports (evidence: `lihtccalc/__init__.py`)
- Public API → Investor returns: exports (evidence: `lihtccalc/__init__.py`)
- Public API → Compliance tracking: exports (evidence: `lihtccalc/__init__.py`)
- Public API → Recapture analysis: exports (evidence: `lihtccalc/__init__.py`)
- Basis calculations → Deal and results: reads deal (evidence: `lihtccalc/models/basis.py`)
- Credit calculations → Basis calculations: uses basis (evidence: `lihtccalc/models/credits.py`)
- Credit calculations → Deal and results: builds result (evidence: `lihtccalc/models/credits.py`)
- Compliance tracking → Deal and results: reads deal (evidence: `lihtccalc/compliance/tracker.py`)
- Recapture analysis → Deal and results: builds event (evidence: `lihtccalc/compliance/recapture.py`)
- Recapture analysis → Credit calculations: gets annual credit (evidence: `lihtccalc/compliance/recapture.py`)
