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.
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 withnext andprev (or via[and]even when the sidebar is hidden).
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
#.
Export to PNG Format
The e key exports the current scene to a PNG.
Tune Visuals
The V key opens a sidebar where the isovalue, molecule style and lighting can be modified.
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_2mklshould 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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file moltui-0.2.1.tar.gz.
File metadata
- Download URL: moltui-0.2.1.tar.gz
- Upload date:
- Size: 97.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4c1bbdfc400c511c3e23f9eb4433095ad8fb6a34ba5ae1f2ae5d09040f6bd6f3
|
|
| MD5 |
da914df7ced7cd6b8e5b1d4865cfb88b
|
|
| BLAKE2b-256 |
7e8240a4d58bfd6c37314c782e2e354039f02c7b624097c536a9b1cb4e5f636e
|
Provenance
The following attestation bundles were made for moltui-0.2.1.tar.gz:
Publisher:
release.yml on kszenes/moltui
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
moltui-0.2.1.tar.gz -
Subject digest:
4c1bbdfc400c511c3e23f9eb4433095ad8fb6a34ba5ae1f2ae5d09040f6bd6f3 - Sigstore transparency entry: 1339667521
- Sigstore integration time:
-
Permalink:
kszenes/moltui@954ce94f8a0be152c1561b3cf3b96b782451ee4c -
Branch / Tag:
refs/tags/v0.2.1 - Owner: https://github.com/kszenes
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@954ce94f8a0be152c1561b3cf3b96b782451ee4c -
Trigger Event:
push
-
Statement type:
File details
Details for the file moltui-0.2.1-py3-none-any.whl.
File metadata
- Download URL: moltui-0.2.1-py3-none-any.whl
- Upload date:
- Size: 36.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
78bf9b00129727647fd1e465d41c64b4c9b2715574d61b4f648772763c3c7ed1
|
|
| MD5 |
72518ee8e90e79ea134ea329244c371c
|
|
| BLAKE2b-256 |
1bc32517caee3e475450be09dabe4cfa9593c927d9fa8c04905490997aa6ff9f
|
Provenance
The following attestation bundles were made for moltui-0.2.1-py3-none-any.whl:
Publisher:
release.yml on kszenes/moltui
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
moltui-0.2.1-py3-none-any.whl -
Subject digest:
78bf9b00129727647fd1e465d41c64b4c9b2715574d61b4f648772763c3c7ed1 - Sigstore transparency entry: 1339667537
- Sigstore integration time:
-
Permalink:
kszenes/moltui@954ce94f8a0be152c1561b3cf3b96b782451ee4c -
Branch / Tag:
refs/tags/v0.2.1 - Owner: https://github.com/kszenes
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@954ce94f8a0be152c1561b3cf3b96b782451ee4c -
Trigger Event:
push
-
Statement type: