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
pip install widget-bzvisualizer
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.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a142283192579eafe58fd22dad5e24b65aee5152a8ae7127ddc72607c137b0b0 |
|
MD5 | bc02de893746450c08e080c7d93c3bed |
|
BLAKE2b-256 | 1950012d667cf34781ed7cd8999a04e563d7927fb67e551eca93de6cf3fa00bf |
Hashes for widget_bzvisualizer-0.2.1-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 95a78091c6113f86a626eb5a248b0e0d323b09fa7b4a83e182bf334880923f65 |
|
MD5 | 90fa54fa82d419e752067fd16fd23a12 |
|
BLAKE2b-256 | 50d05ef247c7ed253fc1d1161a657442f4012a578d4848c091dda5ea8783fc91 |