kim-tools 0.3.2__py3-none-any.whl → 0.3.4__py3-none-any.whl

kim_tools/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "0.3.2"
+__version__ = "0.3.4"
 
 from .aflow_util import *
 from .aflow_util import __all__ as aflow_all

kim_tools/aflow_util/core.py

@@ -552,12 +552,32 @@ def find_species_permutation_between_prototype_labels(
     # Disassemble prototype_label_1
     stoich_reduced_list_1 = get_stoich_reduced_list_from_prototype(prototype_label_1)
     pearson_1 = get_pearson_symbol_from_prototype(prototype_label_1)
-    space_group_1 = str(get_space_group_number_from_prototype(prototype_label_1))
+    space_group_1 = get_space_group_number_from_prototype(prototype_label_1)
+    space_group_1_str = str(space_group_1)
     species_wyckoff_sections_1 = prototype_label_1.split("-")[0].split("_")[3:]
 
     nspecies = len(stoich_reduced_list_1)
     assert nspecies == len(species_wyckoff_sections_1)
 
+    # For crystals with many species, it takes forever to loop through all permutations,
+    # so do some basic checks first to reject
+    stoich_reduced_list_2 = get_stoich_reduced_list_from_prototype(prototype_label_2)
+    pearson_2 = get_pearson_symbol_from_prototype(prototype_label_2)
+    space_group_2 = get_space_group_number_from_prototype(prototype_label_2)
+    if (
+        len(stoich_reduced_list_1) != len(stoich_reduced_list_2)
+        or sum(stoich_reduced_list_1) != sum(stoich_reduced_list_2)
+        or pearson_1 != pearson_2
+    ):
+        return None
+
+    if allow_enantiomorph:
+        if not space_group_numbers_are_enantiomorphic(space_group_1, space_group_2):
+            return None
+    else:
+        if space_group_1 != space_group_2:
+            return None
+
     permutation_candidates = permutations(tuple(range(nspecies)))
     for permutation in permutation_candidates:
         # Permute the species
@@ -573,13 +593,14 @@ def find_species_permutation_between_prototype_labels(
         prototype_label_1_permuted_list = [
             abstract_formula_1_permuted,
             pearson_1,
-            space_group_1,
+            space_group_1_str,
         ] + species_wyckoff_sections_1_permuted
         prototype_label_1_permuted = "_".join(prototype_label_1_permuted_list)
         if prototype_labels_are_equivalent(
             prototype_label_1=prototype_label_1_permuted,
             prototype_label_2=prototype_label_2,
             allow_enantiomorph=allow_enantiomorph,
+            log=log,
         ):
             return permutation
     return None
@@ -618,6 +639,23 @@ def read_shortnames(
         with open(info_file) as f:
             info = json.load(f)
         shortnames[libproto] = info["title"]
+
+    ##################################################
+    # CUSTOM MODIFICATIONS TO SHORTNAME DICT
+    ##################################################
+    # For some reason, CsCl is AB_cP2_221_a_b-002,
+    # while AB_cP2_221_a_b-001 is Ammonium Nitrate,
+    # where the atoms represent molecular ions
+    shortnames.pop("AB_cP2_221_a_b-001")
+
+    # I am making an executive decision to include
+    # only one identical cubic prototype with no
+    # free parameters. Here I am choosing to keep
+    # 'A7B_cF32_225_ad_b-001': 'Ca₇Ge Structure'
+    # and remove
+    # 'AB7_cF32_225_a_bd-001': '𝐿1ₐ (disputed CuPt₃ Structure)'
+    shortnames.pop("AB7_cF32_225_a_bd-001")
+
     return shortnames
 
 

kim_tools/ase/core.py

@@ -32,13 +32,20 @@ Helper routines for KIM Tests and Verification Checks
 """
 
 import itertools
+import logging
 import random
+from typing import Union
 
 import numpy as np
 from ase import Atoms
+from ase.calculators.calculator import Calculator
 from ase.calculators.kim.kim import KIM
 from ase.data import chemical_symbols
 
+logger = logging.getLogger(__name__)
+logging.basicConfig(filename="kim-tools.log", level=logging.INFO, force=True)
+
+
 __all__ = [
     "KIMASEError",
     "atom_outside_cell_along_nonperiodic_dim",
@@ -201,9 +208,18 @@ def randomize_positions(atoms, pert_amp, seed=None):
 
 
 ################################################################################
-def get_isolated_energy_per_atom(model, symbol):
+def get_isolated_energy_per_atom(model: Union[str, Calculator], symbol):
     """
     Construct a non-periodic cell containing a single atom and compute its energy.
+
+    Args:
+        model:
+            A KIM model ID or an ASE calculator for computing the energy
+        symbol:
+            The chemical species
+
+    Returns:
+        The isolated energy of a single atom
     """
     single_atom = Atoms(
         symbol,
@@ -211,7 +227,15 @@ def get_isolated_energy_per_atom(model, symbol):
         cell=(20, 20, 20),
         pbc=(False, False, False),
     )
-    calc = KIM(model)
+    if isinstance(model, str):
+        calc = KIM(model)
+    elif isinstance(model, Calculator):
+        calc = model
+    else:
+        raise KIMASEError(
+            "`model` argument must be a string indicating a KIM model "
+            f"or an ASE Calculator. Instead got an object of type {type(model)}."
+        )
     single_atom.calc = calc
     energy_per_atom = single_atom.get_potential_energy()
     if hasattr(calc, "clean"):

kim_tools/test_driver/core.py

@@ -490,6 +490,13 @@ class KIMTestDriver(ABC):
             the Test Driver
     """
 
+    class NonKIMModelError(Exception):
+        """
+        Raised when a KIM model name is requested but is absent. This is important
+        to handle to inform users that they are trying to run a Test Driver that
+        requires a KIM model (e.g. a LAMMPS TD) with a non-KIM Calculator
+        """
+
     def __init__(self, model: Union[str, Calculator]) -> None:
         """
         Args:
@@ -690,7 +697,13 @@ class KIMTestDriver(ABC):
         """
         Get the KIM model name, if present
         """
-        return self.__kim_model_name
+        if self.__kim_model_name is not None:
+            return self.__kim_model_name
+        else:
+            raise self.NonKIMModelError(
+                "A KIM model name is being requested, but the Test Driver "
+                "is being run with a non-KIM calculator."
+            )
 
     @property
     def property_instances(self) -> Dict:

{kim_tools-0.3.2.dist-info → kim_tools-0.3.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: kim-tools
-Version: 0.3.2
+Version: 0.3.4
 Summary: Base classes and helper routines for writing KIM Tests
 Author-email: ilia Nikiforov <nikif002@umn.edu>, Ellad Tadmor <tadmor@umn.edu>, Claire Waters <bwaters@umn.edu>, "Daniel S. Karls" <karl0100umn@gmail.com>, Matt Bierbaum <matt.bierbaum@gmail.com>, Eric Fuemmeler <efuemmel@umn.edu>, Philipp Hoellmer <ph2484@nyu.edu>, Guanming Zhang <gz2241@nyu.edu>, Tom Egg <tje3676@nyu.edu>
 Maintainer-email: ilia Nikiforov <nikif002@umn.edu>
@@ -32,7 +32,7 @@ Dynamic: license-file
 
 # kim-tools
 
-![testing](https://github.com/openkim/kim-tools/actions/workflows/testing.yml/badge.svg)
+[![Testing](https://github.com/openkim/kim-tools/actions/workflows/testing.yml/badge.svg)](https://github.com/openkim/kim-tools/actions/workflows/testing.yml)
 [![docs](https://app.readthedocs.org/projects/kim-tools/badge/?version=latest)](https://kim-tools.readthedocs.io/en/latest/)
 [![PyPI](https://img.shields.io/pypi/v/kim-tools.svg)](https://pypi.org/project/kim-tools/)
 

{kim_tools-0.3.2.dist-info → kim_tools-0.3.4.dist-info}/RECORD

@@ -1,7 +1,7 @@
-kim_tools/__init__.py,sha256=AhAW6unNWB_4jaiwxb0_XxUKtCv1rwG3CNqLk4aqqso,433
+kim_tools/__init__.py,sha256=CIQpbBUyJLgWZum2kUjz-jAOWw54_hO5_hHgtBV2DEM,433
 kim_tools/kimunits.py,sha256=jOxBv9gRVhxPE6ygAIUxOzCAfPI6tT6sBaF_FNl9m-M,5387
 kim_tools/aflow_util/__init__.py,sha256=lJnQ8fZCma80QVRQeKvY4MQ87oCWu-9KATV3dKJfpDc,80
-kim_tools/aflow_util/core.py,sha256=CsqN6MNVXE4QFrM0SxWhahTwu_gTeUXITk7ZMXLXfv0,75954
+kim_tools/aflow_util/core.py,sha256=zi69wMcgkcYBTKbc-OvKlMIzUtgphO57yBA8LB7_5wc,77484
 kim_tools/aflow_util/aflow_prototype_encyclopedia/data/A108B24C11D24_cP334_222_h4i_i_bf_i-001/info.json,sha256=IsFiO9X2Ko7yoq2QkDurUVP7k1BE4WFgblu7oxl6iZs,2013
 kim_tools/aflow_util/aflow_prototype_encyclopedia/data/A10B11_tI84_139_dehim_eh2n-001/info.json,sha256=f1EdtouuSL2y9NNw40Rvz2J9ZZcsqQBcyEmlHj6XoW8,1186
 kim_tools/aflow_util/aflow_prototype_encyclopedia/data/A10B2C_hP39_171_5c_c_a-001/info.json,sha256=vD1xjZKWShL0E6XNsSlmIhilGcGNefl56oQDLQlHO1M,1596
@@ -2002,7 +2002,7 @@ kim_tools/aflow_util/aflow_prototype_encyclopedia/data/A_tP4_129_ac-001/info.jso
 kim_tools/aflow_util/aflow_prototype_encyclopedia/data/A_tP4_136_f-001/info.json,sha256=5_xlFGOov7VoFwzhp7JtltRnWiAFfgpwF5qc3kMSAjQ,1278
 kim_tools/aflow_util/aflow_prototype_encyclopedia/data/A_tP50_134_a2m2n-001/info.json,sha256=K601zsKLpvPLIaK17bEiNGIQJYJDvIby1lIJ3P9Ze6E,1258
 kim_tools/ase/__init__.py,sha256=1i6ko5tNr0VZC3T7hoEzq4fnSU0DdxNpxXcSaWMcJWc,76
-kim_tools/ase/core.py,sha256=d6eOu_HSxVr-ae0TSEbY4HKdePxhNu3yv8NN9VDl-BA,30256
+kim_tools/ase/core.py,sha256=ByiwAUBZzbhbXyfdnea5XTIbK6LSOUMCOy20_AFgbAQ,30991
 kim_tools/symmetry_util/__init__.py,sha256=uu-ZSUDUTe2P81rkAS3tXverx31s_uZ3wL4SD_dn5aI,86
 kim_tools/symmetry_util/core.py,sha256=HfDy1CwNWUZIkb4cs3ebUDgWjtt4jRSkBKgGEnlkjuI,30888
 kim_tools/symmetry_util/data/possible_primitive_shifts.json,sha256=4OVNgn3NnykgGlYiAcecERmVWiIZFrmP2LZI3ml_Sh0,25010
@@ -2012,11 +2012,11 @@ kim_tools/symmetry_util/data/wyck_pos_xform_under_normalizer.json,sha256=6g1YuYh
 kim_tools/symmetry_util/data/wyckoff_multiplicities.json,sha256=qG2RPBd_-ejDIfz-E4ZhkHyRpIboxRy7oiXkdDf5Eg8,32270
 kim_tools/symmetry_util/data/wyckoff_sets.json,sha256=f5ZpHKDHo6_JWki1b7KUGoYLlhU-44Qikw_-PtbLssw,9248
 kim_tools/test_driver/__init__.py,sha256=KOiceeZNqkfrgZ66CiRiUdniceDrCmmDXQkOw0wXaCQ,92
-kim_tools/test_driver/core.py,sha256=r4hiZcV-PkWcOo0uEqfqeP1-YGGpPepaAjmR4LJog0w,89208
+kim_tools/test_driver/core.py,sha256=Q388GSKFVvwNIMElt4dHmLd_rJOxQeUG0QIbXmrhYHc,89763
 kim_tools/vc/__init__.py,sha256=zXjhxXCKVMLBMXXWYG3if7VOpBnsFrn_RjVpnohDm5c,74
 kim_tools/vc/core.py,sha256=BIjzEExnQAL2S90a_npptRm3ACqAo4fZBtvTDBMWMdw,13963
-kim_tools-0.3.2.dist-info/licenses/LICENSE.CDDL,sha256=I2luEED_SHjuZ01B4rYG-AF_135amL24JpHvZ1Jhqe8,16373
-kim_tools-0.3.2.dist-info/METADATA,sha256=EAQFkPk6S0svLhGMBstoSj4Kk9vdzbIDATWefRyb8zE,1962
-kim_tools-0.3.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-kim_tools-0.3.2.dist-info/top_level.txt,sha256=w_YCpJ5ERigj9te74ln7k64tqj1VumOzM_s9dsalIWY,10
-kim_tools-0.3.2.dist-info/RECORD,,
+kim_tools-0.3.4.dist-info/licenses/LICENSE.CDDL,sha256=I2luEED_SHjuZ01B4rYG-AF_135amL24JpHvZ1Jhqe8,16373
+kim_tools-0.3.4.dist-info/METADATA,sha256=SHsn9LcUrsa7Yg8huy7EfOTJ1MT7c0t4z0EMGvzP9YY,2032
+kim_tools-0.3.4.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+kim_tools-0.3.4.dist-info/top_level.txt,sha256=w_YCpJ5ERigj9te74ln7k64tqj1VumOzM_s9dsalIWY,10
+kim_tools-0.3.4.dist-info/RECORD,,