1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183
|
# -*- coding: utf-8 -*-
#
# Copyright (c) 2023, the cclib development team
#
# This file is part of cclib (http://cclib.github.io) and is distributed under
# the terms of the BSD 3-Clause License.
"""Test the various population analyses (MPA, LPA, CSPA, Bickelhaupt) in cclib"""
import sys
import os
import logging
import unittest
from typing import Type
import numpy
from cclib.method import CSPA, LPA, MPA, OPA, Bickelhaupt
from cclib.method.calculationmethod import MissingAttributeError, Method
from cclib.parser import Gaussian
sys.path.insert(1, "..")
from ..test_data import getdatafile
import pytest
class PopulationTest(unittest.TestCase):
"""Generic population method tests."""
methods = (CSPA, LPA, MPA, OPA, Bickelhaupt)
def parse(self) -> None:
self.data, self.logfile = getdatafile(Gaussian, "basicGaussian09", ["dvb_un_sp.log"])
def calculate(self, method_class: Type[Method]) -> None:
if not hasattr(self, 'data'):
self.parse()
self.analysis = method_class(self.data)
self.analysis.logger.setLevel(0)
self.analysis.calculate()
def testmissingrequiredattributes(self) -> None:
"""Is an error raised when required attributes are missing?"""
for missing_attribute in MPA.required_attrs:
self.parse()
delattr(self.data, missing_attribute)
for method_class in self.methods:
with pytest.raises(MissingAttributeError):
self.calculate(method_class)
def testmissingoverlaps(self) -> None:
"""Is an error raised when no overlaps are available?"""
self.parse()
for overlap_attribute in MPA.overlap_attributes:
if hasattr(self.data, overlap_attribute):
delattr(self.data, overlap_attribute)
for method_class in self.methods:
if method_class.overlap_attributes:
with pytest.raises(MissingAttributeError):
self.calculate(method_class)
class GaussianMPATest(unittest.TestCase):
"""Mulliken Population Analysis test"""
def setUp(self) -> None:
self.data, self.logfile = getdatafile(Gaussian, "basicGaussian09", ["dvb_un_sp.log"])
self.analysis = MPA(self.data)
self.analysis.logger.setLevel(0)
self.analysis.calculate()
def testsumcharges(self) -> None:
"""Do the Mulliken charges sum up to the total formal charge?"""
formalcharge = sum(self.data.atomnos) - self.data.charge
totalpopulation = sum(self.analysis.fragcharges)
assert abs(totalpopulation-formalcharge) < 1.0e-3
def testsumspins(self) -> None:
"""Do the Mulliken spins sum up to the total formal spin?"""
formalspin = self.data.homos[0] - self.data.homos[1]
totalspin = sum(self.analysis.fragspins)
assert abs(totalspin-formalspin) < 1.0e-3
class GaussianLPATest(unittest.TestCase):
"""Lowdin Population Analysis test"""
def setUp(self) -> None:
self.data, self.logfile = getdatafile(Gaussian, "basicGaussian09", ["dvb_un_sp.log"])
self.analysis = LPA(self.data)
self.analysis.logger.setLevel(0)
self.analysis.calculate()
def testsumcharges(self) -> None:
"""Do the Lowdin charges sum up to the total formal charge?"""
formalcharge = sum(self.data.atomnos) - self.data.charge
totalpopulation = sum(self.analysis.fragcharges)
assert abs(totalpopulation-formalcharge) < 0.001
def testsumspins(self) -> None:
"""Do the Lowdin spins sum up to the total formal spin?"""
formalspin = self.data.homos[0] - self.data.homos[1]
totalspin = sum(self.analysis.fragspins)
assert abs(totalspin-formalspin) < 1.0e-3
class GaussianCSPATest(unittest.TestCase):
"""C-squared Population Analysis test"""
def setUp(self) -> None:
self.data, self.logfile = getdatafile(Gaussian, "basicGaussian09", ["dvb_un_sp.log"])
self.analysis = CSPA(self.data)
self.analysis.logger.setLevel(0)
self.analysis.calculate()
def testsumcharges(self) -> None:
"""Do the CSPA charges sum up to the total formal charge?"""
formalcharge = sum(self.data.atomnos) - self.data.charge
totalpopulation = sum(self.analysis.fragcharges)
assert abs(totalpopulation-formalcharge) < 1.0e-3
def testsumspins(self) -> None:
"""Do the CSPA spins sum up to the total formal spin?"""
formalspin = self.data.homos[0] - self.data.homos[1]
totalspin = sum(self.analysis.fragspins)
assert abs(totalspin-formalspin) < 1.0e-3
class GaussianBickelhauptTest(unittest.TestCase):
"""Bickelhaupt Population Analysis test"""
def setUp(self) -> None:
super(GaussianBickelhauptTest, self).setUp()
self.data, self.logfile = getdatafile(Gaussian, "basicGaussian09", ["dvb_un_sp.log"])
self.analysis = Bickelhaupt(self.data)
self.analysis.logger.setLevel(0)
self.analysis.calculate()
def testsumcharges(self) -> None:
"""Do the Bickelhaupt charges sum up to the total formal charge?"""
formalcharge = sum(self.data.atomnos) - self.data.charge
totalpopulation = sum(self.analysis.fragcharges)
assert abs(totalpopulation-formalcharge) < 1.0e-3
def testsumspins(self) -> None:
"""Do the Bickelhaupt spins sum up to the total formal spin?"""
formalspin = self.data.homos[0] - self.data.homos[1]
totalspin = sum(self.analysis.fragspins)
assert abs(totalspin-formalspin) < 1.0e-3
def test_dvb_sp(self) -> None:
"""Testing Bickelhaupt charges (restricted) against outputs from Multiwfn."""
data, logfile = getdatafile(Gaussian, "basicGaussian09", ["dvb_sp.out"])
bpa = Bickelhaupt(data)
bpa.logger.setLevel(logging.ERROR)
bpa.calculate()
e_bpa = numpy.loadtxt(f"{os.path.dirname(os.path.realpath(__file__))}/dvb_sp.bpa")
assert numpy.all(bpa.fragcharges >= e_bpa - 0.05)
assert numpy.all(bpa.fragcharges <= e_bpa + 0.05)
def test_dvb_un_sp(self) -> None:
"""Testing Bickelhaupt charges (unrestricted) against outputs from Multiwfn."""
data, logfile = getdatafile(Gaussian, "basicGaussian09", ["dvb_un_sp.log"])
bpa = Bickelhaupt(data)
bpa.logger.setLevel(logging.ERROR)
bpa.calculate()
e_bpaalpha = numpy.loadtxt(f"{os.path.dirname(os.path.realpath(__file__))}/dvb_un_sp.bpa")
e_bpaspin = numpy.loadtxt(f"{os.path.dirname(os.path.realpath(__file__))}/dvb_un_sp.bpaspin")
assert numpy.all(bpa.fragcharges >= e_bpaalpha - 0.05)
assert numpy.all(bpa.fragcharges <= e_bpaalpha + 0.05)
assert numpy.all(bpa.fragspins >= e_bpaspin - 0.05)
assert numpy.all(bpa.fragspins <= e_bpaspin + 0.05)
tests = [GaussianMPATest, GaussianLPATest, GaussianCSPATest, GaussianBickelhauptTest]
if __name__ == "__main__":
for test in tests:
thistest = unittest.makeSuite(test)
unittest.TextTestRunner(verbosity=2).run(thistest)
|