A Jupyter widget to plot band structure and density of states.
Project description
Jupyter widget: Band structure visualizer
A Jupyter widget to plot band structures and density of states. The widget is using the mc-react-bands Javascript package and is turned into a Jupyter widget with anywidget.
Installation & usage
pip install widget-bandsplot
For usage examples, see examples/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 examples/example.ipynb
in Jupyter notebook or lab 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_bandsplot-0.7.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 63830e317e31fb8dcfd6d4ef5a0524246e2c3aa9b6d4deda05bd39288498fa70 |
|
MD5 | 42038e569a53c88767a1c4ee065d0fe1 |
|
BLAKE2b-256 | 3777b447302fd3b72f5b529ae4ecc9c53ef6a5ac43e0a7775a8c94425f790022 |