TCviewer
Quickly display molecules and surfaces with our TCviewer program. TCviewer is easy to use and yields beautiful figures.
Installation
Currently, the installation can be done by cloning this repository and having all necessary dependencies.
The following is for people who would like to install the repository themselves. For example, to edit and/or contribute code to the project.
First clone this repository:
git clone git@github.com:TheoChem-VU/TCviewer.git
Then move into the new directory and install the package:
cd TCviewer
python -m pip install --upgrade build
python -m build
python -m pip install -e .
To get new updates, simply run:
git pull
Usage
TCviewer exports the Screen object which can be used to quickly build a scene. All the heavy work, such as setting up the camera, building and coloring meshes, will be done in the background. Please see the examples section for some simple example scripts for you to try out.
Examples
To draw a molecule, simply run:
from tcviewer import Screen
from scm import plams
molecule = 'path/to/molecule.xyz' # molecules can be given as paths to xyz files
molecule = plams.Molecule('path/to/molecule.xyz') # or as plams.Molecule objects
molecule.guess_bonds()
with Screen() as scr:
scr.draw_molecule(molecule)
To load and draw the HOMO:
from yutility import orbitals
from tcviewer import Screen, materials
import pathlib
rkf_dir = pathlib.Path(__file__).parents[0]/'data'/'NH3BH3'
# load orbitals and choose an MO to draw
orbs = orbitals.Orbitals(rkf_dir/'adf.rkf')
homo = orbs.mos['HOMO']
# generate a cube file
cub = homo.generate_orbital()
with Screen() as scr:
scr.draw_cub(cub, 0.03, material=materials.orbital_matte)
1 maintainer
Metadata
1 maintainer
Release files for tcviewer 0.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| tcviewer-0.2.tar.gz | 23.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| tcviewer-0.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 50.6 kB
Release files / tcviewer-0.2.tar.gz
| Download URL | tcviewer-0.2.tar.gz |
|---|---|
| Size | 23.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
03ebe7aa6fd6beb5015eff4990164a9c38ab05aaa56ba5532ca7c79a66d27900
|
|
BLAKE2b-256 checksum How to use checksums |
9c5aa75400acbac0b089c295022f12127c7c8c75376718645902d652b3fd697b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 1, 2026.
Transparency logRelease files / tcviewer-0.2-py3-none-any.whl
| Download URL | tcviewer-0.2-py3-none-any.whl |
|---|---|
| Size | 27.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
5d0b27983e9ede7d3e4070ba98994d79931d312d95d98dd3cf863aa6dcd225ae
|
|
BLAKE2b-256 checksum How to use checksums |
2ca6568f4a4cee1e5623210a35046ec81aae4c8f18d695ae4192b53ac12e9414
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 1, 2026.
Transparency log
