Supported formats
v_ase 0.3.3 uses one input pipeline for the terminal, Python path API, and browser file picker. It adds project, volumetric, indexed-trajectory, and LAMMPS handling around ASE’s readers. An explicit reader always takes priority over filename inference.
Input overview
Family |
Common names and extensions |
What v_ase loads |
Important behavior |
|---|---|---|---|
VASP structures |
|
Structure, cell, PBC, constraints and compatible arrays |
Numbered or descriptive suffixes such as |
VASP trajectories |
|
All or selected trajectory frames |
View mode uses indexed random access when the header is compatible |
VASP calculation XML |
|
ASE-readable structures and frames |
Use |
XYZ |
|
One or more structures |
Standard XYZ has limited metadata |
Extended XYZ |
|
Frames, cells/PBC, arrays and compatible calculator results |
Preferred text interchange when ASE metadata must survive |
ASE trajectory |
|
Native ASE frames and metadata |
View mode uses the trajectory container’s random access |
LAMMPS dump |
|
Frames, box/PBC, ids, types, positions and supported numeric columns |
Compatible numeric dumps use a byte-indexed, memory-mapped View path |
LAMMPS data |
|
Structure, box, atom ids/types, masses and supported topology fields |
Atom style is detected when possible; |
CIF |
|
ASE-readable crystallographic structures |
CIF interpretation follows the installed ASE release |
v_ase project |
|
Complete editable document |
Restores frames, scientific metadata, visual state, analysis and export settings |
v_ase project HTML |
|
Embedded |
A lightweight view-only HTML has no editable project to restore |
VASP scalar fields |
|
Structure plus scalar datasets |
Standard stems may use |
Gaussian Cube |
|
Structure and scalar grid |
|
XSF |
|
Structure and supported scalar grids |
|
Other ASE formats |
Format-dependent |
Structures or trajectories accepted by |
Pass the raw ASE format name when automatic detection is insufficient |
Note
“Supported by ASE” does not imply that every format can preserve every ASE
array, constraint, calculator result, label, or trajectory feature. Use
extended XYZ, ASE trajectory, ASE Pickle, or .vase when those distinctions
matter.
Automatic detection and reader aliases
The resolver examines the original user-visible filename, including browser
uploads that are stored temporarily under a different server-side name. The
following standard VASP stems are recognized with an optional ., _, or
- suffix:
POSCARandCONTCAR;XDATCAR;CHGandCHGCAR;PARCHG;LOCPOT; andELFCAR.
For example, POSCAR.relaxed, XDATCAR_2, and LOCPOT-spin retain the
intended reader. vasprun.xml is recognized by its complete basename.
Use --format to override inference:
v_ase gui INPUT --format POSCAR
v_ase gui INPUT --format XDATCAR
v_ase gui INPUT --format vasprun.xml
v_ase gui INPUT --format lammpstrj
v_ase gui INPUT --format data
v_ase gui INPUT --format CHGCAR
v_ase gui INPUT --format qe-cube
v_ase gui INPUT --format qe-xsf
Common aliases are case-insensitive:
Requested family |
Accepted examples |
|---|---|
VASP structure |
|
XDATCAR |
|
vasprun.xml |
|
LAMMPS dump |
|
LAMMPS data |
|
ASE trajectory |
|
Extended XYZ |
|
Project |
|
Scalar field |
|
Raw ASE format names are also forwarded to ASE. See Data input and documents for browser destinations and failure semantics.
Frame selection
The terminal accepts ASE-style frame selection:
v_ase gui trajectory.extxyz --index :
v_ase gui trajectory.traj --index -1
v_ase gui XDATCAR --index 25
: means all frames, -1 means the final frame, and an integer selects one
frame. The default is all frames. Indexed sources can expose the requested
frame immediately in View mode; switching to Edit can materialize the complete
selected trajectory because physical topology operations require editable ASE
objects.
Labels, types, and per-atom data
v_ase keeps ASE chemical TYPE separate from the visual LABEL used by appearance, selection, and label-pair rules.
Repeated POSCAR/CONTCAR species blocks remain distinct. A header
Cu O Ocan become labelsCu,O_1, andO_2while both oxygen groups retain ASE elementO.Extended XYZ arrays and valid labels are retained when ASE exposes them.
LAMMPS integer types remain visible as labels. A mass can infer a chemical element when the match is unambiguous.
Compatible LAMMPS dump columns such as id, molecule, charge, force, mass, and scalar values are exposed as ASE arrays or colorable properties.
Plain XYZ and many crystallographic formats cannot encode all of these fields. Choose an interchange format according to the preservation table below.
LAMMPS dump geometry
In the current source, orthogonal, restricted triclinic (xy xz yz) and general
triclinic (abc origin) boxes preserve their cell vectors and source Cartesian
origin. Scaled coordinates include that origin; Cartesian coordinates retain
their input values. The ASE celldisp, JSON cell_origin and semantic
cellOrigin carry the same origin. Boundary flags follow the dump header;
when a general-triclinic header omits them, PBC defaults to false.
Fast View streams use FP32 for drawing and exact int64 particle/molecule IDs. Scientific ASE frames reread values in FP64. Changed IDs or types fail explicitly without switching the active frame. Reopen in Edit to read a trajectory whose atom types change through the safe parser. These changes are unreleased after 0.3.3.
Volumetric data
See the field workflow for grid conventions and precision.
VASP density, potential, partial-density, and ELF files, Gaussian Cube, and XSF can open as a structure plus scalar datasets. Select the in-memory scalar precision at launch:
v_ase gui CHGCAR --volumetric-precision fp32
v_ase gui LOCPOT --volumetric-precision fp64
FP32 is the lower-memory default. FP64 preserves double-precision grid values and uses approximately twice the grid memory. Combining datasets requires identical dimensions, cell vectors, origin, PBC, endpoint convention, and units; v_ase does not silently resample incompatible grids.
Structure and scientific-state output
Output |
Contents |
Does not preserve |
|---|---|---|
POSCAR |
Current physical ASE structure and full-rank cell |
Trajectory, visual settings, analysis, arbitrary arrays unsupported by VASP |
CLI |
Final blocking-session ASE object through the writer inferred from |
Anything unsupported by the chosen ASE writer |
ASE Pickle ( |
Current frame, symbols, positions, cell/PBC, labels, constraints, portable arrays, valid |
Other frames, visual settings, arbitrary executable calculator implementations |
|
Complete editable project archive |
Original source-file dependency; the archive is self-contained |
Project HTML |
Offline rendered document plus complete embedded |
Editing in the browser view itself; reopen it in v_ase to edit |
Visual Settings JSON |
Reusable presentation, bonds, camera/projection, lighting, display replication and visual translation |
Coordinates and trajectory frames |
For a normal blocking terminal workflow, -o writes the returned structure
with ASE after the session closes:
v_ase gui input.cif -o edited.extxyz
v_ase gui input.cif -o edited.data --output-format lammps-data
The GUI POSCAR exporter centers a cell-free or rank-deficient finite structure
in a nonperiodic box with 8 Å vacuum so that ASE’s VASP writer can produce a
valid file. Directional Cartesian constraints in a skew cell may not be
representable by ASE’s VASP selective-dynamics writer. The exporter reports
this scientific limitation without discarding constraints. Save a .vase
project or ASE Pickle to preserve the exact constraint geometry, or explicitly
choose a compatible representation before exporting POSCAR.
ASE Pickle is Python-specific and uses pickle; load only files from a trusted
source. In contrast, .vase is a validated ZIP-based project format and does
not unpickle executable Python objects.
Project and HTML choices
Use Export > Save Project for editable continuity:
the default
.vaseis the smallest complete project;enabling Include interactive rendered view produces a larger
.htmlcontaining the same complete.vase, an optimized poster, and an offline interactive scene.
Use HTML View for a presentation handoff. Its default is the smaller view-only document without an embedded project. Enabling project embedding adds Download .vase and makes the file reopenable through:
v_ase gui project.html
All standalone HTML output opens from file:// without Python, a local
server, a CDN, or another network request. It supports camera navigation and
trajectory playback but intentionally exposes no atom or style editing tools.
Rendered media and 3D scenes
Export |
File |
Notes |
|---|---|---|
Image |
|
Uses the exact Render Area dimensions and camera |
Video |
|
Constant-frame-rate output; interpolation inserts in-between frames |
Blender |
|
Reconstructs optimized atoms, bonds, cell, camera and Sun in Blender |
OBJ |
|
Contains OBJ/MTL scene data plus camera and metadata; no optional dependency |
Rhino |
|
Instanced geometry, metadata and saved views; requires the |
PNG is the default. PNG recompression and WebP are lossless. JPEG and PDF flatten transparency onto white; all four retain the requested pixel dimensions. PDF is a rendered-image export, not editable vector atom geometry.
Video export requires at least two compatible frames. Every source frame is
kept exactly once at 1x; interpolation adds frames between sources and
requires stable atom count, ordering, element, and label identity across each
interpolated pair. MOV uses H.264 and AVI uses MPEG-4 through the bundled
imageio-ffmpeg runtime.
Install the optional Rhino writer with:
python -m pip install "v_ase-gui[rhino]"
Which format should I choose?
Goal |
Recommended choice |
|---|---|
Resume all scientific and visual work |
|
Resume work and preview/share in a browser |
Save Project HTML |
Share only an offline interactive view |
HTML View without project embedding |
Exchange ASE arrays and multiple frames as text |
Extended XYZ |
Preserve native ASE trajectory access |
|
Pass one current ASE object between trusted Python processes |
ASE Pickle |
Continue a VASP calculation workflow |
POSCAR/CONTCAR as appropriate |
Publish a raster figure |
PNG or lossless WebP |
Move geometry into a general 3D tool |
OBJ ZIP, Blender script, or optional 3DM |
When exact project restoration matters, validate by reopening the saved file with v_ase rather than assuming a visually similar interchange format retained the document state.