Madminer Versions Save

Bug fixes

• Fix typo in _calculate_partition_bounds method calls (https://github.com/madminer-tool/madminer/pull/524).

Internal changes:

• Drop support for Python 3.7 (https://github.com/madminer-tool/madminer/pull/527) (support ends on June 2023).
• Lint all codebase with Black 22.12.0 (https://github.com/madminer-tool/madminer/pull/525).
• Lint all codebase with Isort 5.11.3 (https://github.com/madminer-tool/madminer/pull/526).
• Migrate default branch from master to main.

Full Changelog: https://github.com/madminer-tool/madminer/compare/v0.9.5...v0.9.6

Bug fixes

• Fix calculation of Fisher information when there are no nuisance parameters (https://github.com/madminer-tool/madminer/pull/519).
• Fix missing sympy dependency on Conda environment.yml file (https://github.com/madminer-tool/madminer/pull/522).

Internal changes:

• Change HDF5 settings load messages from ERROR to INFO level (https://github.com/madminer-tool/madminer/pull/518).

Full Changelog: https://github.com/madminer-tool/madminer/compare/v0.9.4...v0.9.5

New features:

• Added overdetermined morphing (https://github.com/madminer-tool/madminer/pull/506).
• Added overdetermined morphing Jupyter notebook (https://github.com/madminer-tool/madminer/pull/506).

Internal changes:

• Removed the default values of the hdf5.py save_events public function (https://github.com/madminer-tool/madminer/pull/504).
• Added Python 3.10 to the list of CI/CD tested Python versions (https://github.com/madminer-tool/madminer/pull/510).

Full Changelog: https://github.com/madminer-tool/madminer/compare/v0.9.3...v0.9.4

Bug fixes

• Fix HDF5 serialization for Observable, NuisanceParameter and Systematic models. https://github.com/madminer-tool/madminer/pull/503

Internal changes:

• Make save_events sampling_benchmarks argument mandatory. https://github.com/madminer-tool/madminer/pull/503

Full Changelog: https://github.com/madminer-tool/madminer/compare/v0.9.2...v0.9.3

Bug fixes

• Fix Fisher information covariance calc. https://github.com/madminer-tool/madminer/pull/496
• Add MWST sets to the accepted nuisance params. https://github.com/madminer-tool/madminer/pull/500

Internal changes:

• Remove legacy XML imports. https://github.com/madminer-tool/madminer/pull/497
• Migrate path related operations to pathlib. https://github.com/madminer-tool/madminer/pull/499
• Migrate package setup spec to setup.cfg. https://github.com/madminer-tool/madminer/pull/498

Full Changelog: https://github.com/madminer-tool/madminer/compare/v0.9.1...v0.9.2

Bug fixes:

• Fixed Cut LHE parsing after the introduction of data classes in v0.9.0 (https://github.com/madminer-tool/madminer/pull/493).
• Fixed Observable LHE parsing after the introduction of data classes in v0.9.0 (https://github.com/madminer-tool/madminer/pull/493).

New features:

• New CI workflow step, lint, to ensure notebooks style consistency https://github.com/diana-hep/madminer/commit/2047dc7851e265dc2d36ff6694256dd23f086ffb.

Internal changes:

• Drop support for Python 3.6 https://github.com/diana-hep/madminer/pull/484 (support ends on December 2021).
• Added support for Python 3.9 https://github.com/diana-hep/madminer/pull/484.
• Upgrade notebook examples to Python3 syntax https://github.com/diana-hep/madminer/pull/480.
• Upgrade numpy minimum version to version 1.20.0 https://github.com/diana-hep/madminer/pull/486.
• Complete rewrite of the HDF5 interface functions https://github.com/diana-hep/madminer/pull/483.
• Definition of dataclass models to ease attribute access https://github.com/diana-hep/madminer/pull/485:
  • Benchmark.
  • FiniteDiffBenchmark.
  • AnalysisParameter.
  • NuisanceParameter.
  • Cut, Efficiency and Observable.
  • Systematic (and the SystematicType enum https://github.com/diana-hep/madminer/commit/6183d555ef0b367af24ab1193c0a98bd95fb5460).

Breaking changes

There are multiple backward compatibility breaking changes to consider ⚠️ :

• The HDF5 file keys to store madminer settings and / or serialized data have changed. We recommend re-creating them.
• The methods LHEReader.add_cut() and DelphesReader.add_cut() got their pass_if_not_parsed arg. renamed to required.
• The method LHEReader.add_efficiency() got its value_if_not_parsed arg. renamed to default.
• The function combine_and_shuffle got its overwrite_existing_file unused argument removed.

Bug fixes:

• Fixed particles phi property access after scikit-hep/vector migration (not callable anymore).
• Fixed missing "modified_score" mode within Ensemble.calculate_fisher_information() accepted ones.

Internal changes:

• Improved math functions mappings within the utilities (https://github.com/diana-hep/madminer/commit/6a7ead35ece83759002e1402ebbe48da882443c6).
• Replaced most of the hardcoded particle IDs by the scikit-hep/particle package.
• Removed legacy check_required_data utilities function (https://github.com/diana-hep/madminer/commit/13bf559a3d7ad0614bc96df66bc2804ed6d53fb7).
• Removed legacy UploadCommand setup.py class (now using GHA workflows) (https://github.com/diana-hep/madminer/commit/243e1e80d0e72e5eddf626609be52f2ac6c46c59).

Documentation:

• Defined new CITATION.cff file to ease package citation.

Bug fixes:

• Fixed MadminerParticle initialization by using @ classmethod helpers. Thanks @lyazj.
• Replaced MadminerParticle inherited class (VectorObject4D -> MomentumObject4D). Thanks @lyazj.
• Bumped vector package to version 0.8.4, first version to properly allow subclassing.

Internal changes:

• Replaced Python2 compatible super-class calls by Python3 style.

Documentation:

• Fixed README relative links (unavailable on Madminer's PyPi information page).

Bug fixes:

• Fixed a Python2 -> Python3 migration issue when dealing with dictionary values (thanks @sbrass).

Internal changes:

• Replaced legacy scikit-hep>=0.5.0, <0.6.0 requirement (underused), by the vector package.
• Replaced legacy rootproject/root-ubuntu Docker base image by rootproject/root equivalent.

Documentation:

• Fixed readthedocs automatic documentation building (broken since July 1st 2020).
• Define explicit .readthedocs.yml file with the desired configuration.
• Define GitHub docs.yml workflow, to validate documentation building upon master branch pushes / PRs.