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.4.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 536fe1ca8ce4acc0e1656f1a2a0bd56993c41f56aefc94fd245bcdec711c9dd0 |
|
MD5 | 505b4acf57f21634603a4b2d1a1f2588 |
|
BLAKE2b-256 | 8998f8e170987291c7132b2a527af2bb463ec97c33fd50faebb99128f5058b91 |
Hashes for widget_bzvisualizer-0.2.4-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7d1946952855542ced69ec1eeaf42bee8b691d1b3d003563dccb8a1759fdbea9 |
|
MD5 | c8a4c42a404a8c699894c96d5a1b7b93 |
|
BLAKE2b-256 | 8a77cec653e3785adac5bb6f8125265ed28dd474bd5371ba10b0098e2ab873d2 |