# bcc-phm/birmingham-ethnic-population-projection architecture

> Architecture diagram of the GitHub repository bcc-phm/birmingham-ethnic-population-projection, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-02). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/bcc-phm/birmingham-ethnic-population-projection
- Repository: https://github.com/bcc-phm/birmingham-ethnic-population-projection

## Overview

This repository is a project-template shell, but its filenames indicate a Birmingham ethnic-population projection project using a cohort-component model, with a report as a user-facing output. The apparent workflow covers population inputs, demographic processes, the CCM engine and post-processing. The README describes template conventions rather than the projection itself, and no projection source was excerpted, so the process links below are unverified; they are shown dashed rather than asserted as inspected calls.

Main entry points: [`R/10_the_CCM_engine.R`](https://github.com/bcc-phm/birmingham-ethnic-population-projection/blob/main/R/10_the_CCM_engine.R) (CCM Engine), [`R/09_bham_starting_pop.R`](https://github.com/bcc-phm/birmingham-ethnic-population-projection/blob/main/R/09_bham_starting_pop.R) (Starting Population), [`R/11_post_CCM_result.R`](https://github.com/bcc-phm/birmingham-ethnic-population-projection/blob/main/R/11_post_CCM_result.R) (Post-CCM Results), [`R/05.0_migration_demo.R`](https://github.com/bcc-phm/birmingham-ethnic-population-projection/blob/main/R/05.0_migration_demo.R) (Migration Demo)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_inputs["Population Inputs"]
  node_migration_demo["Migration Demo"]
  node_internal_migration["Internal Migration"]
  node_uk_migration["UK Migration"]
  node_bham_immigration["Birmingham Immigration"]
  node_immigration_shares["Immigration Shares"]
  node_international_immigration["International Immigration"]
  node_emigration["International Emigration"]
  node_ruk_denominator["RUK Denominator"]
  node_starting_population["Starting Population"]
  node_sql_queries["Population Queries"]
end

subgraph group_demography["Demographic Processes"]
  node_mortality["Mortality Process"]
  node_mortality_single["Single-Year Mortality"]
  node_improvements["Mortality Improvements"]
  node_fertility["Fertility Process"]
  node_births["Birth Matrix<br/>[04_birth_matrix.R]"]
end

subgraph group_projection["Projection and Reporting"]
  node_ccm["CCM Engine"]
  node_post_ccm["Post-CCM Results"]
  node_report["Projection Report"]
end

node_analyst(("Analyst"))

node_analyst -.->|"runs projection"| node_ccm
node_mortality -.->|"supplies mortality"| node_ccm
node_mortality_single -.->|"supplies mortality"| node_ccm
node_improvements -.->|"supplies improvements"| node_ccm
node_fertility -.->|"supplies fertility"| node_ccm
node_births -.->|"supplies births"| node_ccm
node_migration_demo -.->|"supplies migration"| node_ccm
node_internal_migration -.->|"supplies migration"| node_ccm
node_uk_migration -.->|"supplies migration"| node_ccm
node_bham_immigration -.->|"supplies immigration"| node_ccm
node_immigration_shares -.->|"supplies shares"| node_ccm
node_international_immigration -.->|"supplies immigration"| node_ccm
node_emigration -.->|"supplies emigration"| node_ccm
node_ruk_denominator -.->|"supplies denominator"| node_ccm
node_starting_population -.->|"supplies population"| node_ccm
node_sql_queries -.->|"queries data"| node_starting_population
node_ccm -.->|"produces results"| node_post_ccm
node_post_ccm -.->|"provides results"| node_report

click node_mortality "https://github.com/bcc-phm/birmingham-ethnic-population-projection/blob/main/R/01_mortality_process.R"
click node_mortality_single "https://github.com/bcc-phm/birmingham-ethnic-population-projection/blob/main/R/01a_mortality_process_single_year.R"
click node_improvements "https://github.com/bcc-phm/birmingham-ethnic-population-projection/blob/main/R/02_mortality_improvements.R"
click node_fertility "https://github.com/bcc-phm/birmingham-ethnic-population-projection/blob/main/R/03_fertility_process.R"
click node_births "https://github.com/bcc-phm/birmingham-ethnic-population-projection/blob/main/R/04_birth_matrix.R"
click node_migration_demo "https://github.com/bcc-phm/birmingham-ethnic-population-projection/blob/main/R/05.0_migration_demo.R"
click node_internal_migration "https://github.com/bcc-phm/birmingham-ethnic-population-projection/blob/main/R/05.0a_internal_migration.R"
click node_uk_migration "https://github.com/bcc-phm/birmingham-ethnic-population-projection/blob/main/R/05.1_migration_demo_uk.R"
click node_bham_immigration "https://github.com/bcc-phm/birmingham-ethnic-population-projection/blob/main/R/05.2_immigration_bham.R"
click node_immigration_shares "https://github.com/bcc-phm/birmingham-ethnic-population-projection/blob/main/R/06.1a_immigration_shares_flag4.R"
click node_international_immigration "https://github.com/bcc-phm/birmingham-ethnic-population-projection/blob/main/R/06_International_immigration.R"
click node_emigration "https://github.com/bcc-phm/birmingham-ethnic-population-projection/blob/main/R/07_international_emmigration.R"
click node_ruk_denominator "https://github.com/bcc-phm/birmingham-ethnic-population-projection/blob/main/R/08_RUK_denominator_internal_in.R"
click node_starting_population "https://github.com/bcc-phm/birmingham-ethnic-population-projection/blob/main/R/09_bham_starting_pop.R"
click node_ccm "https://github.com/bcc-phm/birmingham-ethnic-population-projection/blob/main/R/10_the_CCM_engine.R"
click node_post_ccm "https://github.com/bcc-phm/birmingham-ethnic-population-projection/blob/main/R/11_post_CCM_result.R"
click node_report "https://github.com/bcc-phm/birmingham-ethnic-population-projection/blob/main/app/ethnic_projection_report.qmd"
click node_sql_queries "https://github.com/bcc-phm/birmingham-ethnic-population-projection/tree/main/sql"

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_migration_demo,node_internal_migration,node_uk_migration,node_bham_immigration,node_immigration_shares,node_international_immigration,node_emigration,node_ruk_denominator,node_starting_population,node_sql_queries toneBlue
class node_mortality,node_mortality_single,node_improvements,node_fertility,node_births toneAmber
class node_ccm,node_post_ccm,node_report toneMint
class node_analyst toneIndigo
```

## Components

### Population Inputs

- [Migration Demo](https://github.com/bcc-phm/birmingham-ethnic-population-projection/blob/main/R/05.0_migration_demo.R): `R/05.0_migration_demo.R`
- [Internal Migration](https://github.com/bcc-phm/birmingham-ethnic-population-projection/blob/main/R/05.0a_internal_migration.R): `R/05.0a_internal_migration.R`
- [UK Migration](https://github.com/bcc-phm/birmingham-ethnic-population-projection/blob/main/R/05.1_migration_demo_uk.R): `R/05.1_migration_demo_uk.R`
- [Birmingham Immigration](https://github.com/bcc-phm/birmingham-ethnic-population-projection/blob/main/R/05.2_immigration_bham.R): `R/05.2_immigration_bham.R`
- [Immigration Shares](https://github.com/bcc-phm/birmingham-ethnic-population-projection/blob/main/R/06.1a_immigration_shares_flag4.R): `R/06.1a_immigration_shares_flag4.R`
- [International Immigration](https://github.com/bcc-phm/birmingham-ethnic-population-projection/blob/main/R/06_International_immigration.R): `R/06_International_immigration.R`
- [International Emigration](https://github.com/bcc-phm/birmingham-ethnic-population-projection/blob/main/R/07_international_emmigration.R): `R/07_international_emmigration.R`
- [RUK Denominator](https://github.com/bcc-phm/birmingham-ethnic-population-projection/blob/main/R/08_RUK_denominator_internal_in.R): `R/08_RUK_denominator_internal_in.R`
- [Starting Population](https://github.com/bcc-phm/birmingham-ethnic-population-projection/blob/main/R/09_bham_starting_pop.R): `R/09_bham_starting_pop.R`
- [Population Queries](https://github.com/bcc-phm/birmingham-ethnic-population-projection/tree/main/sql): `sql`

### Demographic Processes

- [Mortality Process](https://github.com/bcc-phm/birmingham-ethnic-population-projection/blob/main/R/01_mortality_process.R): `R/01_mortality_process.R`
- [Single-Year Mortality](https://github.com/bcc-phm/birmingham-ethnic-population-projection/blob/main/R/01a_mortality_process_single_year.R): `R/01a_mortality_process_single_year.R`
- [Mortality Improvements](https://github.com/bcc-phm/birmingham-ethnic-population-projection/blob/main/R/02_mortality_improvements.R): `R/02_mortality_improvements.R`
- [Fertility Process](https://github.com/bcc-phm/birmingham-ethnic-population-projection/blob/main/R/03_fertility_process.R): `R/03_fertility_process.R`
- [Birth Matrix](https://github.com/bcc-phm/birmingham-ethnic-population-projection/blob/main/R/04_birth_matrix.R): `R/04_birth_matrix.R`

### Projection and Reporting

- [CCM Engine](https://github.com/bcc-phm/birmingham-ethnic-population-projection/blob/main/R/10_the_CCM_engine.R): `R/10_the_CCM_engine.R`
- [Post-CCM Results](https://github.com/bcc-phm/birmingham-ethnic-population-projection/blob/main/R/11_post_CCM_result.R): `R/11_post_CCM_result.R`
- [Projection Report](https://github.com/bcc-phm/birmingham-ethnic-population-projection/blob/main/app/ethnic_projection_report.qmd): `app/ethnic_projection_report.qmd`

### Other components

- **Analyst**

## Connections

- Analyst → CCM Engine: runs projection
- Mortality Process → CCM Engine: supplies mortality
- Single-Year Mortality → CCM Engine: supplies mortality
- Mortality Improvements → CCM Engine: supplies improvements
- Fertility Process → CCM Engine: supplies fertility
- Birth Matrix → CCM Engine: supplies births
- Migration Demo → CCM Engine: supplies migration
- Internal Migration → CCM Engine: supplies migration
- UK Migration → CCM Engine: supplies migration
- Birmingham Immigration → CCM Engine: supplies immigration
- Immigration Shares → CCM Engine: supplies shares
- International Immigration → CCM Engine: supplies immigration
- International Emigration → CCM Engine: supplies emigration
- RUK Denominator → CCM Engine: supplies denominator
- Starting Population → CCM Engine: supplies population
- Population Queries → Starting Population: queries data
- CCM Engine → Post-CCM Results: produces results
- Post-CCM Results → Projection Report: provides results
