A jupyter widget of the periodic table of elements.
Project description
widget-periodictable: A Interactive Perodic Table in Jupyter
Installation & usage
pip install widget-periodictable
For usage examples, see examples/.
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 the example notebook 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 commitand 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.
Github workflow testing
If the widget test fails, it indicates there is something wrong with the code, and the widget is NOT
being displayed correctly in the test.
If the widget test passes but the screenshot comparison fails, it indicates the appearance of the widget
is different from the previous version. In this case, you'll need to manually download the artifact from
the widget test and use it to replace the widget-sample.png figure in the test folder.
Acknowledgements
We acknowledge support from the EPFL Open Science Fund via the OSSCAR project.
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
File details
Details for the file widget_periodictable-4.1.3.tar.gz.
File metadata
- Download URL: widget_periodictable-4.1.3.tar.gz
- Upload date:
- Size: 46.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.0 CPython/3.12.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 14cad684ebe66bb4fcfbef52392b3cc772ebf7a434437eaa3cf14f0b5662bf21 |
|
| MD5 | c4a16cf75452e90d3b3362d6b729ea04 |
|
| BLAKE2b-256 | 92133a2a49cf456612c599e70d1ed12acee7d1dc3430220f6fb5027199f37eb8 |
File details
Details for the file widget_periodictable-4.1.3-py3-none-any.whl.
File metadata
- Download URL: widget_periodictable-4.1.3-py3-none-any.whl
- Upload date:
- Size: 48.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.0 CPython/3.12.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | d64f697d24b3261d99e08e0311ae04e2547b9e39acda87e64809f25e8132eccf |
|
| MD5 | a1f24da15416e36eaccce67d98207cfa |
|
| BLAKE2b-256 | e2d324fecc14205f2af08edfe3edc97999b003d3c0eea842763b5ecb5d6e6687 |
