# boavizta/boaviztapi architecture

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

- Interactive diagram: https://gitdiagram.com/boavizta/boaviztapi
- Repository: https://github.com/boavizta/boaviztapi

## Overview

BoaviztAPI is a FastAPI service that estimates embedded and electricity-use environmental impacts for equipment and digital services. The main workflow accepts a request for a device, component, or cloud instance; maps supplied parameters into domain models; computes selected impact criteria; and returns results, optionally with verbose attribute detail. The README also describes equipment and service assessments as distinct layers. The graph preserves the documented IoT, peripheral, consumption-profile, and utility API branches; their implementation links are limited where source excerpts were not provided.

Main entry points: [`boaviztapi/main.py`](https://github.com/boavizta/boaviztapi/blob/main/boaviztapi/main.py) (FastAPI app), [`boaviztapi/dto`](https://github.com/boavizta/boaviztapi/tree/main/boaviztapi/dto) (Request DTOs), [`boaviztapi/compute/impacts_computation.py`](https://github.com/boavizta/boaviztapi/blob/main/boaviztapi/compute/impacts_computation.py) (Impact computation), [`boaviztapi/routers/server_router.py`](https://github.com/boavizta/boaviztapi/blob/main/boaviztapi/routers/server_router.py) (Server API)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_api["API surface"]
  node_main["FastAPI app<br/>[main.py]"]
  node_server_api["Server API<br/>[server_router.py]"]
  node_cloud_api["Cloud API<br/>[cloud_router.py]"]
  node_component_api["Component API"]
  node_terminal_api["Terminal API<br/>[terminal_router.py]"]
  node_peripheral_api["Peripheral API"]
  node_iot_api["IoT API<br/>[iot_router.py]"]
  node_profile_api["Consumption profiles"]
  node_utility_api["Utility API<br/>[utils_router.py]"]
end

subgraph group_inputs["Request and domain models"]
  node_request_dtos["Request DTOs"]
  node_usage_dto["Usage mapping<br/>[usage.py]"]
  node_server_model["Server model<br/>[server.py]"]
  node_cloud_model["Cloud instance model<br/>[cloud_instance.py]"]
  node_component_models["Component models"]
  node_attributes["Attribute state<br/>[boattribute.py]"]
end

subgraph group_calculation["Impact calculation"]
  node_compute["Impact computation"]
  node_impact_results["Impact results<br/>[impact.py]"]
  node_verbose["Verbose output<br/>[verbose.py]"]
end

subgraph group_reference["Reference data"]
  node_archetypes["Archetype lookup<br/>[archetype.py]"]
  node_factors["Impact factors<br/>[factor_provider.py]"]
end

node_client(("API client"))

node_client -->|"sends request"| node_main
node_main -->|"registers routes"| node_server_api
node_main -->|"registers routes"| node_cloud_api
node_main -->|"registers routes"| node_component_api
node_main -->|"registers routes"| node_terminal_api
node_main -->|"registers routes"| node_peripheral_api
node_main -->|"registers routes"| node_iot_api
node_main -->|"registers routes"| node_profile_api
node_main -->|"registers routes"| node_utility_api
node_server_api -->|"maps request"| node_request_dtos
node_cloud_api -->|"maps request"| node_request_dtos
node_component_api -->|"maps request"| node_request_dtos
node_terminal_api -->|"maps request"| node_request_dtos
node_peripheral_api -->|"maps request"| node_request_dtos
node_request_dtos -->|"builds device"| node_server_model
node_request_dtos -->|"builds service"| node_cloud_model
node_request_dtos -->|"builds components"| node_component_models
node_request_dtos -->|"maps usage"| node_usage_dto
node_usage_dto -->|"sets inputs"| node_attributes
node_server_model -->|"assembles hardware"| node_component_models
node_cloud_model -->|"models platform"| node_server_model
node_server_api -->|"computes impacts"| node_compute
node_cloud_api -->|"computes impacts"| node_compute
node_component_api -->|"computes impacts"| node_compute
node_terminal_api -->|"computes impacts"| node_compute
node_compute -->|"reads factors"| node_factors
node_compute -->|"creates results"| node_impact_results
node_compute -->|"loads archetypes"| node_archetypes
node_archetypes -.->|"supplies defaults"| node_attributes
node_cloud_api -->|"formats detail"| node_verbose
node_server_api -->|"formats detail"| node_verbose

click node_main "https://github.com/boavizta/boaviztapi/blob/main/boaviztapi/main.py"
click node_server_api "https://github.com/boavizta/boaviztapi/blob/main/boaviztapi/routers/server_router.py"
click node_cloud_api "https://github.com/boavizta/boaviztapi/blob/main/boaviztapi/routers/cloud_router.py"
click node_component_api "https://github.com/boavizta/boaviztapi/blob/main/boaviztapi/routers/component_router.py"
click node_terminal_api "https://github.com/boavizta/boaviztapi/blob/main/boaviztapi/routers/terminal_router.py"
click node_peripheral_api "https://github.com/boavizta/boaviztapi/blob/main/boaviztapi/routers/peripheral_router.py"
click node_iot_api "https://github.com/boavizta/boaviztapi/blob/main/boaviztapi/routers/iot_router.py"
click node_profile_api "https://github.com/boavizta/boaviztapi/blob/main/boaviztapi/routers/consumption_profile_router.py"
click node_utility_api "https://github.com/boavizta/boaviztapi/blob/main/boaviztapi/routers/utils_router.py"
click node_request_dtos "https://github.com/boavizta/boaviztapi/tree/main/boaviztapi/dto"
click node_usage_dto "https://github.com/boavizta/boaviztapi/blob/main/boaviztapi/dto/usage/usage.py"
click node_server_model "https://github.com/boavizta/boaviztapi/blob/main/boaviztapi/models/device/server.py"
click node_cloud_model "https://github.com/boavizta/boaviztapi/blob/main/boaviztapi/models/services/cloud_instance.py"
click node_component_models "https://github.com/boavizta/boaviztapi/tree/main/boaviztapi/models/component"
click node_attributes "https://github.com/boavizta/boaviztapi/blob/main/boaviztapi/models/boattribute.py"
click node_compute "https://github.com/boavizta/boaviztapi/blob/main/boaviztapi/compute/impacts_computation.py"
click node_impact_results "https://github.com/boavizta/boaviztapi/blob/main/boaviztapi/models/impact.py"
click node_verbose "https://github.com/boavizta/boaviztapi/blob/main/boaviztapi/compute/verbose.py"
click node_archetypes "https://github.com/boavizta/boaviztapi/blob/main/boaviztapi/data/archetype.py"
click node_factors "https://github.com/boavizta/boaviztapi/blob/main/boaviztapi/data/factor_provider.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_main,node_server_api,node_cloud_api,node_component_api,node_terminal_api,node_peripheral_api,node_iot_api,node_profile_api,node_utility_api,node_client toneBlue
class node_request_dtos,node_usage_dto,node_server_model,node_cloud_model,node_component_models,node_attributes toneAmber
class node_compute,node_impact_results,node_verbose toneMint
class node_archetypes,node_factors toneRose
```

## Components

### API surface

- [FastAPI app](https://github.com/boavizta/boaviztapi/blob/main/boaviztapi/main.py): `boaviztapi/main.py`
- [Server API](https://github.com/boavizta/boaviztapi/blob/main/boaviztapi/routers/server_router.py): `boaviztapi/routers/server_router.py`
- [Cloud API](https://github.com/boavizta/boaviztapi/blob/main/boaviztapi/routers/cloud_router.py): `boaviztapi/routers/cloud_router.py`
- [Component API](https://github.com/boavizta/boaviztapi/blob/main/boaviztapi/routers/component_router.py): `boaviztapi/routers/component_router.py`
- [Terminal API](https://github.com/boavizta/boaviztapi/blob/main/boaviztapi/routers/terminal_router.py): `boaviztapi/routers/terminal_router.py`
- [Peripheral API](https://github.com/boavizta/boaviztapi/blob/main/boaviztapi/routers/peripheral_router.py): `boaviztapi/routers/peripheral_router.py`
- [IoT API](https://github.com/boavizta/boaviztapi/blob/main/boaviztapi/routers/iot_router.py): `boaviztapi/routers/iot_router.py`
- [Consumption profiles](https://github.com/boavizta/boaviztapi/blob/main/boaviztapi/routers/consumption_profile_router.py): `boaviztapi/routers/consumption_profile_router.py`
- [Utility API](https://github.com/boavizta/boaviztapi/blob/main/boaviztapi/routers/utils_router.py): `boaviztapi/routers/utils_router.py`

### Request and domain models

- [Request DTOs](https://github.com/boavizta/boaviztapi/tree/main/boaviztapi/dto): `boaviztapi/dto`
- [Usage mapping](https://github.com/boavizta/boaviztapi/blob/main/boaviztapi/dto/usage/usage.py): `boaviztapi/dto/usage/usage.py`
- [Server model](https://github.com/boavizta/boaviztapi/blob/main/boaviztapi/models/device/server.py): `boaviztapi/models/device/server.py`
- [Cloud instance model](https://github.com/boavizta/boaviztapi/blob/main/boaviztapi/models/services/cloud_instance.py): `boaviztapi/models/services/cloud_instance.py`
- [Component models](https://github.com/boavizta/boaviztapi/tree/main/boaviztapi/models/component): `boaviztapi/models/component`
- [Attribute state](https://github.com/boavizta/boaviztapi/blob/main/boaviztapi/models/boattribute.py): `boaviztapi/models/boattribute.py`

### Impact calculation

- [Impact computation](https://github.com/boavizta/boaviztapi/blob/main/boaviztapi/compute/impacts_computation.py): `boaviztapi/compute/impacts_computation.py`
- [Impact results](https://github.com/boavizta/boaviztapi/blob/main/boaviztapi/models/impact.py): `boaviztapi/models/impact.py`
- [Verbose output](https://github.com/boavizta/boaviztapi/blob/main/boaviztapi/compute/verbose.py): `boaviztapi/compute/verbose.py`

### Reference data

- [Archetype lookup](https://github.com/boavizta/boaviztapi/blob/main/boaviztapi/data/archetype.py): `boaviztapi/data/archetype.py`
- [Impact factors](https://github.com/boavizta/boaviztapi/blob/main/boaviztapi/data/factor_provider.py): `boaviztapi/data/factor_provider.py`

### Other components

- **API client**

## Connections

- API client → FastAPI app: sends request (evidence: `README.md`)
- FastAPI app → Server API: registers routes (evidence: `boaviztapi/main.py`)
- FastAPI app → Cloud API: registers routes (evidence: `boaviztapi/main.py`)
- FastAPI app → Component API: registers routes (evidence: `boaviztapi/main.py`)
- FastAPI app → Terminal API: registers routes (evidence: `boaviztapi/main.py`)
- FastAPI app → Peripheral API: registers routes (evidence: `boaviztapi/main.py`)
- FastAPI app → IoT API: registers routes (evidence: `boaviztapi/main.py`)
- FastAPI app → Consumption profiles: registers routes (evidence: `boaviztapi/main.py`)
- FastAPI app → Utility API: registers routes (evidence: `boaviztapi/main.py`)
- Server API → Request DTOs: maps request (evidence: `boaviztapi/routers/server_router.py`)
- Cloud API → Request DTOs: maps request (evidence: `boaviztapi/routers/cloud_router.py`)
- Component API → Request DTOs: maps request (evidence: `boaviztapi/routers/component_router.py`)
- Terminal API → Request DTOs: maps request (evidence: `boaviztapi/routers/terminal_router.py`)
- Peripheral API → Request DTOs: maps request (evidence: `boaviztapi/routers/peripheral_router.py`)
- Request DTOs → Server model: builds device (evidence: `boaviztapi/dto/device/device.py`)
- Request DTOs → Cloud instance model: builds service (evidence: `boaviztapi/dto/device/device.py`)
- Request DTOs → Component models: builds components (evidence: `boaviztapi/dto/component/gpu.py`)
- Request DTOs → Usage mapping: maps usage (evidence: `boaviztapi/dto/usage/usage.py`)
- Usage mapping → Attribute state: sets inputs (evidence: `boaviztapi/dto/usage/usage.py`)
- Server model → Component models: assembles hardware (evidence: `boaviztapi/models/device/server.py`)
- Cloud instance model → Server model: models platform (evidence: `boaviztapi/models/services/cloud_instance.py`)
- Server API → Impact computation: computes impacts (evidence: `boaviztapi/routers/server_router.py`)
- Cloud API → Impact computation: computes impacts (evidence: `boaviztapi/routers/cloud_router.py`)
- Component API → Impact computation: computes impacts (evidence: `boaviztapi/routers/component_router.py`)
- Terminal API → Impact computation: computes impacts (evidence: `boaviztapi/routers/terminal_router.py`)
- Impact computation → Impact factors: reads factors (evidence: `boaviztapi/compute/impacts_computation.py`)
- Impact computation → Impact results: creates results (evidence: `boaviztapi/compute/impacts_computation.py`)
- Impact computation → Archetype lookup: loads archetypes (evidence: `boaviztapi/compute/impacts_computation.py`)
- Archetype lookup → Attribute state: supplies defaults
- Cloud API → Verbose output: formats detail (evidence: `boaviztapi/routers/cloud_router.py`)
- Server API → Verbose output: formats detail (evidence: `boaviztapi/routers/server_router.py`)
