Skip to main content

A Python tool for visualizing atomic systems and properties of condensed matter.

Project description

XtraCrysPy

A Python tool for visualizing atomic systems and properties of condensed matter.

Features:

  • Plot molecular systems with minimal setup
  • Plot systems from DFT input- or output- files
  • Interact with the system to caluclate distances, angles, or receive atomic information
  • Display relaxation steps from QE relax output files
  • Display reciprocal space features
  • Plot real space iso-surfaces (charge density, etc)
  • Plot reciprocal iso-surfaces (Fermi surface, spin-texture, etc)
  • Band structure and DoS plots from QE or PAOFLOW data
  • Electron Transport plots from PAOFLOW data

Supported File Types:

  • Quantum ESPRESSO input or output
  • POSCAR
  • CIF (in progress)
  • XSF
  • BXSF (coming soon)

Requirements:

  • python 3.8
  • numpy 1.19
  • matplotlib 3.5
  • fury 0.8

Installation (only use --user if you do not have permission to install python packages):

  • python setup.py install
  • python setup.py install --user

Usage:

Display an atomic model from inputfile, with the examples/main.py script: python main.py

Control Inputs: 'u' : Toggle UI visibility 'a' : Toggle Axis visibility 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

See examples directory for crystal and Brillouin zone plotting:

From scratch: python caffeine.py python silicon_fcc.py

From inputfile (with main.py script): python main.py python main.py <bond_length>

From inputfile (programmatic): python SnTe_2D.py python example_cif.py python example_qe_in.py python example_poscar.py

Relax QE outputfile: python example_relax.py

Charge Density: python example_charge_density.py

Reciprocal Space: python example_BZ.py

Fermi Surfaces: python example_fermi_surface1.py python example_fermi_surface2.py python example_fermi_surface_clip.py python example_colored_fermi_surface.py python example_textured_fermi_surface_clip.py

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

XtraCrysPy-0.7.6.tar.gz (27.1 kB view details)

Uploaded Source

Built Distribution

XtraCrysPy-0.7.6-py3-none-any.whl (49.7 kB view details)

Uploaded Python 3

File details

Details for the file XtraCrysPy-0.7.6.tar.gz.

File metadata

  • Download URL: XtraCrysPy-0.7.6.tar.gz
  • Upload date:
  • Size: 27.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.8.8

File hashes

Hashes for XtraCrysPy-0.7.6.tar.gz
Algorithm Hash digest
SHA256 68205651260c3d5b2ea3a24ba33eae73296bc25466107062799187b4a847a3f7
MD5 3974b32e8e80399aef62c0c02877de4b
BLAKE2b-256 887e1fd56822d4d075c7a07253b7275ea27edb98d608e70cc9eeed7861c0caf0

See more details on using hashes here.

File details

Details for the file XtraCrysPy-0.7.6-py3-none-any.whl.

File metadata

  • Download URL: XtraCrysPy-0.7.6-py3-none-any.whl
  • Upload date:
  • Size: 49.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.8.8

File hashes

Hashes for XtraCrysPy-0.7.6-py3-none-any.whl
Algorithm Hash digest
SHA256 2413e871d37786318d15cf6e3b90e0d4e5c8b393eb32550223cb97fa61040bad
MD5 d13caa32ab2ed5eca717bb6500e14df9
BLAKE2b-256 f8f8f553e0ef125cb375bb95823df4a59c4232a3a21cdb4f98cfd896476756b3

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page