PennyLane Demos 使用入门：demo CLI 工具从创建到构建 HTML 完整教程

PennyLane Demos 使用入门demo CLI 工具从创建到构建 HTML 完整教程【免费下载链接】demosIntroductions to key concepts in quantum programming, as well as tutorials and implementations from cutting-edge quantum computing research.项目地址: https://gitcode.com/gh_mirrors/qml/demosPennyLane Demos 是一个开源量子计算演示合集收录了量子编程核心概念与前沿研究的教程。本教程将带你一步步使用内置的 demo CLI 工具完成“创建演示 → 编写代码 → 构建 HTML”的完整流程让你用几条命令就能把自己的量子程序发布成演示网页。为什么需要 demo CLI 工具手写演示项目涉及不少繁琐工作建目录、填元数据 JSON、管理依赖版本、跑 Sphinx 构建……demo CLI 工具把整个过程封装成了 3 条命令命令作用demo new交互式创建新演示项目自动生成 3 个标准文件demo build把演示构建为 HTML / JSON可执行代码生成输出demo help查看全部命令的帮助信息CLI 的入口实现位于 lib/demo/app/app.py命令解析基于typer框架。第一步一分钟一键安装 demo CLICLI 要求Python 3.11见 pyproject.toml建议使用虚拟环境安装# 获取代码 git clone https://gitcode.com/gh_mirrors/qml/demos cd demos # 创建并激活虚拟环境 python3.11 -m venv .venv source .venv/bin/activate # 安装并验证 CLI 工具 pip install . demo看到包含help/new/build的命令面板即安装成功。Windows 用户用\.venv\Scripts\activate激活环境即可。 完整的安装说明与命令参考见 documentation/demo-cli.md。第二步用 demo new 创建你的第一个演示执行demo new按提示依次回答几个问题Title演示标题不能为空Custom directory name目录名会按标题自动生成下划线格式可修改Description一句话简介用作网站 SEO 描述Author(s)你的 pennylane.ai 用户名可添加多位作者Thumbnail / Large Thumbnail可选的缩略图路径留空会使用占位图确认后CLI 会在demonstrations_v2/下生成标准三件套文件用途demo.py演示主体Markdown 导语 可执行代码metadata.json标题、作者、分类、日期等元数据requirements.in该演示额外依赖清单文件模板的生成逻辑在 lib/demo/lib/template.py标题校验与目录名 slug 化规则在 lib/demo/app/app.py。第三步编写 demo 代码与 metadata 元数据demo.py采用“文本 代码”混合写法顶部 docstring 是可渲染的 Markdown 正文代码按顺序执行中间可加注释块把代码切分成独立单元格。可直接参考官方模板 documentation/reference_demo/demo.py。metadata.json决定演示在站点的展示效果字段说明见 demonstrations_metadata.md改动前可对照最新校验规则 metadata_schemas/demo.metadata.schema.0.1.10.json。两个字段尤其重要executable_stable/executable_latest构建时是否真正执行代码。旧演示的目录名以tutorial_开头时缺省也视为可执行previewImages站点头像图需放在_static/demo_thumbnails/下全局公共依赖统一放在 dependencies/ 目录管理你只需在requirements.in里补充自己额外的依赖。第四步用 demo build 构建 HTML 输出代码写好后一条命令即可构建# 构建指定演示为 HTML并执行代码生成图表与输出 demo build --execute --format html your_demo_name # 不指定名称则构建全部演示 demo build常用参数速查参数作用--format html/--format json输出格式默认 JSON--execute执行代码生成输出仅对元数据标记可执行的演示生效--dev/--no-dev使用开发版 / 稳定版依赖默认稳定版--venv name指定安装构建依赖的虚拟环境默认.venv-build--quiet/--keep-going静默输出 / 某个演示失败时继续构建其余演示构建成功后HTML 产物在_build/html/demos/demo_name/直接用浏览器打开预览JSON 产物在_build/pack/demo_name/注意修改源文件后需重新构建且本地构建不含完整样式与公式渲染构建核心逻辑创建虚拟环境、安装依赖、调用 sphinx-build在 lib/demo/lib/demo.py仓库根目录、构建目录等路径常量定义于 lib/demo/context.py。常见构建问题速查demo命令找不到确认已激活虚拟环境且pip install .执行成功构建后没有代码输出--execute只对executable_stable/executable_latest为 true 的演示生效缩略图不显示图片必须放在regular_demo_thumbnails/或large_demo_thumbnails/目录且metadata.json中的路径以/开头依赖版本冲突用--venv指定独立环境或在requirements.in中锁定版本下一步去哪到demonstrations_v2/浏览上百个现成演示模仿其结构与写法阅读 CONTRIBUTING.md 了解演示提交规范分类命名规则见 demonstrations_categories.md掌握 demo CLI 工具后“写量子程序 → 发布成网页”从繁琐的多步流程缩短为几条命令。现在就敲下demo new创建属于你的第一个量子演示吧【免费下载链接】demosIntroductions to key concepts in quantum programming, as well as tutorials and implementations from cutting-edge quantum computing research.项目地址: https://gitcode.com/gh_mirrors/qml/demos创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考