# waynemaranga/steelsnakes architecture

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

- Interactive diagram: https://gitdiagram.com/waynemaranga/steelsnakes
- Repository: https://github.com/waynemaranga/steelsnakes

## Overview

steelsnakes is a Python structural-steel library: users select a regional section, obtain tabulated properties, and run code-specific classification/member checks or finite-element section analysis. Regional modules cover UK, EU, US imperial/metric, BS, and developing IN support; the README also identifies AU, NZ, and JP as scaffolded. Shared base classes, factories, databases, and check result models underpin the regional APIs. Some regional links and the engine’s external solver details are documented rather than fully shown in the sampled source, so those edges cite the README or are omitted.

Main entry points: [`src/steelsnakes/base/checks.py`](https://github.com/waynemaranga/steelsnakes/blob/main/src/steelsnakes/base/checks.py) (Check models), [`src/steelsnakes/engine/sections.py`](https://github.com/waynemaranga/steelsnakes/blob/main/src/steelsnakes/engine/sections.py) (Analysis engine), [`src/steelsnakes/EU/__init__.py`](https://github.com/waynemaranga/steelsnakes/blob/main/src/steelsnakes/EU/__init__.py) (EU API), [`src/steelsnakes/base/sections.py`](https://github.com/waynemaranga/steelsnakes/blob/main/src/steelsnakes/base/sections.py) (Section model)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_api["Regional APIs"]
  node_eu_api["EU API<br/>[__init__.py]"]
  node_uk_api["UK API<br/>[__init__.py]"]
  node_us_api["US API"]
  node_bs_api["BS API<br/>[__init__.py]"]
  node_in_api["India API<br/>[__init__.py]"]
end

subgraph group_catalog["Section catalogs"]
  node_eu_sections["EU Sections<br/>[beams.py]"]
  node_uk_sections["UK Sections<br/>[angles.py]"]
  node_us_sections["US Sections<br/>[beams.py]"]
  node_region_db[("Regional tables<br/>[database.py]")]
  node_eu_factory["EU factory<br/>[factory.py]"]
  node_uk_factory["UK factory<br/>[factory.py]"]
  node_us_factory["US factory<br/>[factory.py]"]
end

subgraph group_design["Design checks"]
  node_eu_class["EU classification<br/>[classification.py]"]
  node_eu_member["EU member checks<br/>[uls.py]"]
  node_eu_sls["EU serviceability<br/>[sls.py]"]
  node_uk_checks["UK checks"]
  node_bs_checks["BS checks<br/>[uls.py]"]
  node_us_class["US classification<br/>[classification.py]"]
  node_us_member["US member checks<br/>[compression.py]"]
  node_metric_checks["US metric checks<br/>[members.py]"]
  node_india_checks["India checks<br/>[uls.py]"]
end

subgraph group_shared["Shared foundation"]
  node_shared_sections["Section model<br/>[sections.py]"]
  node_shared_checks["Check models<br/>[checks.py]"]
end

subgraph group_analysis["Section analysis"]
  node_engine["Analysis engine<br/>[sections.py]"]
  node_solver["sectionproperties"]
end

node_user(("Engineer"))

node_user -->|"select section"| node_eu_api
node_user -->|"select section"| node_uk_api
node_user -->|"select section"| node_us_api
node_eu_api -->|"creates via"| node_eu_factory
node_eu_api -->|"exports"| node_eu_sections
node_uk_api -->|"registers through"| node_uk_factory
node_uk_api -->|"exports"| node_uk_sections
node_eu_factory -->|"loads table data"| node_region_db
node_uk_factory -->|"uses shared database"| node_region_db
node_us_factory -->|"uses shared database"| node_region_db
node_eu_factory -.->|"constructs sections"| node_eu_sections
node_uk_factory -->|"constructs sections"| node_uk_sections
node_us_factory -->|"constructs sections"| node_us_sections
node_user -->|"request checks"| node_bs_api
node_user -.->|"request checks"| node_in_api
node_bs_api -->|"exports"| node_bs_checks
node_in_api -->|"exports"| node_india_checks
node_user -->|"classify section"| node_eu_class
node_user -->|"check member"| node_eu_member
node_user -->|"check serviceability"| node_eu_sls
node_user -->|"check member"| node_bs_checks
node_user -->|"check member"| node_uk_checks
node_user -->|"classify section"| node_us_class
node_user -->|"check member"| node_us_member
node_eu_class -->|"uses result models"| node_shared_checks
node_eu_member -->|"uses classification"| node_eu_class
node_eu_member -->|"uses result models"| node_shared_checks
node_us_class -->|"uses result models"| node_shared_checks
node_us_member -->|"uses classification"| node_us_class
node_metric_checks -->|"reuses checks"| node_us_member
node_uk_checks -.->|"uses shared models"| node_shared_checks
node_bs_checks -->|"uses shared models"| node_shared_checks
node_india_checks -->|"uses shared models"| node_shared_checks
node_eu_sections -->|"extends section model"| node_shared_sections
node_uk_sections -->|"extends section model"| node_shared_sections
node_us_sections -->|"extends section model"| node_shared_sections
node_user -->|"analyze geometry"| node_engine
node_engine -->|"performs finite elements"| node_solver
node_engine -->|"accepts regional section"| node_eu_api
node_engine -->|"reads section model"| node_shared_sections

click node_eu_api "https://github.com/waynemaranga/steelsnakes/blob/main/src/steelsnakes/EU/__init__.py"
click node_uk_api "https://github.com/waynemaranga/steelsnakes/blob/main/src/steelsnakes/UK/__init__.py"
click node_us_api "https://github.com/waynemaranga/steelsnakes/tree/main/src/steelsnakes/US"
click node_bs_api "https://github.com/waynemaranga/steelsnakes/blob/main/src/steelsnakes/BS/__init__.py"
click node_in_api "https://github.com/waynemaranga/steelsnakes/blob/main/src/steelsnakes/IN/__init__.py"
click node_eu_sections "https://github.com/waynemaranga/steelsnakes/blob/main/src/steelsnakes/EU/sections/beams.py"
click node_uk_sections "https://github.com/waynemaranga/steelsnakes/blob/main/src/steelsnakes/UK/sections/angles.py"
click node_us_sections "https://github.com/waynemaranga/steelsnakes/blob/main/src/steelsnakes/US/sections/beams.py"
click node_region_db "https://github.com/waynemaranga/steelsnakes/blob/main/src/steelsnakes/base/database.py"
click node_eu_factory "https://github.com/waynemaranga/steelsnakes/blob/main/src/steelsnakes/EU/factory.py"
click node_uk_factory "https://github.com/waynemaranga/steelsnakes/blob/main/src/steelsnakes/UK/factory.py"
click node_us_factory "https://github.com/waynemaranga/steelsnakes/blob/main/src/steelsnakes/US/factory.py"
click node_eu_class "https://github.com/waynemaranga/steelsnakes/blob/main/src/steelsnakes/EU/checks/classification.py"
click node_eu_member "https://github.com/waynemaranga/steelsnakes/blob/main/src/steelsnakes/EU/checks/uls.py"
click node_eu_sls "https://github.com/waynemaranga/steelsnakes/blob/main/src/steelsnakes/EU/checks/sls.py"
click node_uk_checks "https://github.com/waynemaranga/steelsnakes/tree/main/src/steelsnakes/UK/checks"
click node_bs_checks "https://github.com/waynemaranga/steelsnakes/blob/main/src/steelsnakes/BS/checks/uls.py"
click node_us_class "https://github.com/waynemaranga/steelsnakes/blob/main/src/steelsnakes/US/checks/classification.py"
click node_us_member "https://github.com/waynemaranga/steelsnakes/blob/main/src/steelsnakes/US/checks/compression.py"
click node_metric_checks "https://github.com/waynemaranga/steelsnakes/blob/main/src/steelsnakes/US_Metric/checks/members.py"
click node_india_checks "https://github.com/waynemaranga/steelsnakes/blob/main/src/steelsnakes/IN/checks/uls.py"
click node_shared_sections "https://github.com/waynemaranga/steelsnakes/blob/main/src/steelsnakes/base/sections.py"
click node_shared_checks "https://github.com/waynemaranga/steelsnakes/blob/main/src/steelsnakes/base/checks.py"
click node_engine "https://github.com/waynemaranga/steelsnakes/blob/main/src/steelsnakes/engine/sections.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_eu_api,node_uk_api,node_us_api,node_bs_api,node_in_api toneBlue
class node_eu_sections,node_uk_sections,node_us_sections,node_region_db,node_eu_factory,node_uk_factory,node_us_factory toneAmber
class node_eu_class,node_eu_member,node_eu_sls,node_uk_checks,node_bs_checks,node_us_class,node_us_member,node_metric_checks,node_india_checks toneMint
class node_shared_sections,node_shared_checks toneRose
class node_engine,node_solver,node_user toneIndigo
```

## Components

### Regional APIs

- [EU API](https://github.com/waynemaranga/steelsnakes/blob/main/src/steelsnakes/EU/__init__.py): `src/steelsnakes/EU/__init__.py`
- [UK API](https://github.com/waynemaranga/steelsnakes/blob/main/src/steelsnakes/UK/__init__.py): `src/steelsnakes/UK/__init__.py`
- [US API](https://github.com/waynemaranga/steelsnakes/tree/main/src/steelsnakes/US): `src/steelsnakes/US`
- [BS API](https://github.com/waynemaranga/steelsnakes/blob/main/src/steelsnakes/BS/__init__.py): `src/steelsnakes/BS/__init__.py`
- [India API](https://github.com/waynemaranga/steelsnakes/blob/main/src/steelsnakes/IN/__init__.py): `src/steelsnakes/IN/__init__.py`

### Section catalogs

- [EU Sections](https://github.com/waynemaranga/steelsnakes/blob/main/src/steelsnakes/EU/sections/beams.py): `src/steelsnakes/EU/sections/beams.py`
- [UK Sections](https://github.com/waynemaranga/steelsnakes/blob/main/src/steelsnakes/UK/sections/angles.py): `src/steelsnakes/UK/sections/angles.py`
- [US Sections](https://github.com/waynemaranga/steelsnakes/blob/main/src/steelsnakes/US/sections/beams.py): `src/steelsnakes/US/sections/beams.py`
- [Regional tables](https://github.com/waynemaranga/steelsnakes/blob/main/src/steelsnakes/base/database.py): `src/steelsnakes/base/database.py`
- [EU factory](https://github.com/waynemaranga/steelsnakes/blob/main/src/steelsnakes/EU/factory.py): `src/steelsnakes/EU/factory.py`
- [UK factory](https://github.com/waynemaranga/steelsnakes/blob/main/src/steelsnakes/UK/factory.py): `src/steelsnakes/UK/factory.py`
- [US factory](https://github.com/waynemaranga/steelsnakes/blob/main/src/steelsnakes/US/factory.py): `src/steelsnakes/US/factory.py`

### Design checks

- [EU classification](https://github.com/waynemaranga/steelsnakes/blob/main/src/steelsnakes/EU/checks/classification.py): `src/steelsnakes/EU/checks/classification.py`
- [EU member checks](https://github.com/waynemaranga/steelsnakes/blob/main/src/steelsnakes/EU/checks/uls.py): `src/steelsnakes/EU/checks/uls.py`
- [EU serviceability](https://github.com/waynemaranga/steelsnakes/blob/main/src/steelsnakes/EU/checks/sls.py): `src/steelsnakes/EU/checks/sls.py`
- [UK checks](https://github.com/waynemaranga/steelsnakes/tree/main/src/steelsnakes/UK/checks): `src/steelsnakes/UK/checks`
- [BS checks](https://github.com/waynemaranga/steelsnakes/blob/main/src/steelsnakes/BS/checks/uls.py): `src/steelsnakes/BS/checks/uls.py`
- [US classification](https://github.com/waynemaranga/steelsnakes/blob/main/src/steelsnakes/US/checks/classification.py): `src/steelsnakes/US/checks/classification.py`
- [US member checks](https://github.com/waynemaranga/steelsnakes/blob/main/src/steelsnakes/US/checks/compression.py): `src/steelsnakes/US/checks/compression.py`
- [US metric checks](https://github.com/waynemaranga/steelsnakes/blob/main/src/steelsnakes/US_Metric/checks/members.py): `src/steelsnakes/US_Metric/checks/members.py`
- [India checks](https://github.com/waynemaranga/steelsnakes/blob/main/src/steelsnakes/IN/checks/uls.py): `src/steelsnakes/IN/checks/uls.py`

### Shared foundation

- [Section model](https://github.com/waynemaranga/steelsnakes/blob/main/src/steelsnakes/base/sections.py): `src/steelsnakes/base/sections.py`
- [Check models](https://github.com/waynemaranga/steelsnakes/blob/main/src/steelsnakes/base/checks.py): `src/steelsnakes/base/checks.py`

### Section analysis

- [Analysis engine](https://github.com/waynemaranga/steelsnakes/blob/main/src/steelsnakes/engine/sections.py): `src/steelsnakes/engine/sections.py`
- **sectionproperties**

### Other components

- **Engineer**

## Connections

- Engineer → EU API: select section
- Engineer → UK API: select section
- Engineer → US API: select section
- EU API → EU factory: creates via (evidence: `src/steelsnakes/EU/__init__.py`)
- EU API → EU Sections: exports (evidence: `src/steelsnakes/EU/__init__.py`)
- UK API → UK factory: registers through (evidence: `src/steelsnakes/UK/__init__.py`)
- UK API → UK Sections: exports (evidence: `src/steelsnakes/UK/__init__.py`)
- EU factory → Regional tables: loads table data
- UK factory → Regional tables: uses shared database
- US factory → Regional tables: uses shared database
- EU factory → EU Sections: constructs sections (evidence: `src/steelsnakes/EU/sections/beams.py`)
- UK factory → UK Sections: constructs sections (evidence: `src/steelsnakes/UK/sections/angles.py`)
- US factory → US Sections: constructs sections (evidence: `src/steelsnakes/US/sections/beams.py`)
- Engineer → BS API: request checks
- Engineer → India API: request checks
- BS API → BS checks: exports (evidence: `src/steelsnakes/BS/__init__.py`)
- India API → India checks: exports (evidence: `src/steelsnakes/IN/__init__.py`)
- Engineer → EU classification: classify section
- Engineer → EU member checks: check member
- Engineer → EU serviceability: check serviceability
- Engineer → BS checks: check member
- Engineer → UK checks: check member
- Engineer → US classification: classify section
- Engineer → US member checks: check member
- EU classification → Check models: uses result models (evidence: `src/steelsnakes/EU/checks/classification.py`)
- EU member checks → EU classification: uses classification (evidence: `src/steelsnakes/EU/checks/uls.py`)
- EU member checks → Check models: uses result models (evidence: `src/steelsnakes/EU/checks/uls.py`)
- US classification → Check models: uses result models (evidence: `src/steelsnakes/US/checks/classification.py`)
- US member checks → US classification: uses classification (evidence: `src/steelsnakes/US/checks/compression.py`)
- US metric checks → US member checks: reuses checks (evidence: `src/steelsnakes/US_Metric/checks/members.py`)
- UK checks → Check models: uses shared models (evidence: `src/steelsnakes/UK/checks/uls.py`)
- BS checks → Check models: uses shared models (evidence: `src/steelsnakes/BS/checks/uls.py`)
- India checks → Check models: uses shared models (evidence: `src/steelsnakes/IN/checks/uls.py`)
- EU Sections → Section model: extends section model (evidence: `src/steelsnakes/EU/sections/beams.py`)
- UK Sections → Section model: extends section model (evidence: `src/steelsnakes/UK/sections/angles.py`)
- US Sections → Section model: extends section model (evidence: `src/steelsnakes/US/sections/beams.py`)
- Engineer → Analysis engine: analyze geometry
- Analysis engine → sectionproperties: performs finite elements
- Analysis engine → EU API: accepts regional section (evidence: `src/steelsnakes/engine/sections.py`)
- Analysis engine → Section model: reads section model (evidence: `src/steelsnakes/engine/sections.py`)
