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

License Language GTK4 Linux Windows macOS

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).

Performance Limitation: Macromolecules

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 1000$ atoms with ease, but it is not suitable for visualizing massive biological macromolecules (e.g., proteins, DNA) containing millions of atoms.

Philosophy

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.

Screenshot of CView


⚡ Why CView?

FeatureDescription
Fast & LightweightBuilt on Rust/GTK4. No GPU drivers required. Runs on any laptop.
Analysis FirstDedicated tools for K-Paths, Slabs, and Void Analysis.
DFT ReadyNative support for VASP, Quantum Espresso, and SPRKKR formats.
Publication QualityExport high-resolution, transparent PNGs and PDFs using PBR rendering.

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: Step-by-step walkthroughs for real materials (e.g., Bi₂Se₃).

Quick Start

Get up and running in seconds.

Installation

# 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 / XYZ
Read🟢🟢🟢🟢
Write🟢🟠🟠🟢
Relaxation🟢🟢🔴🔴

Contribute

This is an α (alpha) 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 LGPLv3.

If you use CView in your research, please cite the repository.