Skip to content

v1.0.0

Latest

Choose a tag to compare

@bjmorgan bjmorgan released this 28 Mar 15:49
381a359

vasppy v1.0.0

Breaking changes

  • Removed the custom Poscar class — all structure handling now uses pymatgen Structure. Code that imported vasppy.poscar.Poscar must be updated to use pymatgen.core.Structure or pymatgen.io.vasp.Poscar.
  • Removed dead modules: atom.py, pimaim.py, polyhedron.py, xdatcar.py and their associated scripts (pimaim_to_poscar, pimaim_to_xtl, poscar_to_pimaim, xdatcar_to_disp, xdatcar_to_rdf).
  • Removed --scale and --group flags from proc_poscar. pymatgen always folds the scaling factor into the lattice, so --scale is now the default behaviour. --group relied on arbitrary species labels not supported by pymatgen.
  • Requires Python 3.11+.

Improvements

  • Type hints and Google-style docstrings throughout all modules.
  • All mypy strict-mode errors resolved.
  • Refactored doscar.py pdos_select into composable helpers with guard-clause and normalise-then-act patterns.
  • Replaced manual lazy-loading with functools.cached_property in Vasprun.
  • Improved error handling: narrowed broad exception catches, added warnings for corrupt vasprun files, validated YAML inputs, added None checks for truncated XML.
  • Vectorised self-reference mask construction in dr_ij using NumPy broadcasting.
  • Module-level compiled regex constants in outcar.py.
  • CI improvements: mypy in its own job, dropped redundant pylint, fixed duplicate runs on feature branches.

Bug fixes

  • Fixed bitwise operator bug in Band.__eq__.
  • Fixed PROCAR k-point regex and KPoint.__eq__.
  • Fixed RDF initialisation with numpy array indices.
  • Fixed file handle leaks in outcar.py.
  • Fixed bare except and potcar_spec return type in summary.py.
  • Fixed swapped tensor element ordering in optics.py docstrings.
  • Fixed read_total_dos return type annotation.
  • Fixed dr_ij diagonal masking to only apply when indices_i == indices_j.