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](https://github.com/fury-gl/fury)

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 <inputfile>

Control Inputs:

‘u’ : Toggle UI visibility ‘a’ : Toggle Axis visibility SHIFT + ‘s’ : Take snapshot CTRL + ‘w’ : Exit

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 <inputfile> python main.py <inputfile> <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.5.tar.gz (24.3 kB view details)

Uploaded Source

Built Distribution

XtraCrysPy-0.7.5-py3-none-any.whl (29.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: XtraCrysPy-0.7.5.tar.gz
  • Upload date:
  • Size: 24.3 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.5.tar.gz
Algorithm Hash digest
SHA256 3567e18ab481a70dbf17b69029bbf700d36cc93bde054e57a24de79535f10daf
MD5 3b99a78c801207d16c360086541e30a4
BLAKE2b-256 6f7d5a940fd51991f839cfc3acb7d33669cd26118bbb466ff2ab18553fcc4fbc

See more details on using hashes here.

File details

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

File metadata

  • Download URL: XtraCrysPy-0.7.5-py3-none-any.whl
  • Upload date:
  • Size: 29.1 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.5-py3-none-any.whl
Algorithm Hash digest
SHA256 c2b3b6a30cf061ed68bc14ea7751c8f58f84a820432acc939128ee5b8a9467ed
MD5 d52e198f720ff877c4662ffa7ac76a44
BLAKE2b-256 466c6f91ba531642e7e92e5dcd4ee7f6c7df081e00766ea32ecf542fe36618e9

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