Skip to content

A VS Code Extension provides tools such as Matplotlib code snippets and templates.

License

Notifications You must be signed in to change notification settings

wuyao1997/Matplotlib-Pilot-Chinese

Repository files navigation

Matplotlib Pilot Chinese

Version Downloads Installs Rating

Matplotlib Pilot 是一个提供matplotlib代码片段的软件,旨在平缓matplotlib的学习曲线并降低其使用门槛。

目前还是预览版,各种接口可能随时会变化,如果最新版有使用问题请在插件页面将插件回退到之前的版本

中文版本更新较为活跃,For the English version, please go to Matplotlib Pilot.

欢迎反馈问题和建议到邮箱 [email protected]

强烈推荐将此插件配置主视图的右侧(拖拽图标向页面右侧即可),避免侧边栏的反复切换

usage

功能和特点

  1. 侧边栏内提供Matplotlib的常用绘图API,单击就会将相应代码片段插入编辑器光标处
  2. 用户可以便利的修改侧边栏,包括:编辑代码片段、增删按钮
  3. 侧边栏的颜色选择器可以自由选择合适的颜色,选择完成后自动复制颜色字符串
  4. 常见概念按钮可以本地查看Matplotlib中colormarkerlinestylecmap等属性
  5. 绘图模板按钮可以打开模板浏览器,期内提供了使用频率较高的一些绘图模板notebook文件,并在未来会不断升级
  6. 自定义模板按钮可以在配置后管理用户自定义的notebook模板文件,并且不局限于Matplotlib脚本

安装依赖

matplotlib是一个用于数据可视化的Python包,使用前确保已安装:

pip install -i https://pypi.tuna.tsinghua.edu.cn/simple matplotlib

推荐在ipynb文件中使用此插件, 在 VS Code 中新建后缀为.ipynb的文件后将自动推荐Jupyter插件,视网络情况可能需要手动安装ipykernel

pip install -i https://pypi.tuna.tsinghua.edu.cn/simple ipykernel

同时保证 VS Code 版本高于 1.72.0

功能设置

  • MPC: refresh sidebar命令,该命令可以从默认notebook文件刷新侧边栏
  • MPC: modify sidebar命令,调出默认侧面板视图对应的notebook文件, 用户直接修改此文件并保存后,调用MPC: refresh sidebar命令, 重新加载插件时即可使用修改后的侧边栏视图

修改侧边栏视图及其代码片段

自版本0.0.27开始,用户可以自定义侧边栏代码片段按钮, 例如修改字体按钮对应的代码片段内容,使其匹配当前本地环境; 又如不喜欢默认的绘制风格,那么可以新建一个按钮,并填充自己需要的代码。

设置过程如下:

  1. F1调出VS Code内的命令面板,输入MPC: modify sidebar

  1. 点击相应按钮即可打开用于配置侧边栏的 notebook 文件(需要安装Jupyter插件)

notebook

  1. 现在你可以根据需要修改相应的代码片段,修改后保存文件(Ctrl+S)并关闭

template_note

  1. F1调出VS Code内的命令面板,输入MPC: refresh sidebar, 点击相应按钮

refresh

  1. 重启VS Code即可看到修改后的侧边栏。

自定义模板

本插件提供自定义绘图任务模板功能,用户可以将自己常用的绘图脚本制作成notebook文件(后缀名为ipynb), 然后通过下述流程便可以通过自定义模板按钮调出模板浏览界面并使用相应模板来创建新任务。 事实上这也不局限于Matplotlib任务脚本,用户也可以添加其它自己常用的脚本,例如数据滤波、拟合等。

  1. 首先用户需要准备好自己的ipynb文件和相应的封面图片,其中封面图片建议长宽比近似为 1:1,同时图片尺寸建议控制在 100kB 以下; 然后编写一个如下的html文件,可以复制下面内容,然后只需要修改<div class="container">中的内容,主要参数含义如下:
  • h2中的汉字: 本组若干个脚本的标题,建议将功能相近的脚本添加到同一组中
  • img元素中的src内容:指向封面图片的相对路径,相对html文件的路径
  • id值:建议给一个独一无二的编号,可以为组名+数字或含义
  • data-ipynbpath的值:绘图脚本的绝对路径
  • button元素的字符:按钮上将体现的文字,建议为脚本的功能描述,字数尽量简短些,不要超过12个汉字
<!DOCTYPE html>
<html lang="en">

<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>自定义模板</title>
</head>

<body>
    <div class="container">
        <h2>第一组</h2>
        <div class="box">
            <img src="cover/a.png" alt="item-a">
            <button id="a" data-ipynbpath="D:\vscode_plugin\plt-snippet\customTemplate\notebook\a.ipynb">item-a</button>
        </div>
        <div class="box">
            <img src="cover/b.png" alt="item-b">
            <button id="b" data-ipynbpath="D:\vscode_plugin\plt-snippet\customTemplate\notebook\b.ipynb">item-b</button>
        </div>
        <h2>第二组</h2>
        <div class="box">
            <img src="cover/c.png" alt="item-c">
            <button id="c" data-ipynbpath="D:\vscode_plugin\plt-snippet\customTemplate\notebook\c.ipynb">item-c</button>
        </div>
        <div class="box">
            <img src="cover/a.png" alt="item-d">
            <button id="d" data-ipynbpath="D:\vscode_plugin\plt-snippet\customTemplate\notebook\d.ipynb">item-d</button>
        </div>
    </div>
</body>

</html>
  1. 编写完成后,在 VS Code 中按F1键调出命令面板,然后输入MPC: define custom template后会显示相应命令,点击后会调出文件选择对话框,选择上面编写的html文件便会进入模板HTML制作,根据模板的数量不同等待时间也不同,通常会瞬间完成。制作过程中不会检测notebook文件是否存在,但会读取封面文件,如果读取失败那么会使用默认的封面进行替代并在VS Code内弹窗提示。

  2. 模板制作完成后,在 VS Code 中使用快捷键Ctrl + ,调出设置界面,在左侧目录选择选择扩展然后定位到Matplotlib Pilot Chinese,在Custom Template HTML一项中填写上面制作的模板HTML路径,例如:

D:\path\to\customTemplate.html

TODO

  • 完善模板功能
  • 完善代码和功能测试

About

A VS Code Extension provides tools such as Matplotlib code snippets and templates.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published