A Python tool for visualizing atomic systems and properties of condensed matter.
Project description
XtraCrysPy
A Python tool for visualizing atomic systems and spatial properties of condensed matter.
Features:
- Plot molecular systems with minimal setup
- Plot systems from DFT or MD input/output files
- Interact with the system to caluclate distances, angles, or receive atomic information
- Display relaxation or MD steps from QE relax output, raw coordinates, LAMMPS trajectory files, or CP2K (xyz)
- Display reciprocal space features
- Plot real space iso-surfaces (charge density, etc)
- Plot reciprocal iso-surfaces (Fermi surface, spin-texture, etc)
Supported File Types:
- Quantum ESPRESSO input or output
- POSCAR
- CIF
- XSF
- CP2K
- BXSF (coming soon)
- Any ASE supported format
Requirements:
Installation:
The Anaconda Python distribution is recommended.
Install with pip:
- pip install xtracryspy
Install from source:
- python setup.py install
- python setup.py install --user
(only use --user if you do not have permission to install python packages)
Control Inputs:
- 'u' : Toggle UI visibility
- 'a' : Toggle Axis visibility
- 'b' : Toggle Boundary visiblity
- 'c' : Toggle constraint of atoms within cell
- 'k' : Toggle the reciprocal lattice vector visibility
- 's' : Togle the selection type panel visibility
- 'n' : Toggle the cell repition panel visibility
- '>' : Step forward in relax or MD
- '<' : Step backward in relax or MD
- CTRL + ('>' or '<') : Step 5% through the relaxation or MD steps
- SHIFT + 'o' : Report the camera position and orientation
- SHIFT + 'c' : Reset camera to default position
- SHIFT + 's' : Take snapshot
- CTRL + 'w' : Exit
- Arrow Keys : Rotate model
- SHIFT + Arrow Keys : Translate camera
- CTRL + Arrow Keys (+ SHIFT) : Rotate (or Translate) in smaller steps
Display an atomic model from inputfile, with the examples/main.py script:
- python main.py <input_file>
- python main.py <input_file> <bond_distance>
Examples:
Available in the examples directory
From scratch:
- python CNO3.py
- python caffeine.py
- python silicon_fcc.py
- python example_motion.py
- python example_textured_isosurface.py
From inputfile (with main.py script):
- python main.py <input_file>
- python main.py <input_file> <bond_distance>
From inputfile (programmatic):
- python SnTe_2D.py
- python example_cif.py
- python example_cp2k.py
- python example_qe_in.py
- python example_poscar.py
Relax QE outputfile:
- python example_relax.py
LAMMPS MD trajectory:
- python example_lammps_md.py
Charge Density:
- python example_charge_density.py
Reciprocal Space:
- python example_BZ.py
Isosurfaces:
- python example_isosurface1.py
- python example_isosurface2.py
- python example_isosurface_clip.py
- python example_colored_isosurface.py
- python example_textured_isosurface.py
- python example_textured_isosurface_clip.py
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
XtraCrysPy-1.0.1.tar.gz
(28.3 kB
view hashes)
Built Distribution
XtraCrysPy-1.0.1-py3-none-any.whl
(33.7 kB
view hashes)
Close
Hashes for XtraCrysPy-1.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 589eb4f7c00d7b5bab1d8c30e870bd7badd8b92c07393dc3d6e4090a41906fd9 |
|
MD5 | 85b1f7ba0d1f98c6e85ebbea141dc75a |
|
BLAKE2b-256 | 024629944adb1f1a718531e184c064d1c0f4b4cebb9cac1204b5d7ff28cbe66b |