lsst.obs.base  19.0.0-56-g64d9981
register_instrument.py
Go to the documentation of this file.
1 # This file is part of obs_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 import click
23 import logging
24 
25 from lsst.daf.butler.cli.opt import repo_argument
26 from lsst.daf.butler import Butler
27 from ..opt import instrument_option
28 from ...utils import getInstrument
29 
30 log = logging.getLogger(__name__)
31 
32 
33 @click.command()
34 @repo_argument(required=True)
35 @instrument_option(required=True, helpMsg="The fully-qualified name of an Instrument subclass.")
36 @click.pass_context
37 def register_instrument(context, repo, instrument):
38  """Add an instrument to the data repository.
39  """
40  butler = Butler(repo, writeable=True)
41  try:
42  instr = getInstrument(instrument, butler.registry)
43  except RuntimeError as err:
44  log.critical("Failed getting instrument %s with exception %s", instrument, err)
45  raise click.ClickException("Could not import instrument.")
46  except TypeError:
47  raise click.ClickException(f"{instrument} is not a subclass of obs.base.Instrument")
48  instr.register(butler.registry)
lsst.obs.base.utils.getInstrument
def getInstrument(instrumentName, registry=None)
Definition: utils.py:100
cmd.register_instrument.register_instrument
def register_instrument(context, repo, instrument)
Definition: register_instrument.py:37