Skip to main content

SkyLLH

CI Docs License: GPL-3.0 PyPI - Version conda-forge

Description

The SkyLLH framework is an open-source Python-based package licensed under the GPLv3 license. It provides a modular framework for implementing custom likelihood functions and executing log-likelihood ratio hypothesis tests. The idea is to provide a class structure tied to the mathematical objects of the likelihood functions, rather than to entire abstract likelihood models.

Installation

Python >= 3.11 is required.

Using pip

The latest skyllh release can be installed from PyPI repository:

pip install skyllh

Optional dependency groups can be installed with extras:

pip install "skyllh[extras]"   # iminuit, pyarrow
pip install "skyllh[dev]"      # pre-commit, pytest
pip install "skyllh[docs]"     # sphinx and doc-build tools

The current development version can be installed using pip:

pip install git+https://github.com/icecube/skyllh.git

Optionally, a specific reference can be installed by:

pip install git+https://github.com/icecube/skyllh.git@[ref]

where [ref] is a commit hash, branch name, or tag.

Using conda

conda install -c conda-forge skyllh

Publications

Several publications about the SkyLLH software are available:

  • IceCube Collaboration, C. Bellenghi, M. Karl, M. Wolf, et al. PoS ICRC2023 (2023) 1061 DOI
  • IceCube Collaboration, T. Kontrimas, M. Wolf, et al. PoS ICRC2021 (2022) 1073 DOI
  • IceCube Collaboration, M. Wolf, et al. PoS ICRC2019 (2020) 1035 DOI

Developer Guidelines

These guidelines should help new developers of SkyLLH to join the development process easily.

Pre-commit hooks

This repository uses pre-commit to run ruff for linting and formatting on every commit.

Install pre-commit and set up the hooks:

pip install pre-commit
pre-commit install

The hooks will now run automatically on git commit. To run them manually against all files:

pre-commit run --all-files

Branching

  • When implementing a new feature / change, first an issue must be created describing the new feature / change. Then a branch must be created referring to this issue. We recommend the branch name fix<ISSUE_NUMBER>, where <ISSUE_NUMBER> is the number of the created issue for this feature / change.

  • In cases when SkyLLH needs to be updated because of a change in the i3skyllh package (see below), we recommend the branch name i3skyllh_<ISSUE_NUMBER>, where <ISSUE_NUMBER> is the number of the issue created in the i3skyllh repository. That way the analysis unit tests workflow will be able to find the correct skyllh branch corresponding to the i3skyllh change automatically.

Releases and Versioning

  • Release version numbers follow the format v<YY>.<MAJOR>.<MINOR>, where <YY> is the current year, <MAJOR> and <MINOR> are the major and minor version numbers of type integer. Example: v23.2.0.

  • Release candidates follow the same format as releases, but have the additional suffix .rc<NUMBER>, where <NUMBER> is an integer starting with 1. Example: v23.2.0.rc1

  • Before creating the release on github, the version number needs to be updated in the Sphinx documentation: doc/sphinx/conf.py.

i3skyllh

The i3skyllh package provides complementary pre-defined common analyses and datasets for the IceCube Neutrino Observatory detector in a private repository.

Contributors

Metadata

Release files for skyllh 26.2.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for skyllh 26.2.0
File Size Uploaded Provenance Actions
skyllh-26.2.0.tar.gz 1.1 MB Without provenance Details for skyllh-26.2.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for skyllh 26.2.0
File Interpreter ABI Platform Actions
skyllh-26.2.0-py3-none-any.whl Python 3 none any Details for skyllh-26.2.0-py3-none-any.whl

Total release size: 1.5 MB

Release files / skyllh-26.2.0.tar.gz

Download URL skyllh-26.2.0.tar.gz
Size 1.1 MB
Tags Source
SHA-256 checksum
How to use checksums
7030cfce332fc4baa8fe42de2e4ebb4747e38975bc8d00e38eedf1590d64d6ed
BLAKE2b-256 checksum
How to use checksums
2c444d33898a90deb22c1ac022f5dbb5961cb304b8b51d8f2d68b73871213aa7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.15.2

Release files / skyllh-26.2.0-py3-none-any.whl

Download URL skyllh-26.2.0-py3-none-any.whl
Size 392.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
1f281ab9b8dc2b829d830b33c3c916317ff98e8b2a969674e60b39af5fa8a003
BLAKE2b-256 checksum
How to use checksums
afbe012526afde70926dcb28fe039003d6afa29a479dc582bcaeabead469d8b7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.15.2

Security for skyllh 26.2.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page