skyllh.datasets.i3 package#

Submodules#

skyllh.datasets.i3.PublicData_10y_ps module#

skyllh.datasets.i3.PublicData_10y_ps.create_dataset_collection(cfg: Config, base_path: str | None = None, sub_path_fmt: str | None = None) → DatasetCollection#

Defines the dataset collection for IceCube’s 10-year point-source public data, which is available at https://doi.org/10.7910/DVN/VKL316. Version 2.0 renames two event files (IC79_exp.csv and IC86_VII_exp.csv) so that they have a naming scheme consistent with the rest of the data files.

Parameters:

  • cfg – The instance of Config holding the local configuration.

  • base_path – The base path of the data files. The actual path of a data file is assumed to be of the structure <base_path>/<sub_path>/<file_name>. If None, cfg['repository']['base_path'] is used, which defaults to ~/.cache/skyllh.

  • sub_path_fmt – The sub path format of the data files of the public data sample. If None, use the default sub path format ‘icecube_10year_ps’.

Returns:

dsc – The dataset collection containing all the seasons as individual I3Dataset objects.

skyllh.datasets.i3.PublicData_10y_ps_wMC module#

skyllh.datasets.i3.PublicData_10y_ps_wMC.create_dataset_collection(cfg: Config, base_path: str | None = None, sub_path_fmt: str | None = None) → DatasetCollection#

Defines the dataset collection for IceCube’s 10-year point-source public data, which is available at http://icecube.wisc.edu/data-releases/20210126_PS-IC40-IC86_VII.zip, and adds monte-carlo files.

Parameters:

  • cfg – The instance of Config holding the local configuration.

  • base_path – The base path of the data files. The actual path of a data file is assumed to be of the structure <base_path>/<sub_path>/<file_name>. If None, cfg['repository']['base_path'] is used, which defaults to ~/.cache/skyllh.

  • sub_path_fmt – The sub path format of the data files of the public data sample. If None, use the default sub path format ‘icecube_10year_ps’.

Returns:

dsc – The dataset collection containing all the seasons as individual I3Dataset objects.

skyllh.datasets.i3.PublicData_14y_ps module#

skyllh.datasets.i3.PublicData_14y_ps.create_dataset_collection(cfg: Config, base_path: str | None = None, sub_path_fmt: str | None = None) → DatasetCollection#

Defines the dataset collection for IceCube’s 14-year point-source public data, which is available at https://doi.org/10.7910/DVN/MMIIZA.

Note that compared to the previous data release: - a finer declination binning is provided for the 14yr dataset, thus

providing a more accurate description of the detector response variations across the sky;

  • the detector configuration and selection were homogenized for all data taking seasons using the full, 86-string detector configuration (IC86).

Parameters:

  • cfg – The instance of Config holding the local configuration.

  • base_path – The base path of the data files. The actual path of a data file is assumed to be of the structure <base_path>/<sub_path>/<file_name>. If None, cfg['repository']['base_path'] is used, which defaults to ~/.cache/skyllh.

  • sub_path_fmt – The sub path format of the data files of the public data sample. If None, use the default sub path format ‘icecube_14year_ps’.

Returns:

dsc – The dataset collection containing all the seasons as individual I3Dataset objects.

skyllh.datasets.i3.PublicData_14y_ps_v2 module#

skyllh.datasets.i3.PublicData_14y_ps_v2.create_dataset_collection(cfg, base_path=None, sub_path_fmt=None)#

Defines the dataset collection for IceCube’s 14-year point-source public data, which is available at https://doi.org/10.7910/DVN/MMIIZA.

Version 2: Fixes two binning issues identified in version 1.0: 1. The IC86 Monte Carlo simulations extend only up to a true energy of log10(E/GeV) = 8.7, which falls inside the last true-energy bin, log10(E/GeV) = [8.6, 8.8). The resulting lack of simulated events artificially reduced the effective area in that bin at all declinations. Version 2.0 sets the range of this bin to log10(E/GeV) = [8.6, 8.7), matching the simulation boundary. 2. The sin(declination) binning of the smearing matrices was set to IceCube’s internal IC40 binning for all detector configurations (IC40, IC59, IC79, and IC86), rather than to the per-season internal binning described in the accompanying paper. Version 2.0 uses the corresponding binning for each season.

Parameters:

  • cfg (instance of Config) – The instance of Config holding the local configuration.

  • base_path (str | None) – The base path of the data files. The actual path of a data file is assumed to be of the structure <base_path>/<sub_path>/<file_name>. If None, cfg['repository']['base_path'] is used, which defaults to ~/.cache/skyllh.

  • sub_path_fmt (str | None) – The sub path format of the data files of the public data sample. If None, use the default sub path format ‘icecube_14year_ps_v2’.

Returns:

dsc (DatasetCollection) – The dataset collection containing all the seasons as individual I3Dataset objects.

skyllh.datasets.i3.TestData module#

skyllh.datasets.i3.TestData.create_dataset_collection(cfg: Config, base_path: str | None = None, sub_path_fmt: str | None = None) → DatasetCollection#

Defines a dataset collection with a test dataset.

Parameters:

  • cfg – The instance of Config holding the local configuration.

  • base_path – The base path of the data files. The actual path of a data file is assumed to be of the structure <base_path>/<sub_path>/<file_name>. If None, cfg['repository']['base_path'] is used, which defaults to ~/.cache/skyllh.

  • sub_path_fmt – The sub path format of the data files of the public data sample. If None, use the default sub path format ‘testdata’.

Returns:

dsc – The dataset collection containing all the seasons as individual I3Dataset objects.