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.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f7a5f3682f5292d54cc390293c81da187dd4b9f4b596c7f8de40fbad4aaac517 |
|
MD5 | bd2a41b520f834e20dbb2eb12bd17a89 |
|
BLAKE2b-256 | 7efc9bd924277205d30e51ed5fc0f653df1277a472aa368efaa914436d45c8c3 |
Hashes for widget_bzvisualizer-0.2.3-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a236d7543558caef87a1488e203515cfef9479e3c6d53cd8694e1532308f47e6 |
|
MD5 | 88286b01d4c9b08e78524e5ceaf82d1d |
|
BLAKE2b-256 | 0e356022ca8290a0bac84cc8a49ee0511173e205a33841c287fb16193b2dd5d2 |