Skip to content

Getting Started

This tutorial walks you through loading your first crystal structure in CatGo, exploring the 3D viewer, and exporting the result.

Loading a Structure

CatGo supports several ways to load structures:

Drag and Drop

The simplest method — drag a structure file (.cif, .poscar, .xyz, .extxyz, .json) directly onto the 3D viewer. Compressed files (.gz, .zip) are also supported.

File Picker

Click the Import button in the toolbar to open a file browser dialog.

Paste Content

Click the Paste button (or use the paste icon in the toolbar) to open a text modal. Paste CIF, POSCAR, or XYZ content directly and press Ctrl+Enter (or Cmd+Enter on macOS) to import.

Use the OPTIMADE or PubChem search modals to find structures from online databases. See the Database Search tutorial for details.

Once a structure is loaded, you can interact with it using the mouse and keyboard:

Mouse Controls

ActionControl
RotateLeft-click and drag
RollRight-click and drag
ZoomScroll wheel
PanShift + drag (or Ctrl/Cmd + drag)

Keyboard Controls

KeyAction
Arrow keysRotate structure (pitch and yaw)
W / SRoll structure
RReset camera to default view
FToggle fullscreen
IToggle info pane
EscapeClose open panes / exit editing modes

Selecting Atoms

  • Click an atom to select it — the info pane shows its element, index, and coordinates.
  • Shift+click to add/remove atoms from the selection.
  • Double-click the background to clear the selection.
  • Delete or Backspace removes selected atoms from the structure.

Toggling Display Options

Use the Controls panel (gear icon) to adjust the viewer:

OptionDescription
Show BondsToggle bond display
Show CellDisplay unit cell wireframe
Show Image AtomsShow PBC image atoms on cell edges
Show LabelsElement symbols on atoms
Camera ProjectionSwitch between perspective and orthographic
Color SchemeChoose from Vesta, Jmol, Alloy, Pastel, Muted, Dark Mode
Atom RadiusAdjust sphere size
Depth CueingAdd fog effect for depth perception

Inspecting Structure Properties

Press I or click the info icon to open the Info Pane, which shows:

  • Chemical formula and composition
  • Space group and crystal system (via Spglib/Moyo)
  • Lattice parameters (a, b, c, alpha, beta, gamma)
  • Cell volume and density
  • Number of sites

Exporting

Click the Export button in the toolbar to save the structure:

FormatExtensionUse Case
CIF.cifStandard crystallographic exchange
POSCAR.poscarVASP input files
XYZ.xyzSimple Cartesian coordinates
Extended XYZ.extxyzXYZ with lattice and properties
JSON.jsonPymatgen-compatible JSON
GLB.glb3D model for presentations
OBJ.obj3D model for rendering software

Undo / Redo

All structure modifications (adding/deleting/moving atoms, slab cuts, supercells) support undo and redo:

  • Ctrl+Z (Cmd+Z on macOS) — Undo
  • Ctrl+Shift+Z (Cmd+Shift+Z on macOS) — Redo

Next Steps

Released under the MIT License.