Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

CView: Crystal Structure Visualization & Analysis

CView is a high-performance crystallographic tool written in Rust and GTK4. It bridges the gap between structure visualization and ab-initio calculation setup (VASP, QE, SPRKKR).

Tip

Quick Start: Download pre-built binaries for Linux, macOS, or Windows from the Releases Page. See Installation for details.

Important

This version of CView is built on GTK4, which primarily utilizes the CPU for rendering.
While the engine is optimized, it is designed for crystal structures (unit cells, supercells, slabs). It handles systems up to $\approx 5000$ atoms with ease, but it is not suitable for visualizing massive biological macromolecules (e.g., proteins, DNA) containing millions of atoms.
The largest molecule we have tested is of $6000$ atoms core shell polymer.

Tip

CView is not just a viewer; it is a pre-calculation validator. It focuses on Reciprocal Space and Geometric consistency to prevent wasted CPU hours on incorrect VASP/QE inputs.


Why CView?

FeatureDescription
Fast & LightweightBuilt on Rust/GTK4. The main viewer needs no GPU; the 3D charge density view and the trajectory player use OpenGL 3.3, which any laptop from the last decade provides.
Analysis FirstDedicated tools for K-Paths, Slabs, and Void Analysis.
DFT ReadyNative support for VASP (including every step of a vasprun.xml), Quantum Espresso and SPRKKR. LAMMPS dumps are read too — a dump is the same box-plus-coordinates trajectory data as the others, just from a classical-MD code, so it reuses the same reader rather than widening CView’s scope. Relaxations and MD runs play back in the Trajectory Player.
Publication QualityExport high-resolution PNG, PDF, and SVG figures with Cairo-based rendering, and journal-ready 3D charge density figures at a physical size and dpi.

Documentation Overview

This manual is divided into three parts:

  1. Installation: Get CView running on Linux, Windows, or macOS.
  2. User Guide: Deep dive into the scientific methodology.
  3. Tutorials: To Do.

Quick Start

Get up and running in seconds.

Clone and Run

git clone https://github.com/mavensgroup/cview.git
cd cview
cargo run --release

See the Installation Page for detailed OS-specific instructions.


Supported Formats

FormatVASPQuantum EspressoSPRKKRCIF / XYZPDBLAMMPS dump
Read🟢🟢🟢🟢🟢🟢
Write🟢🟠🟠🟢🟢—

Warning

This is a beta release. While the core functionality is operational, the software may contain incomplete features, bugs, or unstable behaviour.

Contributions from testers and developers are welcome.

License & Citation

CView is open-source software licensed under the MIT Licence.

If you use CView in your research, please cite the paper:

Banerjee, R. (2026). CView: a Rust-based integrated environment for inorganic crystallographic analysis and high-fidelity visualization. J. Appl. Cryst. 59(6). https://doi.org/10.1107/S1600576726009003

@article{Banerjee2026CView,
  author    = {Banerjee, Rudra},
  title     = {{CView}: a {Rust}-based integrated environment for inorganic
               crystallographic analysis and high-fidelity visualization},
  journal   = {Journal of Applied Crystallography},
  volume    = {59},
  number    = {6},
  year      = {2026},
  publisher = {International Union of Crystallography (IUCr)},
  doi       = {10.1107/S1600576726009003}
}