Skip to content

Commit 8798db6

Browse files
committed
docs: add Chinese README and update English README with bilingual links
1 parent e59a5b4 commit 8798db6

File tree

2 files changed

+87
-19
lines changed

2 files changed

+87
-19
lines changed

README.md

Lines changed: 22 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -2,60 +2,63 @@
22

33
# plotfig
44

5+
[English](README.md) | [中文文档](README_zh.md)
6+
57
[![PyPI version](https://badge.fury.io/py/plotfig.svg)](https://badge.fury.io/py/plotfig)
68
[![Python version](https://img.shields.io/badge/python-3.11+-blue.svg)](https://www.python.org/downloads/)
79
[![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)
810

9-
一个专为认知神经科学研究设计的 Python 可视化库,提供高效、易用且美观的绘图工具。
11+
A Python visualization library designed for cognitive neuroscience research, providing efficient, easy-to-use, and beautiful plotting tools.
1012

1113
![plotfig](./docs/assets/plotfig.png)
1214

1315
</div>
1416

15-
## 功能特性
17+
## Features
1618

17-
- 📊 **多种图表类型**:条形图、矩阵、相关性图、弦图、脑表面图、脑连接图
18-
- 🎨 **专业科研风格**:内置多种配色方案,符合学术发表标准
19-
- 📈 **自动显著性检验**:内置多种统计方法,自动绘制显著性标记
20-
- 🔬 **专为神经科学设计**:支持常见灵长类脑区 atlas、脑网络可视化等特定场景
21-
- 🚀 **简单易用**:简洁的 API,快速上手
19+
- 📊 **Multiple Chart Types**: Bar charts, matrix plots, correlation plots, circos plots, brain surface plots, brain connectivity plots
20+
- 🎨 **Professional Research Style**: Built-in color schemes that meet academic publication standards
21+
- 📈 **Automatic Significance Testing**: Built-in statistical methods with automatic significance annotations
22+
- 🔬 **Designed for Neuroscience**: Supports common primate brain atlases and brain network visualization
23+
- 🚀 **Easy to Use**: Simple API for quick getting started
2224

23-
## 快速开始
25+
## Quick Start
2426

2527
```python
2628
import matplotlib.pyplot as plt
2729

2830
from plotfig import plot_one_group_bar_figure
2931

30-
# 绘制单组条形图
32+
# Plot single group bar chart
3133
data = [[1.2, 2.3, 3.1], [4.5, 5.6, 6.2]]
3234
plot_one_group_bar_figure(data)
3335
plt.show()
3436
```
3537

36-
## 安装
38+
## Installation
3739

38-
`plotfig` 要求 Python 3.11 及以上版本。
40+
`plotfig` requires Python 3.11 or higher.
3941

40-
**使用 uv 安装:**
42+
**Install with uv:**
4143

42-
**使用 uv 安装:**
4344
```bash
4445
uv add plotfig
4546
```
4647

47-
**使用 pip 安装:**
48+
**Install with pip:**
4849

4950
```bash
5051
pip install plotfig
5152
```
5253

53-
## 文档
54+
For other installation methods, please see the [detailed installation guide](https://ricardoryn.github.io/plotfig/installation/).
55+
56+
## Documentation
5457

55-
详细文档和使用示例请访问 [plotfig 文档](https://ricardoryn.github.io/plotfig/)
58+
For detailed documentation and usage examples, please visit the [plotfig documentation](https://ricardoryn.github.io/plotfig/).
5659

57-
## 贡献
60+
## Contributing
5861

59-
欢迎提交 Issue 或 PR!无论是 Bug 报告、功能建议还是文档改进,都非常欢迎在 [Issue](https://github.com/RicardoRyn/plotfig/issues) 中提出。
62+
We welcome Issues and PRs! Whether it's bug reports, feature suggestions, or documentation improvements, please feel free to open an [Issue](https://github.com/RicardoRyn/plotfig/issues).
6063

61-
开发贡献流程请参见[贡献指南](https://ricardoryn.github.io/plotfig/)
64+
For contribution guidelines, please see the [contribution guide](https://ricardoryn.github.io/plotfig/).

README_zh.md

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
<div align="center">
2+
3+
# plotfig
4+
5+
[English](README.md) | [中文文档](README_zh.md)
6+
7+
[![PyPI version](https://badge.fury.io/py/plotfig.svg)](https://badge.fury.io/py/plotfig)
8+
[![Python version](https://img.shields.io/badge/python-3.11+-blue.svg)](https://www.python.org/downloads/)
9+
[![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)
10+
11+
一个专为认知神经科学研究设计的 Python 可视化库,提供高效、易用且美观的绘图工具。
12+
13+
![plotfig](./docs/assets/plotfig.png)
14+
15+
</div>
16+
17+
## 功能特性
18+
19+
- 📊 **多种图表类型**:条形图、矩阵、相关性图、弦图、脑表面图、脑连接图
20+
- 🎨 **专业科研风格**:内置多种配色方案,符合学术发表标准
21+
- 📈 **自动显著性检验**:内置多种统计方法,自动绘制显著性标记
22+
- 🔬 **专为神经科学设计**:支持常见灵长类脑区 atlas、脑网络可视化等特定场景
23+
- 🚀 **简单易用**:简洁的 API,快速上手
24+
25+
## 快速开始
26+
27+
```python
28+
import matplotlib.pyplot as plt
29+
30+
from plotfig import plot_one_group_bar_figure
31+
32+
# 绘制单组条形图
33+
data = [[1.2, 2.3, 3.1], [4.5, 5.6, 6.2]]
34+
plot_one_group_bar_figure(data)
35+
plt.show()
36+
```
37+
38+
## 安装
39+
40+
`plotfig` 要求 Python 3.11 及以上版本。
41+
42+
**使用 uv 安装:**
43+
44+
```bash
45+
uv add plotfig
46+
```
47+
48+
**使用 pip 安装:**
49+
50+
```bash
51+
pip install plotfig
52+
```
53+
54+
其他安装方式请参见[详细安装教程](https://ricardoryn.github.io/plotfig/installation/)
55+
56+
## 文档
57+
58+
详细文档和使用示例请访问 [plotfig 文档](https://ricardoryn.github.io/plotfig/)
59+
60+
## 贡献
61+
62+
欢迎提交 Issue 或 PR!无论是 Bug 报告、功能建议还是文档改进,都非常欢迎在 [Issue](https://github.com/RicardoRyn/plotfig/issues) 中提出。
63+
64+
开发贡献流程请参见[贡献指南](https://ricardoryn.github.io/plotfig/)
65+

0 commit comments

Comments
 (0)