Skip to main content

A unified package for optical properties of point defects.

Project description

DefectPl

A unified package to calculate and plot optical properties of point defects in insulators and semiconductors.

image Downloads Conda Recipe Anaconda image Conda Downloads image

Purpose of the Package

The purpose of this package is to calculate the intensity of photoluminescence from point defects in solids with method described in New J. Phys. 16 (2014) 073026. It also calculates and plot other relevant quantities like partial Huang Rhys factor, inverse participation ratio etc.

Documentation

For documentation check : https://Shibu778.github.io/defectpl/

Getting Started

The package can be found in pypi. You can install it using pip.

Installation

pip install defectpl

Using conda

conda install conda-forge::defectpl

Using the GitHub clone

git clone https://github.com/Shibu778/defectpl.git
cd defectpl/defectpl
pip install -e .

Usage

Following is an example usage with the data stored in tests/data for NV center in diamond.

from defectpl.defectpl import DefectPl

band_yaml = "../tests/data/band.yaml"
contcar_gs = "../tests/data/CONTCAR_gs"
contcar_es = "../tests/data/CONTCAR_es"
out_dir = "./plots"
EZPL = 1.95
gamma = 2
plot_all = True
iplot_xlim = [1000, 2000]

defctpl = DefectPl(
    band_yaml,
    contcar_gs,
    contcar_es,
    EZPL,
    gamma,
    iplot_xlim=iplot_xlim,
    plot_all=plot_all,
    out_dir=out_dir,
)

Contribution

Contributions are welcome. Notice a bug let us know. Thanks.

Author

Main Maintainer: Shibu Meher

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

defectpl-0.1.2.tar.gz (9.8 kB view details)

Uploaded Source

Built Distribution

defectpl-0.1.2-py3-none-any.whl (10.2 kB view details)

Uploaded Python 3

File details

Details for the file defectpl-0.1.2.tar.gz.

File metadata

  • Download URL: defectpl-0.1.2.tar.gz
  • Upload date:
  • Size: 9.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.11.4 Windows/10

File hashes

Hashes for defectpl-0.1.2.tar.gz
Algorithm Hash digest
SHA256 de8e0b85743474554a38c0797c5db81f8d616c93c3f33679a4cd4eaab4495944
MD5 a7fed9596e890d1001868cafd6c427b2
BLAKE2b-256 0a32dd6d246bc08c9fd4378488bd27cdb23975a698f122d687d99ba16ec65ae2

See more details on using hashes here.

File details

Details for the file defectpl-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: defectpl-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 10.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.11.4 Windows/10

File hashes

Hashes for defectpl-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 a98e179404d6ad74f090a429eb4cec8fa103b49514de9fd29852f5513d3b8423
MD5 31fe310f9866021f98337de2c9c171b2
BLAKE2b-256 444e7776d3ccc4f8d0b2605e0b507f56d3faafec092c04731b871525b4fb8fe8

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