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.0.tar.gz (183.8 kB view details)

Uploaded Source

Built Distribution

widget_bandsplot-0.7.0-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.0.tar.gz.

File metadata

  • Download URL: widget_bandsplot-0.7.0.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.0.tar.gz
Algorithm Hash digest
SHA256 0109b2f027651e71f7737cdfbff647c8d01be0925073e83707bc3424902c91bf
MD5 07d7b6c3631abb7368ab7fe2cfa36378
BLAKE2b-256 1a694a593759bcbe80b45005632d263ab9f3519caed298d28902acdf01025ce5

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for widget_bandsplot-0.7.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 30247400ebe5caaa6c36f6ae535cb96a07cfd9ec6ed344cbdb907028d1e440c0
MD5 5d6d2c6e2b71e88adb5bf258e9fc6671
BLAKE2b-256 cff8c3b404f62dbca87385333efbb7a057b454a3b542114072e65a632ca3d9b8

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