like-sci-figures 1.0.0 → 1.0.1

package/README.md

@@ -1,31 +1,134 @@
 # like-sci-figures
 
-> **Publication-quality academic figure generator** — 40 chart types, 11 journal styles, 34 curated color palettes, CJK auto-detection, 300DPI output. Pure local.
+> **出版级学术图表生成器**（Publication-quality academic figure generator）
+> 40 种图表类型 · 11 种期刊风格 · 34 套科研配色 · 中文自动检测 · 300DPI 输出 · 纯本地运行
 
-Generate publication-ready figures for academic papers, theses, posters, and research reports from JSON/CSV data files. Powered by [scienceplots](https://github.com/garrettj403/SciencePlots) + [matplotlib](https://matplotlib.org/). No GUI, no cloud, **no data leaving your machine**.
+从 JSON/CSV 数据一行命令生成出版级学术图表。基于 [scienceplots](https://github.com/garrettj403/SciencePlots) + [matplotlib](https://matplotlib.org/)。无 GUI、无云端，**数据不出本机**。适用于 SCI 论文、学位论文、期刊投稿、会议海报、科研报告及环境监测数据可视化配图。
+
+---
+
+## 中文说明
+
+### 安装
 
 ```bash
-# 安装
 npm install -g like-sci-figures
+```
+
+### 快速开始
 
+```bash
 # 生成图表
 like-sci-figures --type bar --data data.json --out figure.png --style nature
 ```
 
+### 环境要求
+
+- **Python 3.9+**（需在 PATH 中，或用 `LIKE_SCI_PYTHON` 指定路径）
+- Python 依赖：`matplotlib`、`numpy`、`scipy`、`pillow`
+
+```bash
+python -m pip install -r requirements.txt
+# 可选：启用 LaTeX 级期刊风格（内置等效样式会自动后备，不影响基础出图）
+pip install scienceplots
+```
+
+### 特性
+
+- **40 种图表类型**：柱状图、分组柱状图、堆叠柱状图、热力图、散点图、折线图、箱线图、小提琴图、森林图、直方图、密度图、饼图、环形图、雷达图、3D 曲面、等高线图、3D 散点、气泡图、面积图/堆叠面积、误差棒图、韦恩图、PCA 双标图、风玫瑰图、Taylor 图、桑基图、多面板子图、火山图、曼哈顿图、Kaplan-Meier、ROC、脊线图、三元图、点图、树状图、斜率图、瀑布图、Bode 图、周期图、相关矩阵、六边形密度图、经验累积分布（ECDF）、Bland-Altman 一致性分析
+- **11 种期刊风格**：Nature、Science、IEEE、Springer、Lancet、ACS、APS、AAAS、Cell、NEJM、MDPI
+- **34 套科研配色**：定性 / 顺序 / 发散色带，通过 `--palette` 选择，或传入自定义十六进制列表
+- **中文自动检测**：需要时自动加载中 / 日 / 韩字体，中文标签不出豆腐块
+- **输出格式**：PNG / SVG / PDF，默认 300 DPI（可用 `--dpi` 调整）
+
+### CLI 用法
+
+```bash
+like-sci-figures --type <图表> --data <file.json|csv> --out <output.png|svg|pdf> [选项]
+```
+
+| 选项 | 说明 |
+| --- | --- |
+| `--type, -t` | 图表类型（必填），见下方列表 |
+| `--data, -d` | 输入数据文件（JSON 或 CSV） |
+| `--out, -o` | 输出路径（`.png` / `.svg` / `.pdf`） |
+| `--title` | 图标题（用 `\n` 换行） |
+| `--xlabel` / `--ylabel` | X / Y 轴标签 |
+| `--style, -s` | 期刊风格（默认 `nature`） |
+| `--palette, -p` | 配色 slug 或自定义十六进制列表 |
+| `--dpi` | 输出分辨率（默认 300） |
+| `--list-styles` | 列出可用期刊风格并退出 |
+| `--list-palettes` | 列出可用配色并退出 |
+| `--verify-all` | 运行引擎完整自检 |
+
+### 图表类型
+
+`bar` `grouped bar` `stacked bar` `heatmap` `scatter` `line` `box` `violin` `forest` `histogram` `density` `pie` `donut` `radar` `surface` `contour` `scatter3d` `bubble` `area` `errorbar` `venn` `pca` `windrose` `taylor` `sankey` `subplots` `volcano` `manhattan` `kaplan_meier` `roc` `ridge` `ternary` `dotplot` `dendrogram` `slope` `waterfall` `bode` `periodogram` `corr_matrix` `hexbin` `ecdf` `bland_altman`
+
+### 示例
+
+```bash
+# Nature 风格柱状图，标注数值
+like-sci-figures --type bar --data data.json --out figure.png --style nature --show-values
+
+# 相关矩阵热力图（发散配色）
+like-sci-figures --type corr_matrix --data corr.json --out corr.png --palette wx06_amber_navy
+
+# 六边形密度图，自动加 1:1 线与 r/RMSE 角标
+like-sci-figures --type hexbin --data obs.json --out hex.png --style cell --palette viridis
+
+# 多面板子图
+like-sci-figures --type subplots --data panel.json --out grid.png --layout 2x3 --style ieee
+```
+
+### 数据格式
+
+JSON/CSV，schema 随图表类型自适应。柱状图示例：
+
+```json
+{
+  "categories": ["PM2.5", "PM10", "SO2", "NO2"],
+  "values": [38.2, 61.4, 9.1, 24.6],
+  "errors": [3.1, 4.2, 0.8, 2.0]
+}
+```
+
+### 环境变量
+
+- `LIKE_SCI_PYTHON` — 指定 Python 解释器路径（默认使用 PATH 上的 `python` / `python3`）
+
+### 许可证
+
+Source-Available License（见 `LICENSE`）。允许个人与学术非商业使用；禁止商业性再分发与竞品产品化；保留上游 MIT 归属。
+
 ---
 
-## Requirements
+## English
+
+### Installation
+
+```bash
+npm install -g like-sci-figures
+```
+
+### Quick start
+
+```bash
+like-sci-figures --type bar --data data.json --out figure.png --style nature
+```
+
+### Requirements
 
-- **Python 3.9+** (must be on PATH, or set `LIKE_SCI_PYTHON`)
+- **Python 3.9+** (on PATH, or set `LIKE_SCI_PYTHON`)
 - Python dependencies: `matplotlib`, `numpy`, `scipy`, `pillow`
 
 ```bash
 python -m pip install -r requirements.txt
-# 可选：启用 LaTeX 级期刊风格（内置等效样式会自动后备）
+# Optional: enable LaTeX-grade journal styles (built-in equivalent styles fall back automatically)
 pip install scienceplots
 ```
 
-## Features
+### Features
 
 - **40 chart types**: bar, grouped bar, stacked bar, heatmap, scatter, line, box, violin, forest, histogram, density, pie, donut, radar, 3D surface, contour, 3D scatter, bubble, area/stacked-area, error-bar, Venn, PCA biplot, wind rose, Taylor diagram, Sankey, multi-panel subplots, volcano, Manhattan, Kaplan-Meier, ROC, ridge, ternary, dot plot, dendrogram, slope, waterfall, Bode, periodogram, correlation matrix, hexbin density, ECDF, Bland-Altman
 - **11 journal styles**: Nature, Science, IEEE, Springer, Lancet, ACS, APS, AAAS, Cell, NEJM, MDPI
@@ -33,7 +136,7 @@ pip install scienceplots
 - **CJK auto-detection**: automatically loads Chinese/Japanese/Korean fonts when needed
 - **Output**: PNG / SVG / PDF at 300 DPI (adjustable via `--dpi`)
 
-## CLI Usage
+### CLI Usage
 
 ```bash
 like-sci-figures --type <chart> --data <file.json|csv> --out <output.png|svg|pdf> [options]
@@ -73,7 +176,7 @@ like-sci-figures --type hexbin --data obs.json --out hex.png --style cell --pale
 like-sci-figures --type subplots --data panel.json --out grid.png --layout 2x3 --style ieee
 ```
 
-## Data Format
+### Data Format
 
 JSON/CSV with a flexible schema that adapts to each chart type. Example for a bar chart:
 
@@ -85,10 +188,10 @@ JSON/CSV with a flexible schema that adapts to each chart type. Example for a ba
 }
 ```
 
-## Environment
+### Environment
 
 - `LIKE_SCI_PYTHON` — path to a specific Python interpreter (default: `python` / `python3` on PATH)
 
-## License
+### License
 
 Source-Available License (see `LICENSE`). Personal and academic use permitted; commercial redistribution and competing productization prohibited. Upstream MIT attribution preserved.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "like-sci-figures",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Publication-quality academic figure generator from JSON/CSV. scienceplots + matplotlib, 40 chart types, 11 journal styles, 34 curated palettes, CJK auto-detect, 300DPI PNG/SVG/PDF. Fully local, data never leaves your machine.",
   "bin": {
     "like-sci-figures": "cli.js"