plotfig 1.17.0__tar.gz → 1.18.1__tar.gz

{plotfig-1.17.0 → plotfig-1.18.1}/.github/workflows/docs.yml

@@ -15,15 +15,17 @@ jobs:
       url: ${{ steps.deployment.outputs.page_url }}
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/configure-pages@v5
-      - uses: actions/checkout@v5
+      - uses: actions/configure-pages@v6
+      - uses: actions/checkout@v6
       - run: cp CHANGELOG.md docs/zh/changelog.md && cp CHANGELOG.md docs/en/changelog.md
-      - uses: actions/setup-python@v5
+      - uses: actions/setup-python@v6
         with:
           python-version: 3.x
       - run: pip install zensical mkdocstrings-python
-      - run: zensical build --clean
-      - uses: actions/upload-pages-artifact@v4
+      - run: zensical build --config-file zensical.toml --clean
+      - run: zensical build --config-file zensical.zh.toml
+      - uses: actions/upload-pages-artifact@v5
         with:
           path: site
-      - uses: actions/deploy-pages@v4
+      - uses: actions/deploy-pages@v5
+        id: deployment

plotfig-1.18.1/.release-please-manifest.json

@@ -0,0 +1 @@
+{".":"1.18.1"}

{plotfig-1.17.0 → plotfig-1.18.1}/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [1.18.1](https://github.com/RicardoRyn/plotfig/compare/v1.18.0...v1.18.1) (2026-05-07)
+
+
+### Code Refactoring ♻️
+
+* **plotfig:** improve type hints for test_method and x_label_ha parameters ([d6fe349](https://github.com/RicardoRyn/plotfig/commit/d6fe349644a92c7ce89b980c7c67d36fc71ac2e3))
+
+## [1.18.0](https://github.com/RicardoRyn/plotfig/compare/v1.17.0...v1.18.0) (2026-05-04)
+
+
+### Features ✨
+
+* **plotfig:** add data-only mode to brain_surface and improve type hints in bar plots ([dc8d039](https://github.com/RicardoRyn/plotfig/commit/dc8d0394b9d43e1cc3cc35f61a9e0054b51954ac))
+
 ## [1.17.0](https://github.com/RicardoRyn/plotfig/compare/v1.16.0...v1.17.0) (2026-03-25)
 
 

{plotfig-1.17.0 → plotfig-1.18.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: plotfig
-Version: 1.17.0
+Version: 1.18.1
 Summary: Scientific plotting package for Cognitive neuroscience
 Author-email: Ricardo Ryn <ricardoRyn1317@gmail.com>
 License-File: LICENSE
@@ -31,7 +31,7 @@ Description-Content-Type: text/markdown
 
 A Python visualization library designed for cognitive neuroscience research, providing efficient, easy-to-use, and beautiful plotting tools.
 
-![plotfig](./docs/assets/plotfig.png)
+![plotfig](./docs/en/assets/plotfig.png)
 
 </div>
 
@@ -46,8 +46,6 @@ A Python visualization library designed for cognitive neuroscience research, pro
 ## Quick Start
 
 ```python
-import matplotlib.pyplot as plt
-
 from plotfig import plot_one_group_bar_figure
 
 # Plot single group bar chart
@@ -74,10 +72,8 @@ pip install plotfig
 
 ## Documentation
 
-For detailed documentation and usage examples, please visit the [plotfig documentation](https://ricardoryn.github.io/plotfig/en/).
+For detailed documentation and usage examples, please visit the [plotfig documentation](https://ricardoryn.github.io/plotfig/).
 
 ## Contributing
 
 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).
-
-For contribution guidelines, please see the [contribution guide](https://ricardoryn.github.io/plotfig/).

{plotfig-1.17.0 → plotfig-1.18.1}/README.md

@@ -10,7 +10,7 @@
 
 A Python visualization library designed for cognitive neuroscience research, providing efficient, easy-to-use, and beautiful plotting tools.
 
-![plotfig](./docs/assets/plotfig.png)
+![plotfig](./docs/en/assets/plotfig.png)
 
 </div>
 
@@ -25,8 +25,6 @@ A Python visualization library designed for cognitive neuroscience research, pro
 ## Quick Start
 
 ```python
-import matplotlib.pyplot as plt
-
 from plotfig import plot_one_group_bar_figure
 
 # Plot single group bar chart
@@ -53,10 +51,8 @@ pip install plotfig
 
 ## Documentation
 
-For detailed documentation and usage examples, please visit the [plotfig documentation](https://ricardoryn.github.io/plotfig/en/).
+For detailed documentation and usage examples, please visit the [plotfig documentation](https://ricardoryn.github.io/plotfig/).
 
 ## Contributing
 
 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).
-
-For contribution guidelines, please see the [contribution guide](https://ricardoryn.github.io/plotfig/).

{plotfig-1.17.0 → plotfig-1.18.1}/README_zh.md

@@ -10,7 +10,7 @@
 
 一个专为认知神经科学研究设计的 Python 可视化库，提供高效、易用且美观的绘图工具。
 
-![plotfig](./docs/assets/plotfig.png)
+![plotfig](./docs/zh/assets/plotfig.png)
 
 </div>
 
@@ -25,8 +25,6 @@
 ## 快速开始
 
 ```python
-import matplotlib.pyplot as plt
-
 from plotfig import plot_one_group_bar_figure
 
 # 绘制单组条形图
@@ -58,6 +56,3 @@ pip install plotfig
 ## 贡献
 
 欢迎提交 Issue 或 PR！无论是 Bug 报告、功能建议还是文档改进，都非常欢迎在 [Issue](https://github.com/RicardoRyn/plotfig/issues) 中提出。
-
-开发贡献流程请参见[贡献指南](https://ricardoryn.github.io/plotfig/)。
-

{plotfig-1.17.0 → plotfig-1.18.1}/docs/en/index.md

@@ -3,7 +3,7 @@
 `plotfig` is a Python library designed specifically for scientific data visualization, dedicated to providing efficient, easy-to-use, and beautiful plotting tools for cognitive neuroscience researchers.
 This project is developed based on mainstream visualization libraries in the industry—`matplotlib`, `surfplot`, and `plotly`, integrating their powerful features to meet the complex plotting needs in neuroscience and brain connectomics across various scenarios.
 
-![plotfig](../assets/plotfig.png)
+![plotfig](assets/plotfig.png)
 
 ## Project Structure
 
@@ -27,4 +27,4 @@ The project adopts a modular design, containing the following main functional mo
 Fun fact: All elements of a figure[^1].
 ![Parts of a Figure](https://matplotlib.org/stable/_images/anatomy.png)
 
-[^1]: [Quick start guide of matplotlib.](https://matplotlib.org/stable/tutorials/introductory/usage.html#parts-of-a-figure)
+[^1]: [Quick start guide of matplotlib.](https://matplotlib.org/stable/tutorials/introductory/usage.html#parts-of-a-figure)

{plotfig-1.17.0 → plotfig-1.18.1}/docs/en/usage/brain_connectivity.md

@@ -35,7 +35,7 @@ fig = plot_brain_connection_figure(
 
 ## Result Display
 
-![output](../../assets/usage/brain_connectivity_files/output.gif)
+![output](../assets/usage/brain_connectivity_files/output.gif)
 
 The HTML file can be interactively viewed in a browser. You can manually take screenshots, or use the following command to batch generate multi-view images.
 

{plotfig-1.17.0 → plotfig-1.18.1}/docs/en/usage/brain_surface.md

@@ -7,14 +7,14 @@ This type of chart is commonly used to display various brain region metrics in n
 The `plot_brain_surface_figure` function is developed based on the `surfplot` library, providing a unified and simplified interface for plotting brain surface maps for human, macaque, and chimpanzee brains.
 Currently supports multiple brain atlases including:
 
-1. Human Glasser (HCP-MMP) atlas[^1]. [Atlas CSV file](../../assets/atlas_csv/human_glasser.csv).
-1. Human BNA atlas[^2]. [Atlas CSV file](../../assets/atlas_csv/human_bna.csv).
-1. Chimpanzee BNA atlas[^3]. [Atlas CSV file](../../assets/atlas_csv/chimpanzee_bna.csv).
-1. Macaque CHARM 4-level[^4]. [Atlas CSV file](../../assets/atlas_csv/macaque_charm4.csv).
-1. Macaque CHARM 5-level[^4]. [Atlas CSV file](../../assets/atlas_csv/macaque_charm5.csv).
-1. Macaque CHARM 6-level[^4]. [Atlas CSV file](../../assets/atlas_csv/macaque_charm6.csv).
-1. Macaque BNA atlas[^5]. [Atlas CSV file](../../assets/atlas_csv/macaque_bna.csv).
-1. Macaque D99 atlas[^6]. [Atlas CSV file](../../assets/atlas_csv/macaque_d99.csv).
+1. Human Glasser (HCP-MMP) atlas[^1]. [Atlas CSV file](../assets/atlas_csv/human_glasser.csv).
+1. Human BNA atlas[^2]. [Atlas CSV file](../assets/atlas_csv/human_bna.csv).
+1. Chimpanzee BNA atlas[^3]. [Atlas CSV file](../assets/atlas_csv/chimpanzee_bna.csv).
+1. Macaque CHARM 4-level[^4]. [Atlas CSV file](../assets/atlas_csv/macaque_charm4.csv).
+1. Macaque CHARM 5-level[^4]. [Atlas CSV file](../assets/atlas_csv/macaque_charm5.csv).
+1. Macaque CHARM 6-level[^4]. [Atlas CSV file](../assets/atlas_csv/macaque_charm6.csv).
+1. Macaque BNA atlas[^5]. [Atlas CSV file](../assets/atlas_csv/macaque_bna.csv).
+1. Macaque D99 atlas[^6]. [Atlas CSV file](../assets/atlas_csv/macaque_d99.csv).
 
 [^1]:
     Glasser, M. F., Coalson, T. S., Robinson, E. C., Hacker, C. D., Harwell, J., Yacoub, E., Ugurbil, K., Andersson, J., Beckmann, C. F., Jenkinson, M., Smith, S. M., & Van Essen, D. C. (2016). A multi-modal parcellation of human cerebral cortex. Nature, 536(7615), Article 7615. https://doi.org/10.1038/nature18933
@@ -42,7 +42,7 @@ data = {"lh_V1": 1, "rh_MT": 1.5}
 ax = plot_brain_surface_figure(data, species="human", atlas="glasser")
 ```
 
-![png](../../assets/usage/brain_surface_files/brain_surface_4_0.png)
+![png](../assets/usage/brain_surface_files/brain_surface_4_0.png)
 
 ```python
 from plotfig import plot_brain_surface_figure
@@ -61,7 +61,7 @@ ax2 = plot_brain_surface_figure(
 )
 ```
 
-![png](../../assets/usage/brain_surface_files/brain_surface_5_0.png)
+![png](../assets/usage/brain_surface_files/brain_surface_5_0.png)
 
 ## Different Surface Files
 
@@ -89,7 +89,7 @@ ax4 = plot_brain_surface_figure(plot_data, surf="sphere", ax=axes[1,0], title_na
 ax5 = plot_brain_surface_figure(plot_data, surf="flat", ax=axes[1,1], title_name="flat")
 ```
 
-![png](../../assets/usage/brain_surface_files/brain_surface_8_0.png)
+![png](../assets/usage/brain_surface_files/brain_surface_8_0.png)
 
 For chimpanzees, the following surface files are provided:
 
@@ -108,7 +108,7 @@ ax1 = plot_brain_surface_figure(plot_data, species="chimpanzee", atlas="bna", su
 ax3 = plot_brain_surface_figure(plot_data, species="chimpanzee", atlas="bna", surf="midthickness", ax=axes[1], title_name="midthickness")
 ```
 
-![png](../../assets/usage/brain_surface_files/brain_surface_10_0.png)
+![png](../assets/usage/brain_surface_files/brain_surface_10_0.png)
 
 For macaques, the following surface files are provided:
 
@@ -135,7 +135,7 @@ ax5 = plot_brain_surface_figure(plot_data, species="macaque", atlas="charm5", su
 ax6 = plot_brain_surface_figure(plot_data, species="macaque", atlas="charm5", surf="flat", ax=axes[1,2], title_name="flat")
 ```
 
-![png](../../assets/usage/brain_surface_files/brain_surface_12_0.png)
+![png](../assets/usage/brain_surface_files/brain_surface_12_0.png)
 
 ## More Settings
 
@@ -159,4 +159,4 @@ ax = plot_brain_surface_figure(
 )
 ```
 
-![png](../../assets/usage/brain_surface_files/brain_surface_15_0.png)
+![png](../assets/usage/brain_surface_files/brain_surface_15_0.png)

{plotfig-1.17.0 → plotfig-1.18.1}/docs/en/usage/circos.md

@@ -19,7 +19,7 @@ fig = plot_circos_figure(connectome)
 # fig.savefig("./figures/circos1.png")
 ```
 
-![png](../../assets/usage/circos_files/circos_1_0.png)
+![png](../assets/usage/circos_files/circos_1_0.png)
 
 ## Parameter Settings
 
@@ -55,7 +55,7 @@ fig = plot_circos_figure(
 # fig.savefig("./figures/circos.png")
 ```
 
-![png](../../assets/usage/circos_files/circos_3_0.png)
+![png](../assets/usage/circos_files/circos_3_0.png)
 
 ### Combining with Other Plots
 
@@ -81,7 +81,7 @@ ax2 = plot_circos_figure(connectome, ax=ax2)
 # fig.savefig("./figures/circos.png")
 ```
 
-![png](../../assets/usage/circos_files/circos_5_0.png)
+![png](../assets/usage/circos_files/circos_5_0.png)
 
 ### Symmetric and Asymmetric Circos Plots
 
@@ -105,7 +105,7 @@ ax2 = plot_circos_figure(connectome, symmetric=False, ax=ax2)
 # fig.savefig("./figures/circos.png")
 ```
 
-![png](../../assets/usage/circos_files/circos_7_0.png)
+![png](../assets/usage/circos_files/circos_7_0.png)
 
 ### Edge Colors
 
@@ -131,7 +131,7 @@ ax3 = plot_circos_figure(connectome, ax=ax3, edge_color="blue")
 # fig.savefig("./figures/circos.png")
 ```
 
-![png](../../assets/usage/circos_files/circos_9_0.png)
+![png](../assets/usage/circos_files/circos_9_0.png)
 
 You can also apply Matplotlib's built-in common color maps (Colormap) through the `cmap` parameter.
 
@@ -158,7 +158,7 @@ ax3 = plot_circos_figure(connectome, ax=ax3, cmap="bwr")
 # fig.savefig("./figures/circos.png")
 ```
 
-![png](../../assets/usage/circos_files/circos_11_0.png)
+![png](../assets/usage/circos_files/circos_11_0.png)
 
 When negative values exist in the connectome data, edge colors cannot be customized, and the system will default to using Matplotlib's `bwr` color map.
 
@@ -177,4 +177,4 @@ fig = plot_circos_figure(connectome)
 
     2025-09-05 15:09:37.347 | WARNING  | plotfig.circos:plot_circos_figure:116 - Due to negative values in connectome, connection colors cannot be customized; positive values will be displayed in red and negative values in blue
 
-![png](../../assets/usage/circos_files/circos_13_1.png)
+![png](../assets/usage/circos_files/circos_13_1.png)

{plotfig-1.17.0 → plotfig-1.18.1}/docs/en/usage/correlation.md

@@ -25,7 +25,7 @@ data2 = data1 + np.random.normal(1,50, 100)
 ax = plot_correlation_figure(data1,data2)
 ```
 
-![png](../../assets/usage/correlation_files/correlation_4_0.png)
+![png](../assets/usage/correlation_files/correlation_4_0.png)
 
 ## Hexbin Plot
 
@@ -59,7 +59,7 @@ hb = plot_correlation_figure(
 cb = fig.colorbar(hb, ax=ax2, label='counts')
 ```
 
-![png](../../assets/usage/correlation_files/correlation_7_0.png)
+![png](../assets/usage/correlation_files/correlation_7_0.png)
 
 ## Parameter Settings
 
@@ -94,4 +94,4 @@ ax = plot_correlation_figure(
 )
 ```
 
-![png](../../assets/usage/correlation_files/correlation_10_0.png)
+![png](../assets/usage/correlation_files/correlation_10_0.png)

{plotfig-1.17.0 → plotfig-1.18.1}/docs/en/usage/matrix.md

@@ -18,7 +18,7 @@ data = np.random.rand(10, 19)
 ax = plot_matrix_figure(data)
 ```
 
-![png](../../assets/usage/matrix_files/matrix_4_0.png)
+![png](../assets/usage/matrix_files/matrix_4_0.png)
 
 ## Parameter Settings
 
@@ -44,4 +44,4 @@ ax = plot_matrix_figure(
 )
 ```
 
-![png](../../assets/usage/matrix_files/matrix_7_0.png)
+![png](../assets/usage/matrix_files/matrix_7_0.png)

{plotfig-1.17.0 → plotfig-1.18.1}/docs/en/usage/multi_groups.md

@@ -29,14 +29,14 @@ group2_bar3 = np.random.normal(3, 1, 10)
 ax = plot_multi_group_bar_figure([[group1_bar1, group1_bar2, group1_bar3], [group2_bar1, group2_bar2, group2_bar3]])
 ```
 
-![png](../../assets/usage/multi_groups_files/multi_groups_3_0.png)
+![png](../assets/usage/multi_groups_files/multi_groups_3_0.png)
 
 ## Plot Beautification
 
 Similar to single-group bar charts, multi-group bar charts also provide a large number of adjustable parameters for flexible control of the chart appearance.
 This section only shows a portion of these parameters.
 
-For the complete parameter list, please refer to the API documentation for [`plot_multi_group_bar_figure`](../api/#plotfig.bar.plot_multi_group_bar_figure).
+For the complete parameter list, please refer to the API documentation for [`plot_multi_group_bar_figure`](../api/#plotfig.multi_bars.plot_multi_group_bar_figure).
 
 ```python
 import numpy as np
@@ -69,7 +69,7 @@ ax = plot_multi_group_bar_figure(
 )
 ```
 
-![png](../../assets/usage/multi_groups_files/multi_groups_6_0.png)
+![png](../assets/usage/multi_groups_files/multi_groups_6_0.png)
 
 ## Statistics
 
@@ -111,4 +111,4 @@ ax = plot_multi_group_bar_figure(
 )
 ```
 
-![png](../../assets/usage/multi_groups_files/multi_groups_9_0.png)
+![png](../assets/usage/multi_groups_files/multi_groups_9_0.png)