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.7.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9e4cb08ef75c7af8157a21135872dfa7031b0406077de889af830fb24a14d646 |
|
MD5 | 52ede5b3a86be07de7cc836b9dcb1280 |
|
BLAKE2b-256 | 2e99117df1fdc084e9491a7541cb1bef3010279cf78744c3bfadd0f43d0e0a27 |
Hashes for widget_bzvisualizer-0.2.7-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d02df61cf8754c704708fa445a3bf221330121ec9934feb9e1c1298bb948710a |
|
MD5 | c41a9ad35fc9df2883479b89e6783550 |
|
BLAKE2b-256 | 4be743ccb969592be4b1ccf3bf82f53f5f407ea71ba3aaa29c1a0b8fd3807dc1 |