Skip to main content

Terminal-based 3D molecular viewer

Project description

MolTUI

Terminal-based 3D molecular viewer for XYZ, Zmat, Molden, Gaussian Cube and ORCA GBW file formats rendered entirely in Unicode characters.

benzene

Installation

pip install moltui
# or
uv tool install moltui

Usage

moltui <file>

Features

Visualize Orbitals

  • The rendering of orbitals can be toggled via o.
  • Molden and GBW files can contain multiple molecular orbitals. Toggle the orbital sidebar with m. Cycle through MOs with next and prev (or via [ and ] even when the sidebar is hidden).
image

Analyze Geometry

  • Bond lengths, angles and dihedrals can be viewed using the geomtry key which opens a sidebar. Navigate between tabs via <tab>.
  • The quantity is highlighted in yellow on the molecule.
  • Sort the quantity in ascending order via s.
  • Atom indices can be toggled via #.
image

Export to PNG Format

The e key exports the current scene to a PNG.

benzene_hf 021

Tune Visuals

The V key opens a sidebar where the isovalue, molecule style and lighting can be modified.

image

The lower case v cycles between the styles.

CPK Licorice VDW

Toggle between light and dark mode with i.

Light Dark

Supported formats

  • Structures Only: XYZ, Gaussian ZMAT.
  • Structures and Orbitals: Molden, Gaussian Cube, Orca GBW¹.

¹ Requires orca_2mkl in PATH

Keybindings

Navigation

Key Action
h/j/k/l or arrows Rotate left/down/up/right
,/. Roll clockwise/counter-clockwise
J/K or +/- Zoom out/in
t Toggle pan/rotation mode
c Center view
r Reset view

Display

Key Action
o Toggle orbital isosurfaces
i Toggle dark/light theme
b Toggle bonds
e Export PNG
v Toggle style (CPK, Licorice, VDW)
# Toggle atom numbers

Panels

Key Action
g Geometry panel (bonds, angles, dihedrals)
m MO panel (molecular orbitals)
V Visual settings panel (style, sizes, lighting)
[, ] Previous/next MO
n/p Navigate panel entries
Esc Close panel

Visual panel

Key Action
n/p Move between controls
Tab/Shift+Tab Adjust value (slider) or switch option (style)

General

Key Action
q Quit

Limitations

  • Quality of rendering might depend on terminal emulator and font. All figures in the repository have been generated using the JetBrains Mono Nerd Font in the Kitty terminal.
  • The Orca GBW file format is typically incompatible between versions. Therefore, the orca_2mkl should ideally be of the same version as the Orca version used to produce the GBW file. Newer version of Orca can try to recover earlier GBW files using the rescue feature.

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

moltui-0.2.0.tar.gz (126.1 kB view details)

Uploaded Source

Built Distribution

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

moltui-0.2.0-py3-none-any.whl (35.6 kB view details)

Uploaded Python 3

File details

Details for the file moltui-0.2.0.tar.gz.

File metadata

  • Download URL: moltui-0.2.0.tar.gz
  • Upload date:
  • Size: 126.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.12

File hashes

Hashes for moltui-0.2.0.tar.gz
Algorithm Hash digest
SHA256 0c0494bdce625fc768a916ad14991e25240a24653f1fe60635150037d37a0299
MD5 0861356368102be93d8f3063417de0a1
BLAKE2b-256 17ebb361612b0958c9cbd9edbc27a4c812ba9635f64892d2e4f1c8dbf17baf02

See more details on using hashes here.

File details

Details for the file moltui-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: moltui-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 35.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.12

File hashes

Hashes for moltui-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a21f5e29784c640c1cec4942775d64217787f5961d5d7961dde1667bc26a313e
MD5 fc670386361cc06f3ca5be87798f4fba
BLAKE2b-256 61b2c18b6a994a70ab4bc1f04d768a03b8441c0011c839d4be79ac2481ff62f0

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