Skip to main content

Local web GUI for rendering crystal structures as publication-ready figures.

Project description

Pretty Lattice

Pretty Lattice is a crystal visualization tool for creating beautiful, publication-ready figures.

Build status PyPI Python 3.12+ License: MIT

English | 简体中文

  • Pretty: tasteful defaults for colors, materials, lighting, and depth
  • Simple: an intuitive browser GUI for loading, viewing, and exporting structures
  • Reliable: structure parsing and analysis powered by the mature pymatgen package
  • Scalable: smooth interaction with systems up to 10k atoms
  • Customizable: tune colors, radii, materials, opacity, orientation, and export settings

Pretty Lattice interface preview

Why

I always find it harder than it should be to make a good-looking crystal figure.

Traditional crystallographic tools such as VESTA are powerful, but their visual defaults often feel outdated: harsh color palettes, low-quality 3D shading, and a lot of manual tweaking before the result looks acceptable. You could import the structure into professional 3D software such as Cinema 4D or Blender, but that feels like overkill and comes with a much steeper learning curve.

Pretty Lattice is my attempt to fill that gap. Built on Three.js, it stays (relatively) lightweight without compromising visual quality. It offers a modern, intuitive interface with familiar controls researchers expect, and produces clean, aesthetically pleasing figures out of the box.

[!NOTE] By design, Pretty Lattice focuses on visualization. It is not intended to replace mature materials-analysis tools such as VESTA and Materials Studio, and it does not try to provide complex structure editing or analysis workflows. Input files are treated as read-only. The intended workflow is to prepare and analyze structures with more specialized tools, then bring the final structure into Pretty Lattice for viewing, styling, and export.

Install

pip install pretty-lattice

Or install as an isolated tool with uv:

uv tool install pretty-lattice

Requirements:

  • Python 3.12+
  • macOS, Linux, or Windows
  • Any modern browser

Quick start

After installation, start the local GUI:

prl gui

Pretty Lattice starts a local server and opens your browser automatically.

Run once without installing:

uvx --from pretty-lattice prl gui

Useful launch options:

prl gui --no-open     # start the server without opening a browser
prl gui -p 0          # choose any available port automatically

Examples

Material presets

SrTiO3 material preset examples

Color scheme presets

Ba2Ca2Cu3HgO8 color scheme examples

Contributing

This project is still in an early stage, and the main functionality is not complete yet.

For now, development is maintainer-led, and I’m not accepting pull requests. This helps keep the project direction focused while the core experience is still being shaped.

You’re welcome to fork the project or open issues for bug reports, suggestions, or feedback.

License

Pretty Lattice is released under the MIT License.

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

pretty_lattice-0.1.2.tar.gz (7.7 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pretty_lattice-0.1.2-py3-none-any.whl (1.4 MB view details)

Uploaded Python 3

File details

Details for the file pretty_lattice-0.1.2.tar.gz.

File metadata

  • Download URL: pretty_lattice-0.1.2.tar.gz
  • Upload date:
  • Size: 7.7 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.26 {"installer":{"name":"uv","version":"0.11.26","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for pretty_lattice-0.1.2.tar.gz
Algorithm Hash digest
SHA256 14327c5e5428cb407a2c3a37601975e309c63fba20f345753353622e186f492b
MD5 38eb5eb2d5bf47a0aa3ce68f341c4840
BLAKE2b-256 e0e6378f0ff6e71d97a9aea54f67c305d4b7bb187ea914eae69f2f665f2743b1

See more details on using hashes here.

File details

Details for the file pretty_lattice-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: pretty_lattice-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 1.4 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.26 {"installer":{"name":"uv","version":"0.11.26","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for pretty_lattice-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 acc730fb2ccb85cc8325171da9794feebe2e900d73e8769d89f5e8fef31e6ae9
MD5 42a6e6d7f9fcc15d69b847b099121d15
BLAKE2b-256 df6354ddb26a2ab42dfdc8c7ea4b77ce4ddec5c1fcefb2233070242422bb9ea0

See more details on using hashes here.

Supported by

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