Coverage for python/lsst/daf/butler/script/createRepo.py: 60%
5 statements
« prev ^ index » next coverage.py v6.4.4, created at 2022-08-30 02:26 -0700
« prev ^ index » next coverage.py v6.4.4, created at 2022-08-30 02:26 -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 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/>.
22from .._butler import Butler
23from ..core import Config
26def createRepo(repo, seed_config=None, dimension_config=None, standalone=False, override=False, outfile=None):
27 """Create an empty Gen3 Butler repository.
29 Parameters
30 ----------
31 repo : `str`
32 URI to the location to create the repo.
33 seed_config : `str` or `None`
34 Path to an existing YAML config file to apply (on top of defaults).
35 dimension_config : `str` or `None`
36 Path to an existing YAML config file with dimensions configuration.
37 standalone : `bool`
38 Include all the defaults in the config file in the repo if True.
39 Insulates the the repo from changes to package defaults. By default
40 False.
41 override : `bool`
42 Allow values in the config file to override any repo settings, by
43 default False.
44 outfile : `str` or None
45 Name of output file to receive repository configuration. Default is to
46 write butler.yaml into the specified repo, by default False.
47 """
48 config = Config(seed_config) if seed_config is not None else None
49 Butler.makeRepo(
50 repo,
51 config=config,
52 dimensionConfig=dimension_config,
53 standalone=standalone,
54 forceConfigRoot=not override,
55 outfile=outfile,
56 )