Skip to main content

Self-consistent Fermi Analysis

Project description

py-sc-fermi

Build Status Test Coverage Documentation Status

py-sc-fermi is a materials modelling code for calculating self-consistent Fermi energies and defect concentrations under thermodynamic equlibrium given defect formation energies. For the theory, see this paper.
The necessary inputs are (charged) defect formation energies, an (electronic) density of states and the volume of the unit cell. Having this data, a DefectSystem object can be inititalised, properties of which include the self consistent Fermi energy, defect concentrations and defect transition levels.

Documentation and usage guides can be found here.

Citing

If you use py-sc-Fermi in your work, please consider citing

  • this repository (see cite this repository in the sidebar)

  • the paper associated with the FORTRAN code SC-Fermi on which this code was initially based, and provides an excellent discussion of both the underlying theory and the self-consitent Fermi energy searching algorithm

    J. Buckeridge, Equilibrium point defect and charge carrier concentrations in a material determined through calculation of the self-consistent Fermi energy, Computer Physics Communications, Volume 244, 2019, Pages 329-342, ISSN 0010-4655, https://doi.org/10.1016/j.cpc.2019.06.017.

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

py-sc-fermi-0.2.0.tar.gz (15.2 kB view details)

Uploaded Source

Built Distribution

py_sc_fermi-0.2.0-py3-none-any.whl (17.2 kB view details)

Uploaded Python 3

File details

Details for the file py-sc-fermi-0.2.0.tar.gz.

File metadata

  • Download URL: py-sc-fermi-0.2.0.tar.gz
  • Upload date:
  • Size: 15.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.9.10

File hashes

Hashes for py-sc-fermi-0.2.0.tar.gz
Algorithm Hash digest
SHA256 bf51926b2d5c48d3ada7aeddfb18ef5995ee07b5f163d0b7b97eed4f1e3a539c
MD5 ace0018e3d38b17b48315f73ae73fc73
BLAKE2b-256 d69e611ba56f17ef42e87ab1af6609ba592a8c097b9d924684ad8281484b1fd2

See more details on using hashes here.

File details

Details for the file py_sc_fermi-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: py_sc_fermi-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 17.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.9.10

File hashes

Hashes for py_sc_fermi-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3ff83c3c0b025888298fa8d64c33604be7c85e003328733ff91999e9236c45c1
MD5 17d8e5540daa93a8030e9166e20488f0
BLAKE2b-256 d0e8c47ed2583c2ee71439ad75efc78a39df354610635772a50b07eed5d988a8

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