Skip to content

Commit 0ff2582

Browse files
committed
docs(web): change web content and Welcome to Issues & PRs
In the 'Brain Region Map (Legacy Version)', an image of the human brain surface was missing. It has now been added. Modified some descriptions in `README.md` and webpage documentation. Clarified that Issues and PRs are welcome. docs(web): 更改网页上部分表述以及欢迎贡献 在“脑区图(旧版)”当中,少了一张人类大脑surface的图。 现已添加。 在`README.md`以及网页文档中修改部分表述。 说明愿意接受Issue以及PR。
1 parent 0d05ec1 commit 0ff2582

4 files changed

Lines changed: 68 additions & 45 deletions

File tree

README.md

Lines changed: 28 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -47,31 +47,17 @@ cd plotfig
4747
pip install .
4848
```
4949

50-
## 贡献指南
51-
52-
如果您希望参与 `plotfig` 的开发,或者想体验尚未正式发布的新功能和最新修复的 bug,可以选择以开发模式安装项目。
53-
54-
这种“可编辑模式(editable mode)”安装方式允许您对本地源码的修改立即生效,非常适合开发、调试和贡献代码。
55-
56-
推荐先 Fork 仓库,然后克隆您自己的 Fork:
57-
58-
```bash
59-
git clone -b dev https://github.com/<your-username>/plotfig.git
60-
cd plotfig
61-
pip install -e .
62-
```
63-
6450
## 依赖要求
6551

6652
`plotfig` 依赖若干核心库,这些依赖将在安装过程中自动处理:
6753

68-
- [matplotlib](https://matplotlib.org/) ≥ 3.10.1
69-
- [mne-connectivity](https://mne.tools/mne-connectivity/stable/index.html) ≥ 0.7.0
70-
- [nibabel](https://nipy.org/nibabel/) ≥ 5.3.2
71-
- [numpy](https://numpy.org/) ≥ 2.2.4
72-
- [pandas](https://pandas.pydata.org/) ≥ 2.2.3
73-
- [plotly](https://plotly.com/) ≥ 6.0.1
74-
- [scipy](https://scipy.org/) ≥ 1.15.2
54+
- [matplotlib](https://matplotlib.org/) ≥ 3.10.
55+
- [mne-connectivity](https://mne.tools/mne-connectivity/stable/index.html) ≥ 0.7.
56+
- [nibabel](https://nipy.org/nibabel/) ≥ 5.3.
57+
- [numpy](https://numpy.org/) ≥ 2.2.4
58+
- [pandas](https://pandas.pydata.org/) ≥ 2.2.
59+
- [plotly](https://plotly.com/) ≥ 6.0.1
60+
- [scipy](https://scipy.org/) ≥ 1.15.
7561
- [surfplot](https://github.com/danjgale/surfplot) 需使用其 GitHub 仓库中的最新版,而非 PyPI 上的版本,因后者尚未包含所需功能。
7662

7763
> ⚠️ **指定 `surfplot` 版本**
@@ -82,7 +68,7 @@ pip install -e .
8268
> # 卸载旧版本
8369
> pip uninstall surfplot
8470
>
85-
> # 克隆源码仓库并安装
71+
> # 克隆源码并安装
8672
> git clone --depth 1 https://github.com/danjgale/surfplot.git
8773
> cd surfplot
8874
> pip install .
@@ -91,3 +77,23 @@ pip install -e .
9177
> cd ..
9278
> rm -rf surfplot
9379
> ```
80+
81+
## 贡献指南
82+
83+
如果您希望参与 `plotfig` 的开发,或者想体验尚未正式发布的新功能和最新修复的 bug,可以选择以开发模式安装项目。
84+
85+
这种“可编辑模式(editable mode)”安装方式允许您对本地源码的修改立即生效,非常适合开发、调试和贡献代码。
86+
87+
推荐先 Fork 仓库,然后克隆您自己的 Fork:
88+
89+
```bash
90+
git clone -b dev https://github.com/<your-username>/plotfig.git
91+
cd plotfig
92+
pip install -e .
93+
```
94+
95+
**欢迎提交 Issue 或 PR!**
96+
97+
无论是 Bug 报告、功能建议,还是文档改进,都非常欢迎你的参与。
98+
如果你在使用过程中遇到了问题,或者有更好的想法,欢迎在 [Issue](https://github.com/RicardoRyn/plotfig/issues) 中提出。
99+
也可以直接提交 [PR](https://github.com/RicardoRyn/plotfig/pulls),一起变得更强 🙌!

docs/installation.md

Lines changed: 30 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
1+
# 安装
2+
13
## 普通安装
24

35
`plotfig` 支持通过 `pip` 或源码安装,要求 Python 3.11 及以上版本。
46

5-
67
**使用 pip 安装 <small>(推荐)</small>**
78

89
```bash
@@ -17,31 +18,17 @@ cd plotfig
1718
pip install .
1819
```
1920

20-
## 贡献指南
21-
22-
如果您希望参与 `plotfig` 的开发,或者想体验尚未正式发布的新功能和最新修复的 bug,可以选择以开发模式安装项目。
23-
24-
这种“可编辑模式(editable mode)”安装方式允许您对本地源码的修改立即生效,非常适合开发、调试和贡献代码。
25-
26-
推荐先 Fork 仓库,然后克隆您自己的 Fork:
27-
28-
```bash
29-
git clone -b dev https://github.com/<your-username>/plotfig.git
30-
cd plotfig
31-
pip install -e .
32-
```
33-
3421
## 依赖要求
3522

3623
`plotfig` 依赖若干核心库,这些依赖将在安装过程中自动处理:
3724

38-
- [matplotlib](https://matplotlib.org/) ≥ 3.10.1
39-
- [mne-connectivity](https://mne.tools/mne-connectivity/stable/index.html) ≥ 0.7.0
40-
- [nibabel](https://nipy.org/nibabel/) ≥ 5.3.2
41-
- [numpy](https://numpy.org/) ≥ 2.2.4
42-
- [pandas](https://pandas.pydata.org/) ≥ 2.2.3
43-
- [plotly](https://plotly.com/) ≥ 6.0.1
44-
- [scipy](https://scipy.org/) ≥ 1.15.2
25+
- [matplotlib](https://matplotlib.org/) ≥ 3.10.1
26+
- [mne-connectivity](https://mne.tools/mne-connectivity/stable/index.html) ≥ 0.7.0
27+
- [nibabel](https://nipy.org/nibabel/) ≥ 5.3.2
28+
- [numpy](https://numpy.org/) ≥ 2.2.4
29+
- [pandas](https://pandas.pydata.org/) ≥ 2.2.3
30+
- [plotly](https://plotly.com/) ≥ 6.0.1
31+
- [scipy](https://scipy.org/) ≥ 1.15.2
4532
- [surfplot](https://github.com/danjgale/surfplot) 需使用其 GitHub 仓库中的最新版,而非 PyPI 上的版本,因后者尚未包含所需功能。
4633

4734
!!! warning "指定 `surfplot` 版本"
@@ -52,7 +39,7 @@ pip install -e .
5239
# 卸载旧版本
5340
pip uninstall surfplot
5441

55-
# 克隆源码仓库并安装
42+
# 克隆源码并安装
5643
git clone --depth 1 https://github.com/danjgale/surfplot.git
5744
cd surfplot
5845
pip install .
@@ -61,3 +48,23 @@ pip install -e .
6148
cd ..
6249
rm -rf surfplot
6350
```
51+
52+
## 贡献指南
53+
54+
如果您希望参与 `plotfig` 的开发,或者想体验尚未正式发布的新功能和最新修复的 bug,可以选择以开发模式安装项目。
55+
56+
这种“可编辑模式(editable mode)”安装方式允许您对本地源码的修改立即生效,非常适合开发、调试和贡献代码。
57+
58+
推荐先 Fork 仓库,然后克隆您自己的 Fork:
59+
60+
```bash
61+
git clone -b dev https://github.com/<your-username>/plotfig.git
62+
cd plotfig
63+
pip install -e .
64+
```
65+
66+
**欢迎提交 Issue 或 PR!**
67+
68+
无论是 Bug 报告、功能建议,还是文档改进,都非常欢迎你的参与。
69+
如果你在使用过程中遇到了问题,或者有更好的想法,欢迎在 [Issue](https://github.com/RicardoRyn/plotfig/issues) 中提出。
70+
也可以直接提交 [PR](https://github.com/RicardoRyn/plotfig/pulls),一起变得更强 🙌!

docs/usage/brain_surface_deprecated.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,16 @@ data = {"lh_V1": 1, "rh_MT": 1.5}
6565
ax = plot_human_brain_figure(data)
6666
```
6767

68+
C:\Users\RicardoRyn\AppData\Local\Temp\ipykernel_32020\3935563387.py:5: DeprecationWarning: plot_human_brain_figure 即将弃用,请使用 plot_brain_surface_figure 替代。未来版本将移除本函数。
69+
ax = plot_human_brain_figure(data)
70+
71+
72+
73+
74+
![png](brain_surface_deprecated_files/brain_surface_deprecated_7_1.png)
75+
76+
77+
6878

6979
```python
7080
import matplotlib.pyplot as plt
-5.94 KB
Loading

0 commit comments

Comments
 (0)