An implementation of DOS fingerprints for the NOMAD Laboratory.
Project description
This package implements fingerprints of the electronic density-of-states (DOS) for the evaluation of similarity of materials based on their electronic structures.
The fingerprints are based on a modification on the D-Fingerprints presented in Ref. [1]. Our modification allows to target specific energy ranges for the evaluation of the similarity of the electronic structure. As a similarity measure we use the Tanimoto coefficient [2].
Usage
Fingerprints are instances of the DOSFingerprint()
class and can be calculated by providing the energy in [Joule] and the DOS in [states/unit cell/Joule] to the calculate()
method. Furthermore, the parameters of a non-uniform grid can be chosen. The default grid is specialized on the energy range between -10 and 5 eV and emphasizes the upper valence region.
from nomad_dos_fingerprints import DOSFingerprint
dos_fingerprint = DOSFingerprint().calculate(<dos_energies>,<dos_values>)
To evaluate the similarity, the function tanimoto_similarity()
can be used:
from nomad_dos_fingerprints import tanimoto_similarity
tc = tanimoto_similarity(dos_fingerprint_1, dos_fingerprint_2)
References
[1] Isayev et al., Chem. Mater. 2015, 27, 3, 735–743 (doi:10.1021/cm503507h)
[2] P. Willet et al., J. Chem. Inf. Comput . 38 , 983 996 (1998) (doi:10.1021/ci9800211)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for nomad_dos_fingerprints-1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 24702d8203fd8aafe80cf3ebb8acea921307a33e63ef313cddbf1ebd137c2f0a |
|
MD5 | ecdeca608883396b190fc9e26097df8f |
|
BLAKE2b-256 | 5815d7d22e6687330a9ef11fbe0b6ec5d8f3e36f09bae49cc0da0e1b8e96f505 |
Hashes for nomad_dos_fingerprints-1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 83ff010f8fe102f618291d7da7802c4ff9eb86be8f9da5ee3168dd4a7b9c7a24 |
|
MD5 | 45ecba8fa98ee46eb8ea102f93207cd5 |
|
BLAKE2b-256 | 10ba4602fd81bab7743cad44873408ad4304fd5bdfba2bd63b00e27bc182e6c1 |