# datawhalechina/intro-mathmodel architecture

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

- Interactive diagram: https://gitdiagram.com/datawhalechina/intro-mathmodel
- Repository: https://github.com/datawhalechina/intro-mathmodel

## Overview

1. **Repository role**
   - This repo is not an application backend; it is a **static course/documentation site** for “数学建模导论【🧪 Beta公测版】”.
   - Its main purpose is to publish a structured set of teaching chapters on math modeling, Python-based modeling techniques, and related data science methods.

2. **Top-level architecture**
   - The meaningful runtime boundary is the **`docs/` site root**.
   - `README.md` is the project landing page for GitHub and also describes the curriculum scope.
   - `docs/index.html`, `docs/_sidebar.md`, and `docs/.nojekyll` indicate the repo is designed for **static hosting on GitHub Pages**.

3. **Primary content layer**
   - The core content is organized into chapter folders under `docs/CH0` through `docs/CH10`.
   - Each chapter folder contains one main markdown article, e.g. chapter pages like:
     - `docs/CH1/第1章-解析几何与方程模型.md`
     - `docs/CH9/第九章-机器学习与统计模型.md`
   - This is the main source of truth for the book’s narrative and learning progression.

4. **Navigation and site shell**
   - `docs/_sidebar.md` is the site navigation layer that ties the chapter pages together.
   - `docs/index.html` acts as the front page / host shell for the documentation site.
   - The site is therefore built around a **sidebar-driven documentation layout**, not a code-driven app UI.

5. **Chapter-level boundaries**
   - The chapters are logically separated by modeling domain:
     - geometry and equations
     - differential equations and dynamical systems
     - optimization and planning
     - graph/network models
     - evolutionary and swarm algorithms
     - data processing and fitting
     - evaluation/weighting methods
     - time series and investment
     - machine learning and statistics
     - multimodal data and intelligent models
   - This separation is important for architecture diagrams because each chapter is an **independent content module** rather than a tightly coupled code package.

6. **Supplementary assets**
   - Several chapter folders include `attachments/`, `attachment/`, or `src/` subfolders.
   - These hold supporting materials such as figures, example data, code snippets, or source artifacts used in the chapter pages.
   - The content flow is: **chapter markdown references local assets** inside the same chapter directory.

7. **Mixed source formats**
   - Most chapter content is in Markdown, but some chapters also contain `.docx` files.
   - This suggests a documentation workflow where Word drafts or editorial source material coexist with Markdown publication files.
   - For architecture, treat `.docx` as **authoring/support artifacts**, not primary runtime content.

8. **Publication/deployment model**
   - The presence of `.nojekyll` strongly suggests the docs are published as a **static site without Jekyll processing**.
   - The likely deployment target is **GitHub Pages**, as hinted by the project URL in the README.
   - There is no evidence of a server-side application, database, or API layer.

9. **Technology footprint**
   - The repo is documentation-first, but the subject matter references Python tooling throughout the course, including NumPy, SciPy, SymPy, Pandas, Matplotlib, NetworkX, cvxpy, scikit-learn, and PyTorch.
   - These libraries are part of the course content/examples, not necessarily runtime dependencies of the site itself.
   - The site layer itself is mostly static HTML + Markdown.

10. **Content flow**
   - Authoring likely happens in chapter markdown and supporting files inside each `CH*` folder.
   - The chapter pages are linked through the sidebar and rendered by the static site shell.
   - Readers interact only with the published documentation site; there is no interactive backend data flow.

11. **Repository boundary to note in a diagram**
   - Everything under `docs/` belongs to the **publishable documentation system**.
   - `README.md` is the repo-level introduction and contribution entry point.
   - External services are limited to **GitHub hosting/pages** and the project website; no other infrastructure is implied by the file tree.

12. **How to diagram it**
   - Draw one large boundary for the repo.
   - Inside it, show a **static docs site** with:
     - site shell/navigation (`index.html`, `_sidebar.md`)
     - chapter content modules (`CH0`–`CH10`)
     - chapter assets/source artifacts (`attachments`, `src`, `.docx`)
   - Then show publication to a static hosting target, with readers consuming the rendered documentation.

Main entry points: [`docs/_sidebar.md`](https://github.com/datawhalechina/intro-mathmodel/blob/main/docs/_sidebar.md) (Sidebar), [`docs/index.html`](https://github.com/datawhalechina/intro-mathmodel/blob/main/docs/index.html) (Home page), [`docs/CH1/第1章-解析方法与几何模型.md`](https://github.com/datawhalechina/intro-mathmodel/blob/main/docs/CH1/第1章-解析方法与几何模型.md) (解析几何), [`docs/CH2/第2章-微分方程与动力系统.md`](https://github.com/datawhalechina/intro-mathmodel/blob/main/docs/CH2/第2章-微分方程与动力系统.md) (微分方程)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_repo["Repository"]
  node_readme["README<br/>landing page<br/>[README.md]"]
end

subgraph group_site["Static site"]
  node_docs_readme["Docs README<br/>site intro<br/>[README.md]"]
  node_docs_index["Home page<br/>site shell<br/>[index.html]"]
  node_docs_sidebar["Sidebar<br/>navigation<br/>[_sidebar.md]"]
  node_docs_nojekyll["No Jekyll<br/>publish flag<br/>[.nojekyll]"]
end

subgraph group_content["Chapter content"]
  node_ch0["绪论<br/>chapter<br/>[绪论-走进数学建模的大门.md]"]
  node_ch1["解析几何<br/>chapter<br/>[第1章-解析方法与几何模型.md]"]
  node_ch2["微分方程<br/>chapter<br/>[第2章-微分方程与动力系统.md]"]
  node_ch3["规划模型<br/>chapter<br/>[第三章-函数极值与规划模型.md]"]
  node_ch4["图论网络<br/>chapter"]
  node_ch5["进化计算<br/>chapter<br/>[第五章-进化计算与群体智能.md]"]
  node_ch6["数据拟合<br/>chapter<br/>[第六章-数据处理与拟合模型.md]"]
  node_ch7["评价模型<br/>chapter<br/>[第7章-权重生成与评价模型.md]"]
  node_ch8["时间序列<br/>chapter<br/>[第8章-时间序列.md]"]
  node_ch9["机器学习<br/>chapter<br/>[第九章-机器学习与统计模型.md]"]
  node_ch10["多模态数据<br/>chapter<br/>[第10章-图像、文本与信号数据.md]"]
  node_assets[("Chapter assets<br/>support files")]
  node_sources["Authoring sources<br/>draft artifacts<br/>[第7章-评价类模型.docx]"]
end

subgraph group_publish["Hosting"]
  node_pages(("GitHub Pages<br/>static host"))
  node_reader(("Readers<br/>consumer"))
end

node_readme -->|"describes"| node_docs_readme
node_docs_readme -->|"points to"| node_docs_index
node_docs_index -->|"uses"| node_docs_sidebar
node_docs_sidebar -->|"links"| node_ch0
node_docs_sidebar -->|"links"| node_ch1
node_docs_sidebar -->|"links"| node_ch2
node_docs_sidebar -->|"links"| node_ch3
node_docs_sidebar -->|"links"| node_ch4
node_docs_sidebar -->|"links"| node_ch5
node_docs_sidebar -->|"links"| node_ch6
node_docs_sidebar -->|"links"| node_ch7
node_docs_sidebar -->|"links"| node_ch8
node_docs_sidebar -->|"links"| node_ch9
node_docs_sidebar -->|"links"| node_ch10
node_ch1 -->|"references"| node_assets
node_ch2 -->|"references"| node_assets
node_ch6 -->|"references"| node_assets
node_ch7 -->|"includes"| node_sources
node_ch8 -->|"includes"| node_sources
node_ch9 -->|"includes"| node_sources
node_docs_nojekyll -->|"enables"| node_pages
node_docs_index -->|"publishes to"| node_pages
node_pages -->|"serves"| node_reader
node_ch0 -.->|"consumed by"| node_reader
node_ch1 -.->|"consumed by"| node_reader
node_ch2 -.->|"consumed by"| node_reader
node_ch3 -.->|"consumed by"| node_reader
node_ch4 -.->|"consumed by"| node_reader
node_ch5 -.->|"consumed by"| node_reader
node_ch6 -.->|"consumed by"| node_reader
node_ch7 -.->|"consumed by"| node_reader
node_ch8 -.->|"consumed by"| node_reader
node_ch9 -.->|"consumed by"| node_reader
node_ch10 -.->|"consumed by"| node_reader

click node_readme "https://github.com/datawhalechina/intro-mathmodel/blob/main/README.md"
click node_docs_readme "https://github.com/datawhalechina/intro-mathmodel/blob/main/docs/README.md"
click node_docs_index "https://github.com/datawhalechina/intro-mathmodel/blob/main/docs/index.html"
click node_docs_sidebar "https://github.com/datawhalechina/intro-mathmodel/blob/main/docs/_sidebar.md"
click node_docs_nojekyll "https://github.com/datawhalechina/intro-mathmodel/blob/main/docs/.nojekyll"
click node_ch0 "https://github.com/datawhalechina/intro-mathmodel/blob/main/docs/CH0/绪论-走进数学建模的大门.md"
click node_ch1 "https://github.com/datawhalechina/intro-mathmodel/blob/main/docs/CH1/第1章-解析方法与几何模型.md"
click node_ch2 "https://github.com/datawhalechina/intro-mathmodel/blob/main/docs/CH2/第2章-微分方程与动力系统.md"
click node_ch3 "https://github.com/datawhalechina/intro-mathmodel/blob/main/docs/CH3/第三章-函数极值与规划模型.md"
click node_ch5 "https://github.com/datawhalechina/intro-mathmodel/blob/main/docs/CH5/第五章-进化计算与群体智能.md"
click node_ch6 "https://github.com/datawhalechina/intro-mathmodel/blob/main/docs/CH6/第六章-数据处理与拟合模型.md"
click node_ch7 "https://github.com/datawhalechina/intro-mathmodel/blob/main/docs/CH7/第7章-权重生成与评价模型.md"
click node_ch8 "https://github.com/datawhalechina/intro-mathmodel/blob/main/docs/CH8/第8章-时间序列.md"
click node_ch9 "https://github.com/datawhalechina/intro-mathmodel/blob/main/docs/CH9/第九章-机器学习与统计模型.md"
click node_ch10 "https://github.com/datawhalechina/intro-mathmodel/blob/main/docs/CH10/第10章-图像、文本与信号数据.md"
click node_assets "https://github.com/datawhalechina/intro-mathmodel/tree/main/docs/CH1/attachments"
click node_sources "https://github.com/datawhalechina/intro-mathmodel/blob/main/docs/CH7/第7章-评价类模型.docx"

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_readme toneBlue
class node_docs_readme,node_docs_index,node_docs_sidebar,node_docs_nojekyll toneAmber
class node_ch0,node_ch1,node_ch2,node_ch3,node_ch4,node_ch5,node_ch6,node_ch7,node_ch8,node_ch9,node_ch10,node_assets,node_sources toneMint
class node_pages,node_reader toneRose
```

## Components

### Repository

Project landing and source materials

- [README](https://github.com/datawhalechina/intro-mathmodel/blob/main/README.md): landing page · Repo-level introduction and course overview · `README.md`

### Static site

Publishable documentation shell under docs/

- [Docs README](https://github.com/datawhalechina/intro-mathmodel/blob/main/docs/README.md): site intro · Landing page for the documentation subtree · `docs/README.md`
- [Home page](https://github.com/datawhalechina/intro-mathmodel/blob/main/docs/index.html): site shell · Static docs front page · `docs/index.html`
- [Sidebar](https://github.com/datawhalechina/intro-mathmodel/blob/main/docs/_sidebar.md): navigation · Chapter navigation for the site · `docs/_sidebar.md`
- [No Jekyll](https://github.com/datawhalechina/intro-mathmodel/blob/main/docs/.nojekyll): publish flag · Disables Jekyll processing for static hosting · `docs/.nojekyll`

### Chapter content

Course chapters and supporting assets

- [绪论](https://github.com/datawhalechina/intro-mathmodel/blob/main/docs/CH0/绪论-走进数学建模的大门.md): chapter · Introductory modeling overview · `docs/CH0/绪论-走进数学建模的大门.md`
- [解析几何](https://github.com/datawhalechina/intro-mathmodel/blob/main/docs/CH1/第1章-解析方法与几何模型.md): chapter · Analytic methods and geometry models · `docs/CH1/第1章-解析方法与几何模型.md`
- [微分方程](https://github.com/datawhalechina/intro-mathmodel/blob/main/docs/CH2/第2章-微分方程与动力系统.md): chapter · Differential equations and dynamical systems · `docs/CH2/第2章-微分方程与动力系统.md`
- [规划模型](https://github.com/datawhalechina/intro-mathmodel/blob/main/docs/CH3/第三章-函数极值与规划模型.md): chapter · Extremum and optimization models · `docs/CH3/第三章-函数极值与规划模型.md`
- **图论网络**: chapter · Complex networks and graph models
- [进化计算](https://github.com/datawhalechina/intro-mathmodel/blob/main/docs/CH5/第五章-进化计算与群体智能.md): chapter · Evolutionary computation and swarm intelligence · `docs/CH5/第五章-进化计算与群体智能.md`
- [数据拟合](https://github.com/datawhalechina/intro-mathmodel/blob/main/docs/CH6/第六章-数据处理与拟合模型.md): chapter · Data processing and curve fitting · `docs/CH6/第六章-数据处理与拟合模型.md`
- [评价模型](https://github.com/datawhalechina/intro-mathmodel/blob/main/docs/CH7/第7章-权重生成与评价模型.md): chapter · Weighting and evaluation methods · `docs/CH7/第7章-权重生成与评价模型.md`
- [时间序列](https://github.com/datawhalechina/intro-mathmodel/blob/main/docs/CH8/第8章-时间序列.md): chapter · Time series and investment models · `docs/CH8/第8章-时间序列.md`
- [机器学习](https://github.com/datawhalechina/intro-mathmodel/blob/main/docs/CH9/第九章-机器学习与统计模型.md): chapter · Machine learning and statistics · `docs/CH9/第九章-机器学习与统计模型.md`
- [多模态数据](https://github.com/datawhalechina/intro-mathmodel/blob/main/docs/CH10/第10章-图像、文本与信号数据.md): chapter · Image, text, and signal data modeling · `docs/CH10/第10章-图像、文本与信号数据.md`
- [Chapter assets](https://github.com/datawhalechina/intro-mathmodel/tree/main/docs/CH1/attachments): support files · Figures, data, and embedded chapter resources · `docs/CH1/attachments`
- [Authoring sources](https://github.com/datawhalechina/intro-mathmodel/blob/main/docs/CH7/第7章-评价类模型.docx): draft artifacts · Word drafts and source artifacts mixed with markdown publications · `docs/CH7/第7章-评价类模型.docx`

### Hosting

Static publication target

- **GitHub Pages**: static host · Static publication target for the docs site
- **Readers**: consumer · Users consuming the rendered course site

## Connections

- README → Docs README: describes · Repository landing page introduces the docs site
- Docs README → Home page: points to · Docs landing content leads into the site shell
- Home page → Sidebar: uses · Front page relies on sidebar-driven navigation
- Sidebar → 绪论: links · Navigation connects the chapter sequence
- Sidebar → 解析几何: links · Navigation connects the chapter sequence
- Sidebar → 微分方程: links · Navigation connects the chapter sequence
- Sidebar → 规划模型: links · Navigation connects the chapter sequence
- Sidebar → 图论网络: links · Navigation connects the chapter sequence
- Sidebar → 进化计算: links · Navigation connects the chapter sequence
- Sidebar → 数据拟合: links · Navigation connects the chapter sequence
- Sidebar → 评价模型: links · Navigation connects the chapter sequence
- Sidebar → 时间序列: links · Navigation connects the chapter sequence
- Sidebar → 机器学习: links · Navigation connects the chapter sequence
- Sidebar → 多模态数据: links · Navigation connects the chapter sequence
- 解析几何 → Chapter assets: references · Chapter pages pull in local supporting material
- 微分方程 → Chapter assets: references · Chapter pages pull in local supporting material
- 数据拟合 → Chapter assets: references · Chapter pages pull in local supporting material
- 评价模型 → Authoring sources: includes · Markdown and Word drafts coexist in chapter folders
- 时间序列 → Authoring sources: includes · Markdown and Word drafts coexist in chapter folders
- 机器学习 → Authoring sources: includes · Markdown and Word drafts coexist in chapter folders
- No Jekyll → GitHub Pages: enables · Static hosting without Jekyll transforms
- Home page → GitHub Pages: publishes to · Rendered documentation is deployed to static hosting
- GitHub Pages → Readers: serves · Readers access the published documentation site
- 绪论 → Readers: consumed by · Course content is read through the published site
- 解析几何 → Readers: consumed by · Course content is read through the published site
- 微分方程 → Readers: consumed by · Course content is read through the published site
- 规划模型 → Readers: consumed by · Course content is read through the published site
- 图论网络 → Readers: consumed by · Course content is read through the published site
- 进化计算 → Readers: consumed by · Course content is read through the published site
- 数据拟合 → Readers: consumed by · Course content is read through the published site
- 评价模型 → Readers: consumed by · Course content is read through the published site
- 时间序列 → Readers: consumed by · Course content is read through the published site
- 机器学习 → Readers: consumed by · Course content is read through the published site
- 多模态数据 → Readers: consumed by · Course content is read through the published site
