Skip to content

Commit

Permalink
Add additional metadata to default CIF comment string
Browse files Browse the repository at this point in the history
Should a bug be found in either pymatgen's CIFWriter or spglib, a key package depended upon by pymatgen, this updated comment string will make it easier to find affected CIF files.

Signed-off-by: Matthew Horton <mkhorton@users.noreply.github.com>
  • Loading branch information
mkhorton authored Aug 10, 2024
1 parent 1bfd330 commit f7b65c0
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions src/pymatgen/io/cif.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,9 @@
from monty.dev import deprecated
from monty.io import zopen
from monty.serialization import loadfn
from spglib import __version__ as __spglib_version__

from pymatgen.core import Composition, DummySpecies, Element, Lattice, PeriodicSite, Species, Structure, get_el_sp
from pymatgen.core import Composition, DummySpecies, Element, Lattice, PeriodicSite, Species, Structure, get_el_sp, __version__
from pymatgen.core.operations import MagSymmOp, SymmOp
from pymatgen.electronic_structure.core import Magmom
from pymatgen.symmetry.analyzer import SpacegroupAnalyzer, SpacegroupOperations
Expand Down Expand Up @@ -254,7 +255,7 @@ def __init__(
"""
self.data = data
self.orig_string = orig_string
self.comment: str = comment or "# generated using pymatgen"
self.comment: str = comment or f"# generated using pymatgen {__version__} (spglib {__spglib_version__})"

def __str__(self) -> str:
out = "\n".join(map(str, self.data.values()))
Expand Down

0 comments on commit f7b65c0

Please sign in to comment.