Skip to content

v0.4.0
Compare
Choose a tag to compare
@alexander-held alexander-held released this 13 Oct 16:49
· 95 commits to master since this release
v0.4.0
ae7444c
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.

This release adds support for histogram inputs to workspace building and introduces a few breaking API changes. It also provides a new utility to match fit results to pyhf models (cabinetry.model_utils.match_fit_results). All keyword arguments are now keyword-only arguments: their associated keyword always needs to be used.

Histogram inputs for workspace building can be used with the new cabinetry.templates.collect API. The configuration schema has been expanded to support histogram inputs, and works in a very similar fashion to the specification of paths for ntuple inputs. See the documentation for more information.

The cabinetry.template_builder and cabinetry.template_postprocessor API has changed: the high-level functionality is now available via cabinetry.templates, and the lower-level functionality is provided in the submodules templates.builder and templates.postprocessor.

Breaking changes:

  • contrib.histogram_creation has been renamed to contrib.histogram_creator, and the from_uproot function contained within to with_uproot (see #289). This function now returns a histogram instead of a tuple (see #281).
  • Refactored template_builder and template_postprocessor, moved high-level functionality into new templates module and lower-level features into submodules templates.creator and templates.postprocessor (see #289).
    • template_builder.create_histograms -> templates.create
    • template_postprocessor.run -> templates.postprocess
  • The SamplePaths configuration option is now called SamplePath (see #289).
  • All keyword arguments in the API are now keyword-only arguments (see #294).

Full list of changes:

  • chore: updating version to 0.4.0 (#298)
  • build: exclude root files from source distribution (#297)
  • feat: add codespell to pre-commit and fix typos (#296)
  • feat: add pydocstyle to pre-commit and add missing docstrings (#295)
  • feat: turn keyword arguments into keyword-only arguments (#294)
  • feat: region- and sample-specific paths are optional for histogram inputs (#293)
  • ci: run typeguard and backend tests for all Python versions (#292)
  • feat: histogram inputs (#289)
  • build: add utils to source distribution (#290)
  • feat: utility to match fit results to arbitrary model (#288)
  • feat: sample-specific Filter overrides (#286)
  • fix: ratio panel in data/MC plots for bins with zero predicted yields (#287)
  • feat: make Filter property of regions optional (#285)
  • chore: update links after Scikit-HEP migration (#282)
  • feat: return histogram instead of tuple from histogram creation backend (#281)
  • ci: update package list (#280)
Assets 2