MtxDrawer 0.0.40

Draw Mtx As Thumbnail

Draw Mtx As Thumbnail - 将 Mtx 画为缩略图

样例

平均值	不处理
取 0 次 log	绝对值

安装

pip3 install MtxDrawer -U

安装预览版，支持并行画图:

pip3 install git+https://github.com/Rhythmicc/DrawMtxAsThumbnail.git
# 可以添加parallel标志来启用并行画图
# mtx-drawer draw --parallel 

安装后可以使用命令mtx-drawer

子命令与参数

包含两个子命令 draw-one 和 draw，可以在终端中通过mtx-drawer命令查看，二者区别是draw-one只会处理一个文件，而draw会递归处理当前目录下的所有 mtx 文件。

参数

1. [--force]: 强制替换已存在的缩略图

2. [--log-times <n: int>]: 对缩略图的像素值取 log 的次数

3. [--mat-size <n: int>]: 缩略图的尺寸

4. [--block-size <n: int>]: 直接设置子矩阵块的大小

5. [--tick-step <n: int>]: 设置 x 轴和 y 轴的刻度间隔，启用后会绘制网格线，类似下图：

   mtx-drawer draw --block-size 1 --tick-step 4 --force -ops real
   

6. <filepath>: mtx 文件的路径 (draw-one子命令中必填)

7. <-ops <aver | abs | real | log | ... >>: 缩略图的类型，其中<aver>表示平均值，<abs>表示绝对值，<real>表示实际值，<log>表示对数值进行对数变换

运行例子

mtx-drawer draw-one 2.mtx --force --log-times 0 -ops aver abs log real # 一次性绘制2.mtx的四种图，log取0次，强制替换
mtx-drawer draw-one 2.mtx  -ops aver abs log real # 一次性绘制2.mtx的四种图，log取2次，不强制替换
mtx-drawer draw --force -ops aver abs log # 绘制当前目录及子目录下的全部mtx文件的三种图，强制替换
mtx-drawer draw -ops aver abs log real # 绘制当前目录及子目录下的全部mtx文件的三种图，不强制替换且log取2次

特殊说明

子矩阵划分方式：当行列不相等时，较大的属性被分为matSize块，较小的属性为rate * matSize块；其中rate为$ min(m,n)/max(m,n) $

命令行补全

基于QuickProject.Commmander开发的命令行 APP 可以提供 zsh 或 fig 的补全脚本：

mtx-drawer complete

基于 Drawer 类的自定义开发

当默认提供的四种算法无法满足需要时，可以按如下方式自行设计算法：

from MtxDrawer.Drawer import Drawer

"""
您可以通过如下方式自定义算法并通过Drawer对象的call方法来调用；
自定义算法可接受的参数将在下表中说明，此外，自定义算法必须返回一个数值用于表示color_bar的显示范围（返回1则表示-1~1）
"""

@Drawer.algorithmWrapper() # 算法装饰器
def myOwnAlgorithm(mat, extern_arg): # 参数命名要符合下表的要求，mat是下表第9项，extern_arg是下表第15项
    print(extern_arg)
    return max(abs(max([max(i) for i in mat])), abs(min([min(i) for i in mat])))


drawer = Drawer('dist/2.mtx', False, set_log-times=0, force_update=True)
drawer.call('myOwnAlgorithm', extern_arg=1)

"""
---结果---

[信息] 路径模板: "dist/2_{}.svg"
1
[信息] absVal = 1
"""

序号	合法参数	说明
1	has_aver	是否有取平均值选项 => div 是否可用
2	log-times	外部设定的取 log 的次数
3	mat-size	矩阵行列值较大的属性被分的块数
4	mtx	文件的 scipy.sparse.coo*matrix 对象，未做任何更改
5	coo_shape	mtx 的尺寸
6	coo_data	矩阵的非零元值
7	coo_rows	矩阵的非零元素行索引映射到 mat 的行值
8	coo_cols	矩阵的非零元素列索引映射到 mat 的列值
9	mat	被初始化好的二维画布对象，类型为 numpy.array
10	div	子矩阵非零元数，只有当 has_aver 为 True 时才会有效
11	row_size	mat 的行数
12	col_size	mat 的列数
13	row_block_sz	划分的子矩阵的行数
14	col_block_sz	划分的子矩阵的列数
15	extern_*	额外的参数命名方式，需以"extern_xx=bala"的方式调用

现代 IDE 下的提示

开发指南

环境要求

本项目使用 uv 进行快速包管理和虚拟环境处理。

开发环境设置

# 创建虚拟环境
uv venv

# 激活虚拟环境
source .venv/bin/activate

# 安装开发依赖
uv pip install -e ".[dev]"

常用开发任务

# 以开发模式安装
uv pip install -e .

# 构建包
uv pip install build cython numpy
python -m build

# 运行测试（本地测试）
python -c "import MtxDrawer; print('Import test passed')"
mtx-drawer --help

# 清理构建产物
rm -rf build/ dist/ *.egg-info/

# 代码格式化（推荐在提交前运行）
black .
isort .

# 代码检查（推荐在提交前运行）
flake8 .

发布流程

项目使用 GitHub Actions 进行自动化构建和发布：

1. 手动发布：在 GitHub Actions 页面手动触发 "Release" 工作流，输入版本号
2. 自动发布：推送以 v 开头的标签（如 v0.0.39）会自动触发构建和发布到 PyPI
3. 创建 Release：在 GitHub 上创建 Release 也会触发自动发布

GitHub Actions 工作流

• Publish (.github/workflows/publish.yml)：标签推送或创建 Release 时自动构建多平台包并发布到 PyPI
• Release (.github/workflows/release.yml)：手动触发的版本发布工作流，自动更新版本号并创建标签

注意：代码测试和质量检查在本地进行，GitHub Actions 专注于打包和发布功能。

项目结构

• pyproject.toml：现代 Python 项目配置（替代大部分 setup.py 功能）
• setup.py：用于 Cython 扩展编译的最小配置
• .github/workflows/：GitHub Actions CI/CD 工作流
• MtxDrawer/：主要源代码
• MatGen/：Cython 扩展源代码

依赖项

• 构建依赖：setuptools, Cython, numpy, wheel
• 运行时依赖：numpy, matplotlib, Qpro, cython
• 开发依赖：build, twine, pytest, black, isort, flake8