# midetechnology/endaq-python architecture

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

- Interactive diagram: https://gitdiagram.com/midetechnology/endaq-python
- Repository: https://github.com/midetechnology/endaq-python

## Overview

endaq-python is a Python API for importing enDAQ IDE recordings, inspecting sensor measurements, analyzing vibration data, interacting with enDAQ Cloud, and visualizing results. A typical workflow starts with a user loading or selecting recording data, then applying calculations or batch analysis and optionally producing plots or dashboards. Cloud access is a distinct branch for listing, downloading, and managing cloud files. The graph preserves the major documented package capabilities and central modules; some internal links rely on SOURCE INDEX references, so unsampled behavior is not inferred beyond those references.

Main entry points: [`endaq/calc/stats.py`](https://github.com/midetechnology/endaq-python/blob/main/endaq/calc/stats.py) (Vibration metrics), [`endaq/batch/analyzer.py`](https://github.com/midetechnology/endaq-python/blob/main/endaq/batch/analyzer.py) (Recording analyzer), [`endaq/batch/core.py`](https://github.com/midetechnology/endaq-python/blob/main/endaq/batch/core.py) (Batch workflows), [`endaq/calc/psd.py`](https://github.com/midetechnology/endaq-python/blob/main/endaq/calc/psd.py) (Spectral analysis)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_recordings["IDE recordings"]
  node_ide_files["File access<br/>[files.py]"]
  node_ide_info["Recording inspection<br/>[info.py]"]
  node_measurement["Measurement types<br/>[measurement.py]"]
end

subgraph group_cloud["Cloud access"]
  node_cloud_client["Cloud client<br/>[core.py]"]
  node_cloud_api["Cloud API wrapper<br/>[API_wrapper.py]"]
  node_cloud_service["enDAQ Cloud"]
  node_cloud_scripting["Cloud scripting<br/>[scripting.py]"]
end

subgraph group_analysis["Signal analysis"]
  node_fft["FFT analysis<br/>[fft.py]"]
  node_filters["Signal filtering<br/>[filters.py]"]
  node_integration["Integration<br/>[integrate.py]"]
  node_psd["Spectral analysis<br/>[psd.py]"]
  node_shock["Shock analysis<br/>[shock.py]"]
  node_stats["Vibration metrics<br/>[stats.py]"]
end

subgraph group_batch["Batch processing"]
  node_batch_analyzer["Recording analyzer<br/>[analyzer.py]"]
  node_batch_core["Batch workflows<br/>[core.py]"]
end

subgraph group_visuals["Visualization"]
  node_plot_functions["Analysis plots<br/>[plots.py]"]
  node_dashboards["Dashboards<br/>[dashboards.py]"]
  node_plot_utilities["Plot utilities<br/>[utilities.py]"]
  node_tsne["t-SNE plots<br/>[t_sne.py]"]
end

node_user(("Python user"))

node_user -->|"loads recordings"| node_ide_files
node_user -->|"accesses cloud"| node_cloud_client
node_user -->|"runs batch analysis"| node_batch_core
node_user -->|"computes metrics"| node_stats
node_user -->|"creates plots"| node_plot_functions
node_ide_info -->|"uses file access"| node_ide_files
node_ide_info -->|"uses measurement types"| node_measurement
node_cloud_client -->|"sends API requests"| node_cloud_service
node_cloud_client -->|"loads downloaded files"| node_ide_files
node_cloud_scripting -->|"uses cloud client"| node_cloud_client
node_batch_core -->|"uses analyzer"| node_batch_analyzer
node_batch_core -->|"uses metrics"| node_stats
node_batch_core -->|"uses spectral analysis"| node_psd
node_batch_core -->|"uses IDE API"| node_ide_info
node_batch_core -->|"uses plot utilities"| node_plot_utilities
node_batch_analyzer -->|"uses spectral analysis"| node_psd
node_batch_analyzer -->|"uses metrics"| node_stats
node_batch_analyzer -->|"uses shock analysis"| node_shock
node_batch_analyzer -->|"uses integration"| node_integration
node_batch_analyzer -->|"uses filters"| node_filters
node_psd -->|"uses FFT helpers"| node_fft
node_integration -->|"uses filters"| node_filters
node_shock -->|"uses statistics"| node_stats
node_stats -->|"uses filters"| node_filters
node_stats -->|"uses integration"| node_integration
node_stats -->|"uses shock analysis"| node_shock
node_stats -->|"uses spectral analysis"| node_psd
node_plot_functions -->|"uses spectral analysis"| node_psd
node_plot_functions -->|"uses plot utilities"| node_plot_utilities
node_plot_functions -->|"uses dashboard helpers"| node_dashboards
node_dashboards -->|"uses plot utilities"| node_plot_utilities
node_dashboards -->|"uses IDE API"| node_ide_info
node_cloud_api -.->|"wraps cloud requests"| node_cloud_service

click node_ide_files "https://github.com/midetechnology/endaq-python/blob/main/endaq/ide/files.py"
click node_ide_info "https://github.com/midetechnology/endaq-python/blob/main/endaq/ide/info.py"
click node_measurement "https://github.com/midetechnology/endaq-python/blob/main/endaq/ide/measurement.py"
click node_cloud_client "https://github.com/midetechnology/endaq-python/blob/main/endaq/cloud/core.py"
click node_cloud_api "https://github.com/midetechnology/endaq-python/blob/main/endaq/cloud/API_wrapper.py"
click node_cloud_scripting "https://github.com/midetechnology/endaq-python/blob/main/endaq/cloud/scripting.py"
click node_fft "https://github.com/midetechnology/endaq-python/blob/main/endaq/calc/fft.py"
click node_filters "https://github.com/midetechnology/endaq-python/blob/main/endaq/calc/filters.py"
click node_integration "https://github.com/midetechnology/endaq-python/blob/main/endaq/calc/integrate.py"
click node_psd "https://github.com/midetechnology/endaq-python/blob/main/endaq/calc/psd.py"
click node_shock "https://github.com/midetechnology/endaq-python/blob/main/endaq/calc/shock.py"
click node_stats "https://github.com/midetechnology/endaq-python/blob/main/endaq/calc/stats.py"
click node_batch_analyzer "https://github.com/midetechnology/endaq-python/blob/main/endaq/batch/analyzer.py"
click node_batch_core "https://github.com/midetechnology/endaq-python/blob/main/endaq/batch/core.py"
click node_plot_functions "https://github.com/midetechnology/endaq-python/blob/main/endaq/plot/plots.py"
click node_dashboards "https://github.com/midetechnology/endaq-python/blob/main/endaq/plot/dashboards.py"
click node_plot_utilities "https://github.com/midetechnology/endaq-python/blob/main/endaq/plot/utilities.py"
click node_tsne "https://github.com/midetechnology/endaq-python/blob/main/endaq/plot/t_sne.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_ide_files,node_ide_info,node_measurement,node_user toneBlue
class node_cloud_client,node_cloud_api,node_cloud_service,node_cloud_scripting toneAmber
class node_fft,node_filters,node_integration,node_psd,node_shock,node_stats toneMint
class node_batch_analyzer,node_batch_core toneRose
class node_plot_functions,node_dashboards,node_plot_utilities,node_tsne toneIndigo
```

## Components

### IDE recordings

- [File access](https://github.com/midetechnology/endaq-python/blob/main/endaq/ide/files.py): `endaq/ide/files.py`
- [Recording inspection](https://github.com/midetechnology/endaq-python/blob/main/endaq/ide/info.py): `endaq/ide/info.py`
- [Measurement types](https://github.com/midetechnology/endaq-python/blob/main/endaq/ide/measurement.py): `endaq/ide/measurement.py`

### Cloud access

- [Cloud client](https://github.com/midetechnology/endaq-python/blob/main/endaq/cloud/core.py): `endaq/cloud/core.py`
- [Cloud API wrapper](https://github.com/midetechnology/endaq-python/blob/main/endaq/cloud/API_wrapper.py): `endaq/cloud/API_wrapper.py`
- **enDAQ Cloud**
- [Cloud scripting](https://github.com/midetechnology/endaq-python/blob/main/endaq/cloud/scripting.py): `endaq/cloud/scripting.py`

### Signal analysis

- [FFT analysis](https://github.com/midetechnology/endaq-python/blob/main/endaq/calc/fft.py): `endaq/calc/fft.py`
- [Signal filtering](https://github.com/midetechnology/endaq-python/blob/main/endaq/calc/filters.py): `endaq/calc/filters.py`
- [Integration](https://github.com/midetechnology/endaq-python/blob/main/endaq/calc/integrate.py): `endaq/calc/integrate.py`
- [Spectral analysis](https://github.com/midetechnology/endaq-python/blob/main/endaq/calc/psd.py): `endaq/calc/psd.py`
- [Shock analysis](https://github.com/midetechnology/endaq-python/blob/main/endaq/calc/shock.py): `endaq/calc/shock.py`
- [Vibration metrics](https://github.com/midetechnology/endaq-python/blob/main/endaq/calc/stats.py): `endaq/calc/stats.py`

### Batch processing

- [Recording analyzer](https://github.com/midetechnology/endaq-python/blob/main/endaq/batch/analyzer.py): `endaq/batch/analyzer.py`
- [Batch workflows](https://github.com/midetechnology/endaq-python/blob/main/endaq/batch/core.py): `endaq/batch/core.py`

### Visualization

- [Analysis plots](https://github.com/midetechnology/endaq-python/blob/main/endaq/plot/plots.py): `endaq/plot/plots.py`
- [Dashboards](https://github.com/midetechnology/endaq-python/blob/main/endaq/plot/dashboards.py): `endaq/plot/dashboards.py`
- [Plot utilities](https://github.com/midetechnology/endaq-python/blob/main/endaq/plot/utilities.py): `endaq/plot/utilities.py`
- [t-SNE plots](https://github.com/midetechnology/endaq-python/blob/main/endaq/plot/t_sne.py): `endaq/plot/t_sne.py`

### Other components

- **Python user**

## Connections

- Python user → File access: loads recordings (evidence: `README.md`)
- Python user → Cloud client: accesses cloud (evidence: `README.md`)
- Python user → Batch workflows: runs batch analysis (evidence: `README.md`)
- Python user → Vibration metrics: computes metrics (evidence: `README.md`)
- Python user → Analysis plots: creates plots (evidence: `README.md`)
- Recording inspection → File access: uses file access (evidence: `endaq/ide/info.py`)
- Recording inspection → Measurement types: uses measurement types (evidence: `endaq/ide/info.py`)
- Cloud client → enDAQ Cloud: sends API requests (evidence: `endaq/cloud/core.py`)
- Cloud client → File access: loads downloaded files (evidence: `endaq/cloud/core.py`)
- Cloud scripting → Cloud client: uses cloud client (evidence: `endaq/cloud/scripting.py`)
- Batch workflows → Recording analyzer: uses analyzer (evidence: `endaq/batch/core.py`)
- Batch workflows → Vibration metrics: uses metrics (evidence: `endaq/batch/core.py`)
- Batch workflows → Spectral analysis: uses spectral analysis (evidence: `endaq/batch/core.py`)
- Batch workflows → Recording inspection: uses IDE API (evidence: `endaq/batch/core.py`)
- Batch workflows → Plot utilities: uses plot utilities (evidence: `endaq/batch/core.py`)
- Recording analyzer → Spectral analysis: uses spectral analysis (evidence: `endaq/batch/analyzer.py`)
- Recording analyzer → Vibration metrics: uses metrics (evidence: `endaq/batch/analyzer.py`)
- Recording analyzer → Shock analysis: uses shock analysis (evidence: `endaq/batch/analyzer.py`)
- Recording analyzer → Integration: uses integration (evidence: `endaq/batch/analyzer.py`)
- Recording analyzer → Signal filtering: uses filters (evidence: `endaq/batch/analyzer.py`)
- Spectral analysis → FFT analysis: uses FFT helpers (evidence: `endaq/calc/fft.py`)
- Integration → Signal filtering: uses filters (evidence: `endaq/calc/integrate.py`)
- Shock analysis → Vibration metrics: uses statistics (evidence: `endaq/calc/shock.py`)
- Vibration metrics → Signal filtering: uses filters (evidence: `endaq/calc/stats.py`)
- Vibration metrics → Integration: uses integration (evidence: `endaq/calc/stats.py`)
- Vibration metrics → Shock analysis: uses shock analysis (evidence: `endaq/calc/stats.py`)
- Vibration metrics → Spectral analysis: uses spectral analysis (evidence: `endaq/calc/stats.py`)
- Analysis plots → Spectral analysis: uses spectral analysis (evidence: `endaq/plot/plots.py`)
- Analysis plots → Plot utilities: uses plot utilities (evidence: `endaq/plot/plots.py`)
- Analysis plots → Dashboards: uses dashboard helpers (evidence: `endaq/plot/plots.py`)
- Dashboards → Plot utilities: uses plot utilities (evidence: `endaq/plot/dashboards.py`)
- Dashboards → Recording inspection: uses IDE API (evidence: `endaq/plot/dashboards.py`)
- Cloud API wrapper → enDAQ Cloud: wraps cloud requests
