# ichal-nameirakpam/nonlinear-toolkit architecture

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

- Interactive diagram: https://gitdiagram.com/ichal-nameirakpam/nonlinear-toolkit
- Repository: https://github.com/ichal-nameirakpam/nonlinear-toolkit

## Overview

nonlinear-toolkit is a Python library for generating canonical chaotic time series and characterizing them with information-theoretic and dynamical measures. The principal workflow is to generate a system’s output, compute permutation entropy and statistical complexity and/or estimate a Lyapunov exponent, then visualize results. Embedding is a shared internal technique: it reconstructs phase space for Lyapunov estimation and attractor plots, while automatic delay and dimension selection are also documented capabilities. The source excerpts support the main computational links; broader user workflows and some plotting relationships are documented in the README.

Main entry points: [`plots.py`](https://github.com/ichal-nameirakpam/nonlinear-toolkit/blob/main/plots.py) (Result plots), [`systems.py`](https://github.com/ichal-nameirakpam/nonlinear-toolkit/blob/main/systems.py) (Chaotic systems), [`lyapunov.py`](https://github.com/ichal-nameirakpam/nonlinear-toolkit/blob/main/lyapunov.py) (Lyapunov estimate), [`embedding.py`](https://github.com/ichal-nameirakpam/nonlinear-toolkit/blob/main/embedding.py) (Phase embedding)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_generation["System generation"]
  node_systems["Chaotic systems<br/>[systems.py]"]
end

subgraph group_analysis["Signal analysis"]
  node_embedding["Phase embedding<br/>[embedding.py]"]
  node_entropy["Entropy and complexity"]
  node_lyapunov["Lyapunov estimate<br/>[lyapunov.py]"]
end

subgraph group_visualization["Visualization"]
  node_plots["Result plots<br/>[plots.py]"]
end

node_user(("Analyst"))

node_user -->|"requests series"| node_systems
node_systems -->|"provides series"| node_entropy
node_systems -->|"provides series"| node_lyapunov
node_lyapunov -->|"reconstructs phase"| node_embedding
node_user -->|"requests visualization"| node_plots
node_plots -->|"embeds attractor"| node_embedding
node_plots -->|"computes boundaries"| node_entropy
node_lyapunov -->|"plots divergence"| node_plots
node_systems -->|"plots bifurcations"| node_plots

click node_systems "https://github.com/ichal-nameirakpam/nonlinear-toolkit/blob/main/systems.py"
click node_embedding "https://github.com/ichal-nameirakpam/nonlinear-toolkit/blob/main/embedding.py"
click node_entropy "https://github.com/ichal-nameirakpam/nonlinear-toolkit/blob/main/entropy_complexity.py"
click node_lyapunov "https://github.com/ichal-nameirakpam/nonlinear-toolkit/blob/main/lyapunov.py"
click node_plots "https://github.com/ichal-nameirakpam/nonlinear-toolkit/blob/main/plots.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_systems toneBlue
class node_embedding,node_entropy,node_lyapunov toneAmber
class node_plots toneMint
class node_user toneIndigo
```

## Components

### System generation

- [Chaotic systems](https://github.com/ichal-nameirakpam/nonlinear-toolkit/blob/main/systems.py): `systems.py`

### Signal analysis

- [Phase embedding](https://github.com/ichal-nameirakpam/nonlinear-toolkit/blob/main/embedding.py): `embedding.py`
- [Entropy and complexity](https://github.com/ichal-nameirakpam/nonlinear-toolkit/blob/main/entropy_complexity.py): `entropy_complexity.py`
- [Lyapunov estimate](https://github.com/ichal-nameirakpam/nonlinear-toolkit/blob/main/lyapunov.py): `lyapunov.py`

### Visualization

- [Result plots](https://github.com/ichal-nameirakpam/nonlinear-toolkit/blob/main/plots.py): `plots.py`

### Other components

- **Analyst**

## Connections

- Analyst → Chaotic systems: requests series (evidence: `README.md`)
- Chaotic systems → Entropy and complexity: provides series (evidence: `README.md`)
- Chaotic systems → Lyapunov estimate: provides series (evidence: `README.md`)
- Lyapunov estimate → Phase embedding: reconstructs phase (evidence: `lyapunov.py`)
- Analyst → Result plots: requests visualization (evidence: `README.md`)
- Result plots → Phase embedding: embeds attractor (evidence: `plots.py`)
- Result plots → Entropy and complexity: computes boundaries (evidence: `plots.py`)
- Lyapunov estimate → Result plots: plots divergence (evidence: `plots.py`)
- Chaotic systems → Result plots: plots bifurcations (evidence: `README.md`)
