MatterViz

matterviz is a toolkit for building interactive web UIs for materials science: periodic tables, 3d crystal structures (and molecules, though needs some improvements!), Bohr atoms, nuclei, heatmaps, scatter plots. It's under active development and not yet ready for production use but we appreciate any feedback from beta testers! 🙏

🔌   MatterViz VSCode Extension

Visualize crystal structures and molecular dynamics trajectories directly in VSCode with the MatterViz VSCode Extension. Features include:

• Native support for common file formats (CIF, POSCAR, XYZ, TRAJ, HDF5, etc.)
• Context menu (right click > "Render with MatterViz") and keyboard shortcuts (ctrl+shift+v on Windows, cmd+shift+v on Mac) for quick access
• Custom viewer for MD trajectories/geometry optimizations
• Extensive customization options via VSCode settings - see Configuration Guide for examples

🗺️   Roadmap

• ✅ MatterViz Web: matterviz.janosh.dev (works but under active development)
• ✅ MatterViz VSCode: marketplace.visualstudio.com/items?itemName=janosh.matterviz (works but under active development)
• ✅ pymatviz: Jupyter/Marimo extension for Python notebooks. Read about widgets in pymatviz readme for details.

📦   Heatmap

This screenshot demonstrates the periodicity of elemental properties (i.e. why it's called periodic table). In this case, you're seeing recurring bumps and valleys in the first ionization energy as a function of atomic number.

⚛️   3D Structure Viewer

⚛️   Element Details Pages

The details page for gold.

https://user-images.githubusercontent.com/30958850/186975855-8e0d94f9-e4e3-47a2-9354-9c012b37307c.mp4

🔨   Installation

npm install --dev matterviz

📙   Usage

Import the PeriodicTable component and pass it some heatmap values:

<script>
  import { PeriodicTable } from 'matterviz'

  const heatmap_values = { H: 10, He: 4, Li: 8, Fe: 3, O: 24 }
</script>

<PeriodicTable {heatmap_values} />

🎬   Events

PeriodicTable.svelte forwards the following events from each ElementTile:

1. click
2. mouseenter
3. mouseleave
4. keyup
5. keydown

Each event is a Svelte dispatch event with the following detail payload:

detail: {
  element: ChemicalElement
  active: boolean // whether the event target tile is currently active
  dom_event: Event // the DOM event that triggered the Svelte dispatch
}

See DispatchPayload and PeriodicTableEvents in src/lib/index.ts

🧪   Coverage

Statements	Branches	Lines

🙏   Acknowledgements

• Element properties in src/lib/element-data.ts were combined from Bowserinator/Periodic-Table-JSON under Creative Commons license and robertwb/Periodic Table of Elements.csv (unlicensed).
• Thanks to Images of Elements for providing photos of elemental crystals and glowing excited gases.
• Thanks to @kadinzhang and their Periodicity project [code] for the idea to display animated Bohr model atoms and inset a scatter plot into the periodic table to visualize the periodic nature of elemental properties.
• Big thanks to all sources of element images. See fetch-elem-images.ts and static/elements.
• Thanks to @ixxie (shenhav.fyi) for a lot of great suggestions, UX ideas, helping me learn threlte and contributing the Bond.svelte component.

This project would not have been possible as a one-person side project without many fine open-source projects. 🙏 To name just a few: