Coverage for python/lsst/daf/butler/script/certifyCalibrations.py: 30%
16 statements
« prev ^ index » next coverage.py v7.5.0, created at 2024-04-27 02:59 -0700
« prev ^ index » next coverage.py v7.5.0, created at 2024-04-27 02:59 -0700
1# This file is part of daf_butler.
2#
3# Developed for the LSST Data Management System.
4# This product includes software developed by the LSST Project
5# (http://www.lsst.org).
6# See the COPYRIGHT file at the top-level directory of this distribution
7# for details of code ownership.
8#
9# This software is dual licensed under the GNU General Public License and also
10# under a 3-clause BSD license. Recipients may choose which of these licenses
11# to use; please see the files gpl-3.0.txt and/or bsd_license.txt,
12# respectively. If you choose the GPL option then the following text applies
13# (but note that there is still no warranty even if you opt for BSD instead):
14#
15# This program is free software: you can redistribute it and/or modify
16# it under the terms of the GNU General Public License as published by
17# the Free Software Foundation, either version 3 of the License, or
18# (at your option) any later version.
19#
20# This program is distributed in the hope that it will be useful,
21# but WITHOUT ANY WARRANTY; without even the implied warranty of
22# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23# GNU General Public License for more details.
24#
25# You should have received a copy of the GNU General Public License
26# along with this program. If not, see <http://www.gnu.org/licenses/>.
27from __future__ import annotations
29import astropy.time
31from .._butler import Butler
32from .._timespan import Timespan
33from ..registry import CollectionType
36def certifyCalibrations(
37 repo: str,
38 input_collection: str,
39 output_collection: str,
40 dataset_type_name: str,
41 begin_date: str | None,
42 end_date: str | None,
43 search_all_inputs: bool,
44) -> None:
45 """Certify a set of calibrations with a validity range.
47 Parameters
48 ----------
49 repo : `str`
50 URI to the location of the repo or URI to a config file describing the
51 repo and its location.
52 input_collection : `str`
53 Data collection to pull calibrations from. Usually an existing
54 `~CollectionType.RUN` or `~CollectionType.CHAINED` collection, and may
55 _not_ be a `~CollectionType.CALIBRATION` collection or a nonexistent
56 collection.
57 output_collection : `str`
58 Data collection to store final calibrations. If it already exists, it
59 must be a `~CollectionType.CALIBRATION` collection. If not, a new
60 `~CollectionType.CALIBRATION` collection with this name will be
61 registered.
62 dataset_type_name : `str`
63 Name of the dataset type to certify.
64 begin_date : `str`, optional
65 ISO-8601 date (TAI) this calibration should start being used.
66 end_date : `str`, optional
67 ISO-8601 date (TAI) this calibration should stop being used.
68 search_all_inputs : `bool`, optional
69 Search all children of the inputCollection if it is a CHAINED
70 collection, instead of just the most recent one.
71 """
72 butler = Butler.from_config(repo, writeable=True, without_datastore=True)
73 registry = butler.registry
74 timespan = Timespan(
75 begin=astropy.time.Time(begin_date, scale="tai") if begin_date is not None else None,
76 end=astropy.time.Time(end_date, scale="tai") if end_date is not None else None,
77 )
78 if not search_all_inputs and registry.getCollectionType(input_collection) is CollectionType.CHAINED:
79 input_collection = next(iter(registry.getCollectionChain(input_collection)))
81 refs = set(registry.queryDatasets(dataset_type_name, collections=[input_collection]))
82 if not refs:
83 raise RuntimeError(f"No inputs found for dataset {dataset_type_name} in {input_collection}.")
84 registry.registerCollection(output_collection, type=CollectionType.CALIBRATION)
85 registry.certify(output_collection, refs, timespan)