No project description provided
Project description
Jupyter widget: Brillouin zone visualizer
A Jupyter widget to plot the 1st Brillouin zone of crystals. It is based on the corresponding Javascript library: https://github.com/materialscloud-org/brillouinzone-visualizer
The primary input is a crystal structure, which is parsed by seekpath and the result is displayed by the Javascript widget using anywidget.
This repo is bootstrapped with npm create anywidget@latest
.
Installation & usage
pip install widget-bzvisualizer
For usage examples, see example/example.ipynb
.
Development
Install the python code:
pip install -e .[dev]
You then need to install the JavaScript dependencies and run the development server.
npm install
npm run dev
Open example/example.ipynb
in JupyterLab, VS Code, or your favorite editor to start developing. Changes made in js/
will be reflected in the notebook.
Releasing and publishing a new version
In order to make a new release of the library and publish to PYPI, run
bumpver update --major/--minor/--patch
This will
- update version numbers, make a corresponding
git commit
and agit tag
; - push this commit and tag to Github, which triggers the Github Action that makes a new Github Release and publishes the package to PYPI.
Acknowledgements
We acknowledge support from the EPFL Open Science Fund via the OSSCAR project.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for widget_bzvisualizer-0.2.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6dd887fd487507c88f1f548482009d81113905345a1572428fd89d5ef24211cf |
|
MD5 | 2e44d8d94cc94139074a4d4d3b1f844c |
|
BLAKE2b-256 | 3d5ea3c3a3411a8558550416cf97d4fb3dcb4588978e235913e5bd4dd6a57cb2 |
Hashes for widget_bzvisualizer-0.2.2-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4091f521191915ed99836bdf9cb76036138dfd7cf67e4ec7461b9290aa9b81f6 |
|
MD5 | c470513db7703e5f19572532590d3bb3 |
|
BLAKE2b-256 | 3727b21aaa215d2607988a97e17ffb459b1c0a933d5dc4fb068d849e477948f0 |