# ecshackweek/impedance.py architecture

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

- Interactive diagram: https://gitdiagram.com/ecshackweek/impedance.py
- Repository: https://github.com/ecshackweek/impedance.py

## Overview

impedance.py is a Python toolkit for electrochemical impedance spectroscopy (EIS): users can load instrument data, validate spectra, fit equivalent-circuit models, and visualize results. Its source also provides circuit-element definitions and model APIs. The README documents these capabilities, but does not establish a mandatory processing sequence; user-to-capability links are therefore unverified. Sampled circuit code shows its calls into fitting, element, and plotting modules; preprocessing is a separate reader/filtering API.

Main entry points: [`impedance/models/circuits/circuits.py`](https://github.com/ecshackweek/impedance.py/blob/main/impedance/models/circuits/circuits.py) (Circuit models), [`impedance/validation.py`](https://github.com/ecshackweek/impedance.py/blob/main/impedance/validation.py) (Lin-KK validation), [`impedance/models/circuits/fitting.py`](https://github.com/ecshackweek/impedance.py/blob/main/impedance/models/circuits/fitting.py) (Circuit fitting), [`impedance/visualization.py`](https://github.com/ecshackweek/impedance.py/blob/main/impedance/visualization.py) (EIS plots)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_data["Data preparation"]
  node_readers["Instrument readers<br/>[preprocessing.py]"]
  node_filters["Data filtering<br/>[preprocessing.py]"]
end

subgraph group_analysis["EIS analysis"]
  node_validation["Lin-KK validation<br/>[validation.py]"]
  node_circuit_api["Circuit models<br/>[circuits.py]"]
  node_fitting["Circuit fitting<br/>[fitting.py]"]
  node_elements["Circuit elements<br/>[elements.py]"]
end

subgraph group_presentation["Results and visualization"]
  node_plots["EIS plots<br/>[visualization.py]"]
end

node_user(("EIS analyst"))
node_results["Analysis results"]

node_user -.->|"loads spectra"| node_readers
node_user -.->|"filters data"| node_filters
node_user -.->|"validates data"| node_validation
node_user -.->|"uses models"| node_circuit_api
node_user -.->|"visualizes data"| node_plots
node_circuit_api -->|"delegates fitting"| node_fitting
node_circuit_api -->|"looks up elements"| node_elements
node_circuit_api -->|"calls plotting"| node_plots
node_fitting -->|"evaluates elements"| node_elements
node_validation -->|"uses RMSE"| node_fitting
node_validation -->|"uses element model"| node_elements
node_circuit_api -.->|"returns predictions"| node_results
node_plots -.->|"renders figures"| node_results

click node_readers "https://github.com/ecshackweek/impedance.py/blob/main/impedance/preprocessing.py"
click node_filters "https://github.com/ecshackweek/impedance.py/blob/main/impedance/preprocessing.py"
click node_validation "https://github.com/ecshackweek/impedance.py/blob/main/impedance/validation.py"
click node_circuit_api "https://github.com/ecshackweek/impedance.py/blob/main/impedance/models/circuits/circuits.py"
click node_fitting "https://github.com/ecshackweek/impedance.py/blob/main/impedance/models/circuits/fitting.py"
click node_elements "https://github.com/ecshackweek/impedance.py/blob/main/impedance/models/circuits/elements.py"
click node_plots "https://github.com/ecshackweek/impedance.py/blob/main/impedance/visualization.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_readers,node_filters toneBlue
class node_validation,node_circuit_api,node_fitting,node_elements toneAmber
class node_plots toneMint
class node_user,node_results toneIndigo
```

## Components

### Data preparation

- [Instrument readers](https://github.com/ecshackweek/impedance.py/blob/main/impedance/preprocessing.py): `impedance/preprocessing.py`
- [Data filtering](https://github.com/ecshackweek/impedance.py/blob/main/impedance/preprocessing.py): `impedance/preprocessing.py`

### EIS analysis

- [Lin-KK validation](https://github.com/ecshackweek/impedance.py/blob/main/impedance/validation.py): `impedance/validation.py`
- [Circuit models](https://github.com/ecshackweek/impedance.py/blob/main/impedance/models/circuits/circuits.py): `impedance/models/circuits/circuits.py`
- [Circuit fitting](https://github.com/ecshackweek/impedance.py/blob/main/impedance/models/circuits/fitting.py): `impedance/models/circuits/fitting.py`
- [Circuit elements](https://github.com/ecshackweek/impedance.py/blob/main/impedance/models/circuits/elements.py): `impedance/models/circuits/elements.py`

### Results and visualization

- [EIS plots](https://github.com/ecshackweek/impedance.py/blob/main/impedance/visualization.py): `impedance/visualization.py`

### Other components

- **EIS analyst**
- **Analysis results**

## Connections

- EIS analyst → Instrument readers: loads spectra
- EIS analyst → Data filtering: filters data
- EIS analyst → Lin-KK validation: validates data
- EIS analyst → Circuit models: uses models
- EIS analyst → EIS plots: visualizes data
- Circuit models → Circuit fitting: delegates fitting (evidence: `impedance/models/circuits/circuits.py`)
- Circuit models → Circuit elements: looks up elements (evidence: `impedance/models/circuits/circuits.py`)
- Circuit models → EIS plots: calls plotting (evidence: `impedance/models/circuits/circuits.py`)
- Circuit fitting → Circuit elements: evaluates elements (evidence: `impedance/models/circuits/fitting.py`)
- Lin-KK validation → Circuit fitting: uses RMSE (evidence: `impedance/validation.py`)
- Lin-KK validation → Circuit elements: uses element model (evidence: `impedance/validation.py`)
- Circuit models → Analysis results: returns predictions
- EIS plots → Analysis results: renders figures
