Skip to main content

Terminal-based 3D molecular viewer

Project description

MolTUI

MolTUI is a terminal molecular viewer for the XYZ, Zmat, Molden, Gaussian Cube and ORCA GBW file format designed for quick inspection of geometries and orbitals directly in the terminal using Unicode characters. Ideal for remote SSH sessions and lightweight analyses.

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

  • The content is rendered using braille Unicode characters and, therefore, the quality of rendering can depend on the font and terminal emulator. 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.3.tar.gz (99.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.3-py3-none-any.whl (36.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: moltui-0.2.3.tar.gz
  • Upload date:
  • Size: 99.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for moltui-0.2.3.tar.gz
Algorithm Hash digest
SHA256 0b910755281ef8071d1c5488df3481b891d5d3fda1c2d219c4b19edd026d0fe5
MD5 33c921036c13add2773d2feb8811998f
BLAKE2b-256 84ab20f5b716afd4b9a42ff389d1de923c71017be684cea94f8267320e07aeda

See more details on using hashes here.

Provenance

The following attestation bundles were made for moltui-0.2.3.tar.gz:

Publisher: release.yml on kszenes/moltui

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

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

File metadata

  • Download URL: moltui-0.2.3-py3-none-any.whl
  • Upload date:
  • Size: 36.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for moltui-0.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 24514525aba5939bf3024dec6262dfa560a456a1f0d9ab616dd2f140585d6df8
MD5 29c567c323b39da9099b2d5915d230dc
BLAKE2b-256 24fc3f1f493bb64c3e2af327b9ec916fee4150ad7eec1f4d959b4ad4a0994ace

See more details on using hashes here.

Provenance

The following attestation bundles were made for moltui-0.2.3-py3-none-any.whl:

Publisher: release.yml on kszenes/moltui

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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