Hide keyboard shortcuts

Hot-keys on this page

r m x p   toggle line displays

j k   next/prev highlighted chunk

0   (zero) top of page

1   (one) first highlighted chunk

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

# This file is part of verify. 

# 

# Developed for the LSST Data Management System. 

# This product includes software developed by the LSST Project 

# (https://www.lsst.org). 

# See the COPYRIGHT file at the top-level directory of this distribution 

# for details of code ownership. 

# 

# This program is free software: you can redistribute it and/or modify 

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

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

# (at your option) any later version. 

# 

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

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

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 

# GNU General Public License for more details. 

# 

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

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

 

 

__all__ = ["make_test_butler", "make_dataset_type"] 

 

 

from lsst.daf.butler import Butler, DatasetType 

 

 

# TODO: factor this out into a pipeline testing library 

def make_test_butler(root, data_ids): 

"""Create an empty repository with default configuration. 

 

Parameters 

---------- 

root : `str` 

The location of the root directory for the repository. 

data_ids : `dict` [`str`, `iterable` [`dict`]] 

A dictionary keyed by the dimensions used in the test. Each value 

is a dictionary of fields and values for that dimension. See 

:file:`daf/butler/config/dimensions.yaml` for required fields, 

listed as "keys" and "requires" under each dimension's entry. 

 

Returns 

------- 

butler : `lsst.daf.butler.Butler` 

A Butler referring to the new repository. 

""" 

# TODO: takes 5 seconds to run; split up into class-level Butler 

# with test-level runs after DM-21246 

Butler.makeRepo(root) 

butler = Butler(root, run="test") 

for dimension, values in data_ids.items(): 

butler.registry.insertDimensionData(dimension, *values) 

return butler 

 

 

def make_dataset_type(butler, name, dimensions, storageClass): 

"""Create a dataset type in a particular repository. 

 

Parameters 

---------- 

butler : `lsst.daf.butler.Butler` 

The repository to update. 

name : `str` 

The name of the dataset type. 

dimensions : `set` [`str`] 

The dimensions of the new dataset type. 

storageClass : `str` 

The storage class the dataset will use. 

 

Returns 

------- 

dataset_type : `lsst.daf.butler.DatasetType` 

The new type. 

 

Raises 

------ 

ValueError 

Raised if the dimensions or storage class are invalid. 

ConflictingDefinitionError 

Raised if another dataset type with the same name already exists. 

""" 

dataset_type = DatasetType(name, dimensions, storageClass, 

universe=butler.registry.dimensions) 

butler.registry.registerDatasetType(dataset_type) 

return dataset_type