A Jupyter widget to show the Brillouin zone of periodic crystals.
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.6.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 005806de642e39418267ab375ce061097ccaa052a98bd63676ae2bb18d0d674d |
|
MD5 | 4a438edb1f0141571da52c487800d31d |
|
BLAKE2b-256 | 27282ff101f56dfcf9ffdbbbd09ea331d1f53b0eeda48211a2858ddb8e676efa |
Hashes for widget_bzvisualizer-0.2.6-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1f3dcbbb93a4fb3c35b3f958f5bc10d70b9c17b22b02e66e6dfbd96e42424073 |
|
MD5 | b56618765024460f6f55195e6c4c1ea9 |
|
BLAKE2b-256 | 8def66ee45042f07a60211753fb4159bca017c7114d6f6ba9f16214c2403e719 |