Skip to main content

No project description provided

Project description

Jupyter widget: Band structure visualizer

PyPI version

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 a git 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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

widget_bandsplot-0.7.1.tar.gz (183.8 kB view details)

Uploaded Source

Built Distribution

widget_bandsplot-0.7.1-py2.py3-none-any.whl (184.7 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file widget_bandsplot-0.7.1.tar.gz.

File metadata

  • Download URL: widget_bandsplot-0.7.1.tar.gz
  • Upload date:
  • Size: 183.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for widget_bandsplot-0.7.1.tar.gz
Algorithm Hash digest
SHA256 f1a3cd828f31105e922117b5249b6aa62508a503596cdae53de02f08ebaa364d
MD5 5f236cfea4e9d24560867c69f4c5ff58
BLAKE2b-256 48fab4ef3d83eb9e7018c3e78e012f3a931621939d5ffed59999992f67c0927c

See more details on using hashes here.

File details

Details for the file widget_bandsplot-0.7.1-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for widget_bandsplot-0.7.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 0d6aacfc3185f0c4d570bbeaba76a942e2b596ee6dbba637cae56c797593409f
MD5 946d4d86ded32137b77c4145f990b45f
BLAKE2b-256 ece619487b9922a826e2c7fe47298e65357bd2d6bae4f5e9ed47554a6c9fc4f8

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page