# kuisidu/metku architecture

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

- Interactive diagram: https://gitdiagram.com/kuisidu/metku
- Repository: https://github.com/kuisidu/metku

## Overview

##### Project type and purpose
- This is a Python library (“metku”) for analyzing and optimizing steel and timber frame structures.
- It provides modules for cross-section design, Eurocode checks, cost estimation, structural analysis engines, and optimization solvers.

##### File-structure analysis
- Top-level files:
- setup.py, setup.cfg, requirements.txt – packaging and dependencies
- build_package.py, upload_package.py – build/release scripts
- environment.yml – conda environment
- Main packages under metku/:
- cost/ – cost_calculation.py, cost_data.py, workshop.py
- design/ – cross_section.py, steel_section.py
- eurocodes/ – en1991… en1995 modules for code checks
- frame2d/ – 2D frame analysis (geometry.py, loads.py, member.py, frame2d.py, optimizer, tests)
- framefem/ – finite-element frame engine (elements/, loads/, sections/)
- optimization/ – benchmarks, solvers (aco, pso, milp…), problem definitions, results exporters/plotters
- sections/ – steel/timber cross‐section data and formulas, composite, profile catalogues
- structures/ – high‐level structural models (steel, timber members & joints, trusses, frames)
- raami/ – user-facing API for rapid frame modelling and exporting
- helpers/, log_to_file.py, settings/ – utilities and configuration
- examples/ – ready examples showing usage

##### Key insights from README
- The README confirms the library’s focus (analyze & optimize frames) and installation method (pip).

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% User Entry
    subgraph "User Entry"
        direction TB
        User["User / Scripts"]:::external
        Examples["metku.examples"]:::api
        Raami["metku.raami"]:::api
    end

    %% Domain Models
    subgraph "Domain Models"
        direction TB
        Structures["metku.structures"]:::domain
    end

    %% Analysis Engines
    subgraph "Analysis Engines"
        direction TB
        F2D["metku.frame2d"]:::analysis
        FFEM["metku.framefem"]:::analysis
    end

    %% Design & Compliance
    subgraph "Design & Compliance"
        direction TB
        Design["metku.design"]:::design
        Eurocodes["metku.eurocodes"]:::design
    end

    %% Cost Estimation
    subgraph "Cost Estimation"
        direction TB
        Cost["metku.cost"]:::cost
    end

    %% Optimization Engine
    subgraph "Optimization Engine"
        direction TB
        Benchmarks["metku.optimization.benchmarks"]:::optimization
        Solvers["metku.optimization.solvers"]:::optimization
        Problems["metku.optimization.problems"]:::optimization
        Results["metku.optimization.results"]:::optimization
        Calculations["metku.optimization.calculations"]:::optimization
    end

    %% Data Modules
    subgraph "Data Modules"
        direction TB
        Sections["metku.sections"]:::data
        Materials["metku.materials"]:::data
    end

    %% Utilities & Config
    subgraph "Utilities & Config"
        direction TB
        Helpers["metku.helpers"]:::util
        Settings["metku.settings"]:::util
        Log["metku.log_to_file"]:::util
    end

    %% Connections
    User --> Examples
    User --> Raami
    Examples --> Structures
    Raami --> Structures

    Structures --> F2D
    Structures --> FFEM

    F2D --> Design
    FFEM --> Design

    Design --> Eurocodes
    Design --> Cost

    Cost --> Optimization_Start["Optimization Start"]:::note
    Eurocodes --> Optimization_Start

    Optimization_Start --> Benchmarks
    Optimization_Start --> Problems
    Problems --> Solvers
    Solvers --> Calculations
    Calculations --> Results

    F2D --> Optimization_Start
    FFEM --> Optimization_Start

    Sections --> Design
    Materials --> Design
    Sections --> Cost
    Materials --> Cost

    Helpers --> F2D
    Settings --> F2D
    Log --> F2D

    Helpers --> FFEM
    Settings --> FFEM
    Log --> FFEM

    %% Click Events
    click Raami "https://github.com/kuisidu/metku/tree/master/metku/raami/"
    click F2D "https://github.com/kuisidu/metku/tree/master/metku/frame2d/"
    click FFEM "https://github.com/kuisidu/metku/tree/master/metku/framefem/"
    click Design "https://github.com/kuisidu/metku/tree/master/metku/design/"
    click Eurocodes "https://github.com/kuisidu/metku/tree/master/metku/eurocodes/"
    click Cost "https://github.com/kuisidu/metku/tree/master/metku/cost/"
    click Benchmarks "https://github.com/kuisidu/metku/tree/master/metku/optimization/benchmarks/"
    click Solvers "https://github.com/kuisidu/metku/tree/master/metku/optimization/solvers/"
    click Problems "https://github.com/kuisidu/metku/tree/master/metku/optimization/problems/"
    click Results "https://github.com/kuisidu/metku/tree/master/metku/optimization/results/"
    click Sections "https://github.com/kuisidu/metku/tree/master/metku/sections/"
    click Materials "https://github.com/kuisidu/metku/tree/master/metku/materials/"
    click Structures "https://github.com/kuisidu/metku/tree/master/metku/structures/"
    click Helpers "https://github.com/kuisidu/metku/tree/master/metku/helpers/"
    click Settings "https://github.com/kuisidu/metku/tree/master/metku/settings/"
    click Log "https://github.com/kuisidu/metku/tree/master/metku/log_to_file"
    click Examples "https://github.com/kuisidu/metku/tree/master/metku/examples/"

    %% Styles
    classDef external fill:#FFFFFF,stroke:#000000,stroke-width:1px;
    classDef api fill:#E8DAEF,stroke:#784212,stroke-width:1px;
    classDef domain fill:#F5CBA7,stroke:#784212,stroke-width:1px;
    classDef analysis fill:#D6EAF8,stroke:#1B4F72,stroke-width:1px;
    classDef design fill:#FAD7A0,stroke:#B9770E,stroke-width:1px;
    classDef cost fill:#FCF3CF,stroke:#7D6608,stroke-width:1px;
    classDef optimization fill:#D5F5E3,stroke:#186A3B,stroke-width:1px;
    classDef data fill:#D6DBDF,stroke:#424949,stroke-width:1px;
    classDef util fill:#D7DBDD,stroke:#1C2833,stroke-width:1px;
    classDef note fill:#FFFFFF,stroke:#000000,stroke-dasharray: 2 2;
```
