Coverage for python/lsst/pipe/base/script/register_instrument.py: 40%

8 statements  

« prev     ^ index     » next       coverage.py v7.4.2, created at 2024-02-22 11:03 +0000

1# This file is part of pipe_base. 

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/>. 

27 

28__all__ = ["register_instrument"] 

29 

30from lsst.daf.butler import Butler 

31from lsst.pipe.base import Instrument 

32 

33 

34def register_instrument(repo: str, instrument: list[str], update: bool = False) -> None: 

35 """Add an instrument to the data repository. 

36 

37 Parameters 

38 ---------- 

39 repo : `str` 

40 URI to the butler repository to register this instrument. 

41 instrument : `list` [`str`] 

42 The fully-qualified name of an `~lsst.pipe.base.Instrument` subclass. 

43 update : `bool`, optional 

44 If `True` (`False` is default), update the existing instrument and 

45 detector records if they differ from the new ones. 

46 

47 Raises 

48 ------ 

49 RuntimeError 

50 Raised if the instrument can not be imported, instantiated, or obtained 

51 from the registry. 

52 TypeError 

53 Raised iff the instrument is not a subclass of 

54 `lsst.pipe.base.Instrument`. 

55 """ 

56 butler = Butler.from_config(repo, writeable=True) 

57 for string in instrument: 

58 instrument_instance = Instrument.from_string(string, butler.registry) 

59 instrument_instance.register(butler.registry, update=update)