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

8 statements  

« prev     ^ index     » next       coverage.py v7.2.7, created at 2023-06-14 02:10 -0700

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 program is free software: you can redistribute it and/or modify 

10# it under the terms of the GNU General Public License as published by 

11# the Free Software Foundation, either version 3 of the License, or 

12# (at your option) any later version. 

13# 

14# This program is distributed in the hope that it will be useful, 

15# but WITHOUT ANY WARRANTY; without even the implied warranty of 

16# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 

17# GNU General Public License for more details. 

18# 

19# You should have received a copy of the GNU General Public License 

20# along with this program. If not, see <http://www.gnu.org/licenses/>. 

21 

22__all__ = ["register_instrument"] 

23 

24from lsst.daf.butler import Butler 

25from lsst.pipe.base import Instrument 

26 

27 

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

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

30 

31 Parameters 

32 ---------- 

33 repo : `str` 

34 URI to the butler repository to register this instrument. 

35 instrument : `list` [`str`] 

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

37 update : `bool`, optional 

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

39 detector records if they differ from the new ones. 

40 

41 Raises 

42 ------ 

43 RuntimeError 

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

45 from the registry. 

46 TypeError 

47 Raised iff the instrument is not a subclass of 

48 `lsst.pipe.base.Instrument`. 

49 """ 

50 butler = Butler(repo, writeable=True) 

51 for string in instrument: 

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

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