Release notes

1.5.0

Added:

  • Support building libdiffpy on Windows with MSVC, clang or MinGW, merged from the upstream windows branch.

  • Export the public API from the Windows DLL with the DLL_EXPORT macro in diffpy/Export.hpp.

  • Install headers, libraries and data under $PREFIX or $CONDA_PREFIX by default, using the Library/ layout on Windows.

  • Add a clang-format pre-commit hook and .git-blame-ignore-revs for the reformat commits.

  • Codecov badge in the README.

  • Development guide in the documentation for build variants, running a subset of the unit tests, coverage analysis and testing changes with diffpy.srreal.

  • Release notes for version 1.4.1 in CHANGELOG.rst.

  • Library overview from the old manual on the docs/ index page.

Changed:

  • Format all C++ sources with clang-format (Google style).

  • Require ObjCryst by default. Build with enable_objcryst=False to skip it.

  • Restructure the README to follow the scikit-package template and point to the requirements folder instead of listing dependencies.

  • Describe the clang-format and codespell pre-commit hooks in the README.

  • Moved the Sphinx documentation from doc/manual/ to the scikit-package docs/ layout.

  • Read the documentation version from git tags through site_scons/libdiffpybuildutils.py.

  • Rename LICENSE_DANSE.txt to LICENSE_DANSE.rst to match diffpy.srreal and update all in-file references.

  • Include LICENSE.rst in the license page of the documentation instead of keeping a separate hand-formatted copy.

  • Publish docs automatically after a successful GitHub release.

  • Update the release checklist for GitHub and conda-forge releases without PyPI.

Fixed:

  • Pre-commit hooks now pass: fixed spelling in C++ comments, reformatted site_scons helpers, and excluded the vendored CxxTest tool and data tables.

  • Allow updating the fallback version before tagging a release by using it

only when no version can be determined from Git or source archive tags.

Removed:

  • Outdated docs/development_instructions.md, replaced by the development guide.

  • Old doc/manual/ Sphinx project.

  • Python automodule API page, which cannot document a C++ library.

1.4.1

Released 2025-06-25. Notable differences from version 1.4.0.

Added:

  • qbroad_seperable attribute to JeongPeakWidth for a Q-dependent peak broadening term, see https://doi.org/10.1107/S0108767391011327.

  • Build scripts for Windows.

  • GitHub release with the source tarball SHA256 created automatically after a tag push.

Changed:

  • Require libobjcryst 2017.2.1 or later.

  • Add the conda environment include and library paths to the build when CONDA_PREFIX is set.

  • Do not create OverlapCalculator self-neighborhoods at sites excluded by the pair mask.

Removed:

  • Runtime check for the ObjCryst inversion center bug, which is fixed in libobjcryst 2017.2.1.

Fixed:

  • OverlapCalculator now respects its rmin value.

  • Build with REAL=double to match the floating-point type of libobjcryst.

  • Read the installation prefix from the PREFIX environment variable.

1.4.0

Released 2019-03-09. Notable differences from version 1.3.4.

Added:

  • Test coverage analysis at https://codecov.io/gh/diffpy/libdiffpy.

  • Make scons scripts compatible with Python 3 and Python 2.

  • Atomic numbers and possible ions for elements 99-103.

  • Define libdiffpy version requirements for client Anaconda packages.

  • Support free-standing attribute getter and setter functions.

  • uisowidth and bisowidth attributes to ConstantPeakWidth class. This simplifies PDF modeling of structures with uniform isotropic atom displacements.

Changed:

  • Build Anaconda package with Anaconda C++ compiler.

  • Adopt language standard c++11.

  • Replaced boost unordered set and map types with their STL version.

  • Switch to direct serialization of PeakWidthModel, PeakProfile, PDFEnvelope, PDFBaseline, and ScatteringFactorTable classes and derived types.

Deprecated:

  • StructureAdapter::customPQConfig function because it permits unexpected changes in calculators setup and complicates parallel evaluation.

Fixed:

  • Incorrect results for crystals with off-origin inversion center.

  • Incomplete scons install when shared library fails to compile.

  • Use of invalid iterators when removing map items.

Removed:

  • Virtual class inheritance of BaseDebyeSum and DebyePDFCalculator.