跳转到主要内容

用于显示周期性晶体布里渊区的Jupyter小部件。

项目描述

Jupyter小部件:布里渊区可视化器

PyPI - Version

用于绘制晶体第一布里渊区的Jupyter小部件。它基于相应的JavaScript库:[https://github.com/materialscloud-org/brillouinzone-visualizer](https://github.com/materialscloud-org/brillouinzone-visualizer)

主要输入是晶体结构,由seekpath解析,并由JavaScript小部件使用anywidget显示结果。

此仓库使用npm create anywidget@latest初始化。

安装和用法

pip install widget-bzvisualizer

有关用法示例,请参阅example/example.ipynb

开发

安装Python代码

pip install -e .[dev]

然后您需要安装JavaScript依赖项并运行开发服务器。

npm install
npm run dev

在 JupyterLab、VS Code 或您喜欢的编辑器中打开 example/example.ipynb 以开始开发。对 js/ 目录所做的更改将反映在笔记本中。

发布和发布新版本

为了发布库的新版本并将其发布到 PYPI,请运行

bumpver update --major/--minor/--patch

这将

  • 更新版本号,创建相应的 git commitgit tag
  • 将此提交和标签推送到 Github,这将触发 Github Action 创建新的 Github 发布并发布软件包到 PYPI。

致谢

我们感谢 EPFL Open Science Fund 通过 OSSCAR 项目 提供的支持。

项目详情


下载文件

下载您平台上的文件。如果您不确定选择哪个,请了解更多关于 安装软件包 的信息。

源代码分发

widget_bzvisualizer-0.2.7.tar.gz (127.8 kB 查看哈希值)

上传时间 源代码

构建分发

widget_bzvisualizer-0.2.7-py3-none-any.whl (129.6 kB 查看哈希值)

上传时间 Python 3

支持

AWS AWS 云计算和安全赞助商 Datadog Datadog 监控 Fastly Fastly CDN Google Google 下载分析 Microsoft Microsoft PSF赞助商 Pingdom Pingdom 监控 Sentry Sentry 错误记录 StatusPage StatusPage 状态页面