|
2 | 2 |
|
3 | 3 | # plotfig |
4 | 4 |
|
| 5 | +[English](README.md) | [中文文档](README_zh.md) |
| 6 | + |
5 | 7 | [](https://badge.fury.io/py/plotfig) |
6 | 8 | [](https://www.python.org/downloads/) |
7 | 9 | [](LICENSE) |
8 | 10 |
|
9 | | -一个专为认知神经科学研究设计的 Python 可视化库,提供高效、易用且美观的绘图工具。 |
| 11 | +A Python visualization library designed for cognitive neuroscience research, providing efficient, easy-to-use, and beautiful plotting tools. |
10 | 12 |
|
11 | 13 |  |
12 | 14 |
|
13 | 15 | </div> |
14 | 16 |
|
15 | | -## 功能特性 |
| 17 | +## Features |
16 | 18 |
|
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 |
22 | 24 |
|
23 | | -## 快速开始 |
| 25 | +## Quick Start |
24 | 26 |
|
25 | 27 | ```python |
26 | 28 | import matplotlib.pyplot as plt |
27 | 29 |
|
28 | 30 | from plotfig import plot_one_group_bar_figure |
29 | 31 |
|
30 | | -# 绘制单组条形图 |
| 32 | +# Plot single group bar chart |
31 | 33 | data = [[1.2, 2.3, 3.1], [4.5, 5.6, 6.2]] |
32 | 34 | plot_one_group_bar_figure(data) |
33 | 35 | plt.show() |
34 | 36 | ``` |
35 | 37 |
|
36 | | -## 安装 |
| 38 | +## Installation |
37 | 39 |
|
38 | | -`plotfig` 要求 Python 3.11 及以上版本。 |
| 40 | +`plotfig` requires Python 3.11 or higher. |
39 | 41 |
|
40 | | -**使用 uv 安装:** |
| 42 | +**Install with uv:** |
41 | 43 |
|
42 | | -**使用 uv 安装:** |
43 | 44 | ```bash |
44 | 45 | uv add plotfig |
45 | 46 | ``` |
46 | 47 |
|
47 | | -**使用 pip 安装:** |
| 48 | +**Install with pip:** |
48 | 49 |
|
49 | 50 | ```bash |
50 | 51 | pip install plotfig |
51 | 52 | ``` |
52 | 53 |
|
53 | | -## 文档 |
| 54 | +For other installation methods, please see the [detailed installation guide](https://ricardoryn.github.io/plotfig/installation/). |
| 55 | + |
| 56 | +## Documentation |
54 | 57 |
|
55 | | -详细文档和使用示例请访问 [plotfig 文档](https://ricardoryn.github.io/plotfig/)。 |
| 58 | +For detailed documentation and usage examples, please visit the [plotfig documentation](https://ricardoryn.github.io/plotfig/). |
56 | 59 |
|
57 | | -## 贡献 |
| 60 | +## Contributing |
58 | 61 |
|
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). |
60 | 63 |
|
61 | | -开发贡献流程请参见[贡献指南](https://ricardoryn.github.io/plotfig/)。 |
| 64 | +For contribution guidelines, please see the [contribution guide](https://ricardoryn.github.io/plotfig/). |
0 commit comments