widget-periodictable

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 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.

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.