# p2ms-optimization/pysne-web architecture

> Architecture diagram of the GitHub repository p2ms-optimization/pysne-web, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-09-28). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/p2ms-optimization/pysne-web
- Repository: https://github.com/p2ms-optimization/pysne-web

## Overview

PySNE Web is a documentation website for the PySNE nonlinear-equation solver, not the solver implementation itself. Its user journey is a visitor finding the project, learning how to get started and use it, then exploring examples, applications, and research; reference pages support deeper technical lookup. The tree and README establish these content areas and the MkDocs site, but do not show page-link wiring or the solver’s runtime, so those are not modeled.

Main entry points: [`docs/index.md`](https://github.com/p2ms-optimization/pysne-web/blob/main/docs/index.md) (Site home), [`docs/getting-started`](https://github.com/p2ms-optimization/pysne-web/tree/main/docs/getting-started) (Getting started), [`docs/documentation`](https://github.com/p2ms-optimization/pysne-web/tree/main/docs/documentation) (User documentation), [`docs/examples`](https://github.com/p2ms-optimization/pysne-web/tree/main/docs/examples) (Examples)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_entry["Site entry"]
  node_home["Site home<br/>[index.md]"]
end

subgraph group_learning["Guides and examples"]
  node_getting_started["Getting started"]
  node_user_docs["User documentation"]
  node_examples["Examples"]
  node_case_studies["Case studies"]
end

subgraph group_reference["Reference and research"]
  node_api["API reference<br/>[api-reference.md]"]
  node_algorithm_docs["Algorithms<br/>[algorithms.md]"]
  node_research["Research"]
end

node_visitor(("Visitor"))

node_visitor -->|"opens"| node_home
node_visitor -->|"browses"| node_getting_started
node_visitor -->|"browses"| node_user_docs
node_visitor -->|"browses"| node_examples
node_visitor -->|"browses"| node_case_studies
node_visitor -->|"consults"| node_api
node_visitor -->|"consults"| node_algorithm_docs
node_visitor -->|"browses"| node_research

click node_home "https://github.com/p2ms-optimization/pysne-web/blob/main/docs/index.md"
click node_getting_started "https://github.com/p2ms-optimization/pysne-web/tree/main/docs/getting-started"
click node_user_docs "https://github.com/p2ms-optimization/pysne-web/tree/main/docs/documentation"
click node_examples "https://github.com/p2ms-optimization/pysne-web/tree/main/docs/examples"
click node_case_studies "https://github.com/p2ms-optimization/pysne-web/tree/main/docs/case-studies"
click node_api "https://github.com/p2ms-optimization/pysne-web/blob/main/docs/documentation/api-reference.md"
click node_algorithm_docs "https://github.com/p2ms-optimization/pysne-web/blob/main/docs/documentation/algorithms.md"
click node_research "https://github.com/p2ms-optimization/pysne-web/tree/main/docs/research"

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_home toneBlue
class node_getting_started,node_user_docs,node_examples,node_case_studies toneAmber
class node_api,node_algorithm_docs,node_research toneMint
class node_visitor toneIndigo
```

## Components

### Site entry

- [Site home](https://github.com/p2ms-optimization/pysne-web/blob/main/docs/index.md): `docs/index.md`

### Guides and examples

- [Getting started](https://github.com/p2ms-optimization/pysne-web/tree/main/docs/getting-started): `docs/getting-started`
- [User documentation](https://github.com/p2ms-optimization/pysne-web/tree/main/docs/documentation): `docs/documentation`
- [Examples](https://github.com/p2ms-optimization/pysne-web/tree/main/docs/examples): `docs/examples`
- [Case studies](https://github.com/p2ms-optimization/pysne-web/tree/main/docs/case-studies): `docs/case-studies`

### Reference and research

- [API reference](https://github.com/p2ms-optimization/pysne-web/blob/main/docs/documentation/api-reference.md): `docs/documentation/api-reference.md`
- [Algorithms](https://github.com/p2ms-optimization/pysne-web/blob/main/docs/documentation/algorithms.md): `docs/documentation/algorithms.md`
- [Research](https://github.com/p2ms-optimization/pysne-web/tree/main/docs/research): `docs/research`

### Other components

- **Visitor**

## Connections

- Visitor → Site home: opens
- Visitor → Getting started: browses
- Visitor → User documentation: browses
- Visitor → Examples: browses
- Visitor → Case studies: browses
- Visitor → API reference: consults
- Visitor → Algorithms: consults
- Visitor → Research: browses