Skip to main content

Gamma Variance Model for combining correlated measurements

Project description

GVM Combinations

gvm-combinations provides tools for combining correlated measurements with errors-on-errors using the Gamma Variance Model.

It supports:

  • statistical covariance matrices and correlated systematic uncertainties;
  • dependent and independent errors-on-errors;
  • likelihood fits with iminuit;
  • Bartlett-corrected confidence intervals and goodness-of-fit statistics;
  • YAML configuration files and combination summary plots.

Installation

The package requires Python 3.11 or newer.

python -m pip install gvm-combinations

Example

from gvm_combinations import GVMCombination, build_input_data

data = build_input_data("combination.yaml")
combination = GVMCombination(data)
fit = combination.fit()
low, high, _ = combination.confidence_interval()

print(f"mu = {fit.mu:.4f}")
print(f"68.3% CI = ({low:.4f}, {high:.4f})")

The public Python namespace is gvm_combinations. Combination inputs are defined in YAML files containing the measurements, statistical covariance and systematic uncertainty model.

Documentation and examples

The GitHub repository contains the full mathematical overview, configuration reference, example runs and tutorials:

Methodological details are available in arXiv:2407.05322.

Citation

Citation metadata are provided in CITATION.cff.

License

GVM Combinations is distributed under the MIT License.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gvm_combinations-0.1.0.tar.gz (17.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

gvm_combinations-0.1.0-py3-none-any.whl (13.6 kB view details)

Uploaded Python 3

File details

Details for the file gvm_combinations-0.1.0.tar.gz.

File metadata

  • Download URL: gvm_combinations-0.1.0.tar.gz
  • Upload date:
  • Size: 17.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for gvm_combinations-0.1.0.tar.gz
Algorithm Hash digest
SHA256 a2b5cf251ec08cd51a72eab9c73073e740a29077bf603504d11976b4bbbaca5a
MD5 70516d62ed54625262b4d1ad8fc3d281
BLAKE2b-256 56a7a3ca0737cf1b0f5c50ae593ef5c82fce7df59e94d2d1e48d6ccead1b707e

See more details on using hashes here.

Provenance

The following attestation bundles were made for gvm_combinations-0.1.0.tar.gz:

Publisher: publish.yml on EnzoCanonero/gvm-combinations

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file gvm_combinations-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for gvm_combinations-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e0c2c43a905f959314a97b1a19be015e83ca787b7183cad24edb4b013d5d6c22
MD5 2da15d73507804b80de5f6dce20f3ed1
BLAKE2b-256 d27f8f8f1f5f8a9cdfe0ad1c57bdef85e7239f73b95e6a71a931d11ebf6ee329

See more details on using hashes here.

Provenance

The following attestation bundles were made for gvm_combinations-0.1.0-py3-none-any.whl:

Publisher: publish.yml on EnzoCanonero/gvm-combinations

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page