Skip to main content

PyCDT is a python package to facilitate DFT calculations for point defects in solids

Project description

Python Charge Defects Toolkit (PyCDT) is a python package aimed at making charged defects modeling simpler, high throughput ready, and also accessible to researchers who don’t have the required background. PyCDT can handle thermodynamic calculations and error corrections in the context of periodic boundary condition density functional calculations of charged defects in semiconductors and insulators. It can also generate the inputs for required DFT calculations and can process the output of the DFT calculations. The code is modular and any DFT code can be integrated into PyCDT for defect calculations.

Requirements

PyCDT requires pymatgen (and its dependencies) and optionally sxdefectalign packages.

Source Code

If not available already, use the following steps.

  1. Install git, if not already packaged with your system.

  2. Download the pycdt source code using the command:

    git clone https://bitbucket.org/mbkumar/pycdt.git

Installation

  1. Navigate to pycdt root directory:

    cd pycdt
  2. Install the code, using the command:

    python setup.py install

    The command tries to obtain the required packages and their dependencies and install them automatically. Access to root may be needed if virtualenv is not used.

  3. The package can be installed at non-standard locations using the command:

    python setup.py install --prefix PYCDT_INSTALL_DIR

    where PYCDT_INSTALL_DIR is your choice of directory. In UNIX/Linux environments, add PYCDT_INSTALL_DIR to PATH and PYTHONPATH variables by the following commands:

    export PATH=$PATH:PYCDT_INSTALL_DIR
    export PYTHONPATH=$PYTHONPATH:PYCDT_INSTALL_DIR
  4. (If not set) Set the VASP pseudopotential directory in $HOME/.pmgrc.yaml as follows:

    VASP_PSP_DIR: <Location of vasp pseudopotential top directory>
  5. (If not set) Set the Materials Project API key in $HOME/.pmgrc.yaml as follows:

    MAPI_KEY: <Your mapi key obtained from www.materialsproject.org>

Examples

From the pycdt root folder, go to examples folder by typing:

cd examples

Questions?

Post your questions on PyCDT forum.

Download files

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

Source Distribution

pycdt-2.0.2.tar.gz (68.1 kB view details)

Uploaded Source

File details

Details for the file pycdt-2.0.2.tar.gz.

File metadata

  • Download URL: pycdt-2.0.2.tar.gz
  • Upload date:
  • Size: 68.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.19.1 setuptools/40.4.3 requests-toolbelt/0.9.1 tqdm/4.26.0 CPython/3.6.6

File hashes

Hashes for pycdt-2.0.2.tar.gz
Algorithm Hash digest
SHA256 45ef17c4da3369ee916942ae0daa19a4c9472724659aa5e5536aa5aabc593423
MD5 247f202cf8424882f2967215ce49b46c
BLAKE2b-256 378d409974de838a3f807ff2738af48572a98c140785848fecc3aa34eee3e949

See more details on using hashes here.

Supported by

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